Referência da API para programadores
Ligue a sua própria aplicação ao seu espaço de trabalho: a API REST, as suas chaves e permissões, erros, limites de pedidos e webhooks.
Onde encontrar
⚙️ Definições › Referência da API · Página inicial › Recursos › Referência da API
Abrir esta tela
Passos
- Abra “Referência da API” na barra lateral ou “Referência da API” no menu “Recursos” da página inicial.
- Comece por “Comece aqui”: “URL base e convenções”, “Autenticação” e “Permissões”.
- Consulte “Endpoints” por grupo; cada um mostra os seus parâmetros, corpo do pedido, resposta e erros com exemplos.
- Leia “Erros e códigos de estado”, “Limites de pedidos” e “Webhooks (de saída)” antes de entrar em produção. “OpenAPI JSON” descarrega toda a especificação.
Solução de problemas
Como obtenho uma chave de API?
As chaves são emitidas para o seu espaço de trabalho mediante pedido; ainda não podem ser criadas na aplicação. As chaves do seu espaço de trabalho estão listadas na página de programadores da área de IA, onde quem gere o espaço de trabalho também pode adicionar e testar endpoints de webhook.
Dicas
- Chame a API apenas a partir do seu servidor. Nunca coloque uma chave numa página web ou numa aplicação móvel.
Bom saber
- A referência da API pode ser lida sem iniciar sessão.
Guias práticos relacionados
- Como encontro um endpoint e copio um exemplo? Pesquise na referência da API, salte para um endpoint e copie o seu exemplo ou ligação.
- Como leio as perguntas comuns (Documentação)? Leia respostas curtas sobre o que o produto faz hoje: primeiros passos, idiomas e vozes, chamadas de teste, números de telefone, planos e conta.
- Funcionalidades O catálogo completo das funcionalidades de call center, cada uma marcada honestamente como entregue ou prevista.