API Reference

Bem-vindo à documentação da API da Interflow para integrações com API Key.

Veja o inventário de endpoints disponíveis.

Base URL

https://v1.api.interflow.chat

Autenticação

Inclua sua API Key em todas as requisições:

curl -X POST "https://v1.api.interflow.chat/api/{organizationId}/chat/create" \
  -H "x-api-key: ak_sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "contactType": "whatsapp",
    "contactValue": "5511999999999",
    "channelId": "uuid-do-canal"
  }'

Também é aceito Authorization: Bearer ak_....

Veja Autenticação.

Obtendo sua API Key e IDs

1. Configurações → API Keys — gere a chave e copie o Organization ID
2. Menu lateral Canais — copie o ID do canal no card; em canal WhatsApp Oficial → Templates para o ID do template
3. Menu Equipes, Fluxos e Clientes — copie teamId, flowId / responseFlowId e customerId (nos cards ou no menu de ações)
4. Guarde a API Key em local seguro (ela é exibida só na criação)

Detalhes em Autenticação → Onde encontrar os IDs.

IMPORTANTE

Nunca exponha a API Key em código frontend ou repositórios públicos.

Formato de resposta

Respostas em JSON. O formato exato varia por endpoint; erros comuns incluem error (string) e opcionalmente code / requestId.

Exemplo de erro de rota não pública:

{
  "error": "This route is not available for API Key authentication",
  "code": "API_KEY_ROUTE_DENIED",
  "requestId": "..."
}

Rate limiting

Plano	Limite
Starter	60 req/min
Professional	300 req/min
Enterprise	1000 req/min

Headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Endpoints documentados

Principal: criar atendimento e enviar em uma chamada

Na maioria das integrações, comece por Criar chat. Ele cria (ou reutiliza) o atendimento e já aceita initialMessage e/ou whatsappTemplate na mesma requisição — sem precisar chamar depois as rotas de mensagem ou template.

Use enviar mensagem e enviar template quando o chat já existir e você quiser continuar a conversa.

Chats

Método	Endpoint	Doc
POST	/api/{organizationId}/chat/create	Criar chat (recomendado)
POST	/api/{organizationId}/chat/{chatId}/send-template	Enviar template

Mensagens

Método	Endpoint	Doc
POST	/api/{organizationId}/chat/{chatId}/message	Enviar mensagem
POST	/api/{organizationId}/chat/{chatId}/message-sequence	Sequência
—	Atalhos e sequências	Atalhos

Clientes

Método	Endpoint	Doc
POST	/api/{organizationId}/customers	Criar
PUT	/api/{organizationId}/customers/{customerId}	Atualizar
POST / DELETE	.../tags	Tags do cliente
POST / PUT / DELETE	.../notes	Notas
PUT	.../stage	Estágio
POST	.../field-values	Campos personalizados

Tags

Método	Endpoint	Doc
GET / POST / PUT / DELETE	/api/{organizationId}/tags	Tags

Inventário completo: Inventário da API.

Seções

💬

Criar Chat

Principal: atendimento + mensagem/template em uma chamada

✉️

Mensagens

Enviar texto, mídia e sequências

👤

Clientes

CRM via API Key