Referência da API

O que você vai aprender

• Onde encontrar a documentação completa da API do AutoTalk
• Como autenticar requisições com sua chave de API
• Principais endpoints da API e o que eles fazem

O AutoTalk expõe uma API REST pública que permite a aplicações externas criar e gerenciar clientes, enviar mensagens, consultar conversas, trabalhar com dados dinâmicos (Dynadata) e muito mais. A API segue a especificação OpenAPI 3.0 e utiliza autenticação por chave de API.

Documentação interativa da API

A documentação completa e interativa da API está disponível em:

https://api.autotalk.io

A partir dela, você pode navegar por todos os endpoints, ver schemas de requisição e resposta, e experimentar chamadas diretamente no navegador.

Autenticação

Todas as requisições de API requerem uma chave de API passada no cabeçalho x-api-key:

x-api-key: YOUR_API_KEY

Para gerar uma chave de API, vá para Integrações > Tokens de API no painel do AutoTalk e clique no botão +. Veja Tokens de API para instruções passo a passo.

dica

Mantenha sua chave de API em segredo. Nunca a inclua em controle de versão ou a compartilhe em canais públicos. Se uma chave for comprometida, revogue-a imediatamente e crie uma nova.

URL Base

Todas as requisições de API usam a seguinte URL base:

https://api.autotalk.io/v1

Principais endpoints

Abaixo está uma visão geral das principais áreas da API. Para detalhes completos de requisição/resposta, visite a documentação interativa.

Empresa

Método	Caminho	Descrição
GET	/v1/self	Recuperar o perfil da empresa autenticada

Clientes

Método	Caminho	Descrição
POST	/v1/contacts/{contactId}/send_message	Enviar uma mensagem para um contato específico

Conversas

Método	Caminho	Descrição
GET	/v1/conversations	Listar conversas
POST	/v1/conversations	Criar uma nova conversa
POST	/v1/conversations/{id}/messages	Processar mensagens em uma conversa
GET	/v1/conversations/{id}/messages	Listar mensagens em uma conversa

Dynadata (dados dinâmicos)

Os endpoints Dynadata permitem gerenciar entidades de dados personalizadas (clientes, pedidos, tickets ou qualquer tipo que sua empresa defina).

Método	Caminho	Descrição
GET	/v1/dynadata/types	Listar todos os tipos de Dynadata disponíveis
GET	/v1/dynadata/type/{type}/list	Listar itens de um tipo específico
GET	/v1/dynadata/type/{type}/item/{_id}	Recuperar um único item por ID
POST	/v1/dynadata/type/{type}/create	Criar um novo item
PUT	/v1/dynadata/type/{type}/update	Atualizar um item existente
POST	/v1/dynadata/type/{type}/validate	Validar um item sem salvar
GET	/v1/dynadata/type/{type}/schema	Obter o schema JSON de um tipo
GET	/v1/dynadata/type/{type}/schema/zod	Obter o schema Zod de um tipo
POST	/v1/dynadata/type/{type}/executeFunction/{functionName}	Executar uma função em um tipo
POST	/v1/dynadata/type/{type}/item/{_id}/executeFunction/{functionName}	Executar uma função em um item específico

Integrações e canais

Método	Caminho	Descrição
GET	/v1/integrations/channels	Listar canais de integração conectados

Assistentes de IA

Método	Caminho	Descrição
GET	/v1/assistants	Listar assistentes de IA configurados

Exemplo de requisição

Aqui está um exemplo de envio de uma mensagem de texto para um cliente usando curl:

curl -X POST https://api.autotalk.io/v1/contacts/CONTACT_ID/send_message \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello! How can we help you today?"
  }'

Próximos passos

• Tokens de API -- Gere e gerencie suas chaves de API
• Webhooks -- Receba notificações de eventos do AutoTalk
• Workflows -- Automatize tarefas dentro do AutoTalk