Skip to main content
POST

Authorizations

Authorization
string
header
required

Authorization: Bearer mcp_… — gere em Configurações → Tokens de API.

O token de API tem modo read ou write. Um token read responde 403 a qualquer verbo que não seja GET. As capacidades do token são a interseção com as da pessoa de quem ele herda o papel: se ela perder acesso na grade de Equipe, o token perde junto, sem ninguém revogar nada.

Token de agência (gerado no console da agência): vale para as empresas da agência, e a empresa de cada chamada vai no header X-Empresa: <slug da empresa>. Sem o header, 401. Num token de empresa o header é opcional e, se vier, tem de ser a própria empresa. O modo read vale igual: um token de agência de leitura só faz GET — é o token para pôr numa função que só consulta.

Headers

Idempotency-Key
string
required

De 1 a 200 caracteres, único por mensagem nesta empresa.

Required string length: 1 - 200
Example:

"n8n-exec-48211"

Path Parameters

id
string<uuid>
required

Body

application/json
text
string

Até 4.096 caracteres, depois de aparar espaços. Obrigatório quando não há mídia; com mídia, vira a legenda.

Maximum string length: 4096
media_url
string

Só a url devolvida por POST /midia. URL de qualquer outro lugar é 422: o provedor buscaria o endereço que você mandasse. Ela continua valendo aqui depois de vencer para abrir — o que conta é o arquivo que ela aponta, não a assinatura.

media_type
enum<string>

ptt = nota de voz (chega como áudio gravado na hora).

Available options:
image,
audio,
ptt,
video,
document
forcar
boolean
default:false

Envia mesmo com a IA pausada nesta conversa. Fica registrado na auditoria da empresa.

Response

Esta Idempotency-Key já foi usada nesta empresa. É a mesma mensagem, com o status de agora; nada foi enviado de novo.

id
string<uuid>
conversation_id
string<uuid>
status
string

pending ao enfileirar; na repetição, o status de agora.

duplicate
boolean

true quando a Idempotency-Key já tinha sido usada — nada foi enviado de novo.