API
Endpoints
Inventário completo dos endpoints da API v1.
Endpoints
A API v1 está organizada pelos seguintes routers. Clique em cada secção para ver detalhes dos métodos e campos.
Resumo por domínio
| Domínio | Prefixo |
|---|---|
| Health | /api/v1/health |
| Public | /api/v1/public |
| Organizações | /api/v1/organizations |
| Admin | /api/v1/admin |
| Leads | /api/v1/leads |
| Conversas | /api/v1/conversations |
| Realtime | /api/v1/realtime |
| Agent Templates | /api/v1/agent-templates |
| Agents | /api/v1/agents |
| Flows | /api/v1/agents/{agent_id}/flows |
| Knowledge | /api/v1/knowledge-bases |
| Agent Knowledge | /api/v1/agents/{agent_id}/knowledge-* |
| Actions | /api/v1/actions |
| Integrations | /api/v1/integrations |
| Providers | /api/v1/providers |
| Call History | /api/v1/call-sessions |
| Test Center | /api/v1/tests |
| Webhooks | /api/v1/webhooks |
Actions
Prefixo: /api/v1/actions
| Método | Caminho | Descrição |
|---|---|---|
| GET | /capabilities | Badges de disponibilidade dos providers. |
| POST | /validate-phone | Valida número de telefone. |
| POST | /validate-sip | Valida URI SIP. |
| GET | /phone-books | Lista phone books. |
| POST | /phone-books | Cria phone book. |
| GET | /phone-books/{book_id} | Obtém phone book. |
| PATCH | /phone-books/{book_id} | Actualiza phone book. |
| DELETE | /phone-books/{book_id} | Remove phone book. |
| POST | /phone-books/{book_id}/entries | Adiciona entrada. |
| PUT | /phone-books/{book_id}/entries | Substitui entradas. |
| PATCH | /phone-books/{book_id}/entries/{entry_id} | Actualiza entrada. |
| DELETE | /phone-books/{book_id}/entries/{entry_id} | Remove entrada. |
| GET | /call-transfers | Lista transferências. |
| POST | /call-transfers | Cria transferência. |
| GET | /call-transfers/{transfer_id} | Obtém transferência. |
| PATCH | /call-transfers/{transfer_id} | Actualiza transferência. |
| DELETE | /call-transfers/{transfer_id} | Remove transferência. |
| POST | /call-transfers/{transfer_id}/duplicate | Duplica transferência. |
| POST | /call-transfers/{transfer_id}/simulate | Simula transferência. |
| POST | /call-transfers/{transfer_id}/execute | Executa transferência live. |
| GET | /ivr | Lista IVRs. |
| POST | /ivr | Cria IVR. |
| GET | /ivr/{ivr_id} | Obtém IVR. |
| PATCH | /ivr/{ivr_id} | Actualiza IVR. |
| DELETE | /ivr/{ivr_id} | Remove IVR. |
| POST | /ivr/{ivr_id}/duplicate | Duplica IVR. |
| POST | /ivr/{ivr_id}/execute | Executa DTMF IVR. |
| GET | /information-extractors | Lista extractores. |
| POST | /information-extractors | Cria extractor. |
| GET | /information-extractors/{extractor_id} | Obtém extractor. |
| PATCH | /information-extractors/{extractor_id} | Actualiza extractor. |
| DELETE | /information-extractors/{extractor_id} | Remove extractor. |
| POST | /information-extractors/{extractor_id}/duplicate | Duplica extractor. |
| POST | /information-extractors/{extractor_id}/simulate | Simula extractor. |
| POST | /information-extractors/{extractor_id}/rerun | Reexecuta extractor. |
| GET | /custom-evaluations | Lista avaliações. |
| GET | /custom-evaluations/export.csv | Exporta CSV. |
| POST | /custom-evaluations | Cria avaliação. |
| GET | /custom-evaluations/{evaluation_id} | Obtém avaliação. |
| PATCH | /custom-evaluations/{evaluation_id} | Actualiza avaliação. |
| DELETE | /custom-evaluations/{evaluation_id} | Remove avaliação. |
| POST | /custom-evaluations/{evaluation_id}/duplicate | Duplica avaliação. |
| POST | /custom-evaluations/{evaluation_id}/simulate | Simula avaliação. |
| GET | /post-call-sms | Lista SMS pós-chamada. |
| POST | /post-call-sms | Cria SMS pós-chamada. |
| GET | /post-call-sms/{sms_id} | Obtém SMS pós-chamada. |
| PATCH | /post-call-sms/{sms_id} | Actualiza SMS pós-chamada. |
| DELETE | /post-call-sms/{sms_id} | Remove SMS pós-chamada. |
| POST | /post-call-sms/{sms_id}/duplicate | Duplica SMS pós-chamada. |
| POST | /post-call-sms/{sms_id}/execute | Executa SMS pós-chamada. |
| POST | /post-call-sms/{sms_id}/dry-run | Dry-run SMS pós-chamada. |
| GET | /during-call-sms | Lista SMS durante chamada. |
| POST | /during-call-sms | Cria SMS durante chamada. |
| GET | /during-call-sms/{sms_id} | Obtém SMS durante chamada. |
| PATCH | /during-call-sms/{sms_id} | Actualiza SMS durante chamada. |
| DELETE | /during-call-sms/{sms_id} | Remove SMS durante chamada. |
| POST | /during-call-sms/{sms_id}/duplicate | Duplica SMS durante chamada. |
| POST | /during-call-sms/{sms_id}/execute | Executa SMS durante chamada. |
| POST | /during-call-sms/{sms_id}/simulate | Simula SMS durante chamada. |
| GET | /custom-actions | Lista acções personalizadas. |
| POST | /custom-actions | Cria acção personalizada. |
| GET | /custom-actions/{action_id} | Obtém acção personalizada. |
| PATCH | /custom-actions/{action_id} | Actualiza acção personalizada. |
| DELETE | /custom-actions/{action_id} | Remove acção personalizada. |
| POST | /custom-actions/{action_id}/duplicate | Duplica acção personalizada. |
| POST | /custom-actions/{action_id}/initialize | Inicializa acção personalizada. |
| POST | /custom-actions/{action_id}/execute | Executa acção personalizada. |
| POST | /custom-actions/{action_id}/simulate | Simula acção personalizada. |
| GET | /booking-actions | Lista acções de agendamento. |
| POST | /booking-actions | Cria acção de agendamento. |
| GET | /booking-actions/{action_id} | Obtém acção de agendamento. |
| PATCH | /booking-actions/{action_id} | Actualiza acção de agendamento. |
| DELETE | /booking-actions/{action_id} | Remove acção de agendamento. |
| POST | /booking-actions/{action_id}/duplicate | Duplica acção de agendamento. |
Agents
Prefixo: /api/v1/agents
| Método | Caminho | Descrição |
|---|---|---|
| POST | /from-template | Cria agente a partir de template. |
| POST | / | Cria agente em branco. |
| POST | /import | Importa agente de JSON. |
| GET | / | Lista agentes. |
| GET | /{agent_id} | Obtém agente. |
| PATCH | /{agent_id} | Actualiza agente. |
| POST | /{agent_id}/duplicate | Duplica agente. |
| POST | /{agent_id}/archive | Arquiva agente. |
| POST | /{agent_id}/unarchive | Desarquiva agente. |
| GET | /{agent_id}/export | Exporta agente. |
| GET | /{agent_id}/versions | Lista versões. |
| POST | /{agent_id}/versions/publish | Publica versão. |
| POST | /{agent_id}/versions/discard | Descarta draft. |
| POST | /{agent_id}/versions/{version}/restore | Restaura versão. |
| POST | /{agent_id}/chat/test | Teste de chat. |
| GET | /{agent_id}/knowledge-bases | KBs atribuídas. |
| PUT | /{agent_id}/knowledge-bases | Define KBs atribuídas. |
| GET | /{agent_id}/knowledge-runtime | Diagnóstico de KB. |
| POST | /{agent_id}/knowledge-retrieve | Preview de recuperação. |
Agent Templates
Prefixo: /api/v1/agent-templates
| Método | Caminho | Descrição |
|---|---|---|
| GET | / | Lista templates. |
| GET | /{template_id} | Obtém template. |
Flows
Prefixo: /api/v1/agents/{agent_id}/flows
| Método | Caminho | Descrição |
|---|---|---|
| GET | / | Lista fluxos. |
| POST | / | Cria subfluxo. |
| GET | /{flow_id} | Obtém fluxo. |
| PATCH | /{flow_id} | Actualiza fluxo. |
| DELETE | /{flow_id} | Remove fluxo. |
| POST | /{flow_id}/duplicate | Duplica fluxo. |
| GET | /{flow_id}/validate | Valida fluxo. |
| GET | /{flow_id}/compiled | Compila fluxo. |
| POST | /{flow_id}/publish | Publica fluxo. |
| POST | /publish-all | Publica todos os fluxos. |
| GET | /{flow_id}/runtime/start | Inicia runtime. |
| POST | /{flow_id}/runtime/advance | Avança runtime. |
| POST | /{flow_id}/runtime/simulate | Simula runtime. |
Knowledge
Prefixo: /api/v1/knowledge-bases
| Método | Caminho | Descrição |
|---|---|---|
| GET | / | Lista KBs. |
| POST | / | Cria KB. |
| GET | /{id} | Obtém KB. |
| PATCH | /{id} | Actualiza KB. |
| DELETE | /{id} | Remove KB. |
| GET | /{id}/documents | Lista documentos. |
| POST | /{id}/documents/manual | Cria documento manual. |
| PATCH | /{id}/documents/{document_id} | Actualiza documento manual. |
| DELETE | /{id}/documents/{document_id} | Remove documento. |
| POST | /{id}/documents/pdf | Carrega PDF. |
| POST | /{id}/documents/url | Importa URL. |
| POST | /{id}/documents/crawl | Crawl de URL. |
| GET | /{id}/documents/{document_id}/file | Descarrega PDF. |
| POST | /{id}/documents/{document_id}/reindex | Reindexa documento. |
| GET | /{id}/sync-sources | Fontes de sincronização. |
Integrations
Prefixo: /api/v1/integrations
| Método | Caminho | Descrição |
|---|---|---|
| GET | / | Lista integrações. |
| GET | /calcom | Estado Cal.com. |
| GET | /calcom/events | Lista eventos Cal.com. |
| POST | /calcom/connect | Liga Cal.com. |
| DELETE | /calcom | Desliga Cal.com. |
Test Center
Prefixo: /api/v1/tests
| Método | Caminho | Descrição |
|---|---|---|
| GET | /scenario-presets | Presets de cenários. |
| GET | /suites | Lista suites. |
| POST | /suites | Cria suite. |
| GET | /suites/{suite_id} | Obtém suite. |
| PATCH | /suites/{suite_id} | Actualiza suite. |
| DELETE | /suites/{suite_id} | Remove suite. |
| POST | /suites/{suite_id}/cases | Cria caso. |
| PATCH | /suites/{suite_id}/cases/{case_id} | Actualiza caso. |
| DELETE | /suites/{suite_id}/cases/{case_id} | Remove caso. |
| POST | /suites/{suite_id}/generate-cases | Gera casos com IA. |
| POST | /suites/{suite_id}/execute | Executa suite. |
| GET | /runs | Lista execuções. |
| GET | /runs/{run_id} | Obtém execução. |
Call History
Prefixo: /api/v1/call-sessions
| Método | Caminho | Descrição |
|---|---|---|
| GET | / | Lista sessões. |
| GET | /{session_id} | Obtém sessão. |
Realtime
Ver Realtime.
Webhooks
Ver Webhooks.