Documentation Index
Fetch the complete documentation index at: https://docs.mivicall.com/llms.txt
Use this file to discover all available pages before exploring further.
Reference interactivo auto-gerado a partir do OpenAPI 3.0 spec que servimos directamente do API.Vê as páginas individuais por endpoint na navegação lateral — cada uma tem try-it-out (executa requests reais contra api.mivicall.com com a tua API key). Base URL
Todos os endpoints autenticados vivem sob /v1/. Endpoints públicos (sem auth) usam paths como /booking/:slug, /triagem/:token, /feedback/:token.
Endpoints disponíveis
Tenants
| Method | Path | Descrição |
|---|
| GET | /v1/tenants/me | Config da clínica autenticada |
| PATCH | /v1/tenants/me | Editar nome, voz, slug, etc. |
Appointments
| Method | Path | Descrição |
|---|
| GET | /v1/appointments | Listar (filtros: from, to, professionalId, status) |
| POST | /v1/appointments | Criar manualmente |
| GET | /v1/appointments/:id | Detalhe |
| PATCH | /v1/appointments/:id | Editar status, notes, reschedule |
| DELETE | /v1/appointments/:id | Cancelar |
| POST | /v1/appointments/:id/triage/send | Enviar link triagem por SMS |
Calls
| Method | Path | Descrição |
|---|
| GET | /v1/calls | Listar (cursor pagination) |
| GET | /v1/calls/:id | Detalhe + transcript + tool calls |
| POST | /v1/calls/:id/callback | Iniciar outbound callback |
| GET | /v1/calls/:id/recording | Signed URL R2 (24h) |
Professionals
| Method | Path | Descrição |
|---|
| GET | /v1/professionals | Listar médicos |
| POST | /v1/professionals | Criar |
| PATCH | /v1/professionals/:id | Editar |
| DELETE | /v1/professionals/:id | Remover |
Services
| Method | Path | Descrição |
|---|
| GET | /v1/services | Listar tipos de consulta |
| POST | /v1/services | Criar |
| PATCH | /v1/services/:id | Editar |
| DELETE | /v1/services/:id | Remover |
Patients
| Method | Path | Descrição |
|---|
| GET | /v1/patients?search=X | Search por nome |
| GET | /v1/patients/:hash | Detalhe (PII descifrada com scope correcto) |
Dashboard
| Method | Path | Descrição |
|---|
| GET | /v1/dashboard/stats | KPIs (chamadas, marcações, conversão, NPS) |
Knowledge Base
| Method | Path | Descrição |
|---|
| GET | /v1/knowledge | Listar chunks |
| POST | /v1/knowledge | Criar (trigger embedding OpenAI) |
| PATCH | /v1/knowledge/:id | Editar |
| DELETE | /v1/knowledge/:id | Remover |
Campaigns (SMS bulk)
| Method | Path | Descrição |
|---|
| POST | /v1/campaigns/preview | Estimar targets antes de enviar |
| GET | /v1/campaigns | Listar |
| GET | /v1/campaigns/:id | Detalhe |
| POST | /v1/campaigns | Criar + enviar |
| POST | /v1/campaigns/:id/cancel | Cancelar enquanto envia |
Audit log
| Method | Path | Descrição |
|---|
| GET | /v1/audit | RGPD audit log (admin only) |
Billing
| Method | Path | Descrição |
|---|
| GET | /v1/billing/status | Plano + uso |
| POST | /v1/billing/checkout | Stripe Checkout |
| POST | /v1/billing/portal | Stripe Customer Portal |
| GET | /v1/billing/invoices | Histórico de faturas |
Public (sem auth)
| Method | Path | Descrição |
|---|
| GET | /booking/:slug | Info da clínica (booking público) |
| GET | /booking/:slug/slots | Slots disponíveis |
| POST | /booking/:slug | Criar marcação self-service |
Autenticação
Ver Resources → Authentication.
Authorization: Bearer miv_live_AbC123...
- Datas: ISO 8601 com timezone (
2026-05-14T10:00:00+01:00)
- Telefones: E.164 (
+351912345678)
- UUIDs: v4 lowercase
- Encoding: UTF-8 sempre
- Content-Type:
application/json
Endpoints de listagem retornam cursor-based pagination:
{
"items": [/* até `limit` items */],
"nextCursor": "eyJzdGFydHNBdC...",
"hasMore": true
}
?cursor={nextCursor}. Default limit=50, max limit=200.
