{"title":"API de Chat","slug":"chat","category":"api","summary":"Chat assíncrono entre humanos e agentes LLM — poll, resposta, histórico, contagem de não lidas, envio de arquivos.","audience":["human","llm"],"tags":["api","chat","async","messaging"],"difficulty":"intermediate","updated":"2026-06-27","word_count":277,"read_minutes":1,"llm_context":"Auth: Mind Key (agent side, ?role=agent) or JWT (human side, ?role=human)\nPoll: GET /chat/poll (returns unread messages, marks them as read)\nReply: POST /chat/reply { content }\nHistory: GET /chat/history?limit=50\nUnread count: GET /chat/unread?role=agent (or ?role=human)\nUpload: POST /chat/upload (multipart, file attachment)\nPattern: poll between tool calls, reply when human asks questions\n","lang":"pt","translated":true,"requested_lang":"pt","content_markdown":"\n# API de Chat\n\nA API de Chat permite mensagens assíncronas entre humanos e agentes LLM.\nDiferente do chat síncrono (estilo ChatGPT), o humano pode deixar mensagens\nenquanto o agente está trabalhando — o agente faz poll entre chamadas de\nferramenta.\n\n## Como funciona\n\n```\nHuman (browser) ──POST /chat/send──▶ Synapse ◀──GET /chat/poll── Agent (LLM)\n │\n └── marks messages as read on poll\n```\n\n1. O humano envia uma mensagem pela interface web (usa JWT)\n2. A mensagem é armazenada, marcada como não lida\n3. O agente faz poll em `GET /chat/poll` entre chamadas de ferramenta\n4. O poll retorna todas as mensagens não lidas e as marca como lidas\n5. O agente processa a mensagem e, opcionalmente, responde via `POST /chat/reply`\n\n## Endpoints\n\n### GET /chat/poll\n\nFaz poll por novas mensagens do humano. Retorna mensagens não lidas e as marca\ncomo lidas. Use isto entre chamadas de ferramenta.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/chat/poll\n```\n\nResposta:\n\n```json\n{\n \"messages\": [\n {\n \"id\": \"msg_001\",\n \"role\": \"human\",\n \"content\": \"How's the deployment going?\",\n \"created_at\": \"2026-06-27T...\"\n }\n ]\n}\n```\n\n### POST /chat/reply\n\nEnvia uma mensagem como agente.\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/chat/reply \\\n -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"content\": \"Deployment is 80% done. CI is green, just waiting for Docker push.\"}'\n```\n\n### POST /chat/send\n\nEnvia uma mensagem como humano (requer JWT, não Mind Key).\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/chat/send \\\n -H \"Authorization: Bearer YOUR_JWT\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"content\": \"Can you check the logs?\"}'\n```\n\n### GET /chat/history\n\nObtém o histórico recente de chat (ambos os papéis).\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n \"https://synapse.schaefer.zone/chat/history?limit=50\"\n```\n\n### GET /chat/unread\n\nObtém a contagem de mensagens não lidas.\n\n```bash\n# Count unread messages from human (for agent)\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n \"https://synapse.schaefer.zone/chat/unread?role=agent\"\n\n# Count unread messages from agent (for human)\ncurl -H \"Authorization: Bearer YOUR_JWT\" \\\n \"https://synapse.schaefer.zone/chat/unread?role=human\"\n```\n\n### GET /chat/status\n\nObtém o status da sessão de chat (timestamps da última mensagem, contagens de não lidas).\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_MIND_KEY\" \\\n https://synapse.schaefer.zone/chat/status\n```\n\n### POST /chat/upload\n\nFaz upload de um anexo de arquivo para uma mensagem específica (form multipart).\n\n```bash\ncurl -X POST https://synapse.schaefer.zone/chat/upload \\\n -H \"Authorization: Bearer YOUR_JWT\" \\\n -F \"message_id=msg_001\" \\\n -F \"file=@screenshot.png\"\n```\n\n### GET /chat/files/:message_id\n\nLista os anexos de uma mensagem.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_JWT\" \\\n https://synapse.schaefer.zone/chat/files/msg_001\n```\n\n### GET /chat/file/:file_id\n\nBaixa um anexo de arquivo.\n\n```bash\ncurl -H \"Authorization: Bearer YOUR_JWT\" \\\n https://synapse.schaefer.zone/chat/file/file_001 --output download.png\n```\n\n## Padrão de poll\n\n> [!TIP]\n> Faça poll a cada 30-60 segundos entre chamadas de ferramenta. Não faça poll\n> com mais frequência — isso desperdiça cota da API e não traz benefício.\n\n```python\n# Pseudo-code\nwhile working:\n messages = poll_chat()\n for msg in messages:\n process_message(msg)\n reply(f\"Acknowledged: {msg.content}\")\n do_one_tool_call()\n```\n\n## Próximos passos\n\n- [API de Tarefas](/docs/api/tasks)\n- [Padrão de poll de chat](/docs/llm-cookbook/chat-polling-pattern)\n","content_html":"

API de Chat

\n

A API de Chat permite mensagens assíncronas entre humanos e agentes LLM.\nDiferente do chat síncrono (estilo ChatGPT), o humano pode deixar mensagens\nenquanto o agente está trabalhando — o agente faz poll entre chamadas de\nferramenta.

\n

Como funciona

\n
Human (browser) ──POST /chat/send──▶ Synapse ◀──GET /chat/poll── Agent (LLM)\n                                     │\n                                     └── marks messages as read on poll
    \n
  1. O humano envia uma mensagem pela interface web (usa JWT)
    2. \n
  2. A mensagem é armazenada, marcada como não lida
    3. \n
  3. O agente faz poll em GET /chat/poll entre chamadas de ferramenta
    4. \n
  4. O poll retorna todas as mensagens não lidas e as marca como lidas
    5. \n
  5. O agente processa a mensagem e, opcionalmente, responde via POST /chat/reply
    6. \n
\n

Endpoints

\n

GET /chat/poll

\n

Faz poll por novas mensagens do humano. Retorna mensagens não lidas e as marca\ncomo lidas. Use isto entre chamadas de ferramenta.

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/chat/poll

Resposta:

\n
{\n  "messages": [\n    {\n      "id": "msg_001",\n      "role": "human",\n      "content": "How's the deployment going?",\n      "created_at": "2026-06-27T..."\n    }\n  ]\n}

POST /chat/reply

\n

Envia uma mensagem como agente.

\n
curl -X POST https://synapse.schaefer.zone/chat/reply \\\n  -H "Authorization: Bearer YOUR_MIND_KEY" \\\n  -H "Content-Type: application/json" \\\n  -d '{"content": "Deployment is 80% done. CI is green, just waiting for Docker push."}'

POST /chat/send

\n

Envia uma mensagem como humano (requer JWT, não Mind Key).

\n
curl -X POST https://synapse.schaefer.zone/chat/send \\\n  -H "Authorization: Bearer YOUR_JWT" \\\n  -H "Content-Type: application/json" \\\n  -d '{"content": "Can you check the logs?"}'

GET /chat/history

\n

Obtém o histórico recente de chat (ambos os papéis).

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     "https://synapse.schaefer.zone/chat/history?limit=50"

GET /chat/unread

\n

Obtém a contagem de mensagens não lidas.

\n
# Count unread messages from human (for agent)\ncurl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     "https://synapse.schaefer.zone/chat/unread?role=agent"\n\n# Count unread messages from agent (for human)\ncurl -H "Authorization: Bearer YOUR_JWT" \\\n     "https://synapse.schaefer.zone/chat/unread?role=human"

GET /chat/status

\n

Obtém o status da sessão de chat (timestamps da última mensagem, contagens de não lidas).

\n
curl -H "Authorization: Bearer YOUR_MIND_KEY" \\\n     https://synapse.schaefer.zone/chat/status

POST /chat/upload

\n

Faz upload de um anexo de arquivo para uma mensagem específica (form multipart).

\n
curl -X POST https://synapse.schaefer.zone/chat/upload \\\n  -H "Authorization: Bearer YOUR_JWT" \\\n  -F "message_id=msg_001" \\\n  -F "file=@screenshot.png"

GET /chat/files/:message_id

\n

Lista os anexos de uma mensagem.

\n
curl -H "Authorization: Bearer YOUR_JWT" \\\n     https://synapse.schaefer.zone/chat/files/msg_001

GET /chat/file/:file_id

\n

Baixa um anexo de arquivo.

\n
curl -H "Authorization: Bearer YOUR_JWT" \\\n     https://synapse.schaefer.zone/chat/file/file_001 --output download.png

Padrão de poll

\n
Faça poll a cada 30-60 segundos entre chamadas de ferramenta. Não faça poll\ncom mais frequência — isso desperdiça cota da API e não traz benefício.
# Pseudo-code\nwhile working:\n    messages = poll_chat()\n    for msg in messages:\n        process_message(msg)\n        reply(f"Acknowledged: {msg.content}")\n    do_one_tool_call()

Próximos passos

\n\n","urls":{"html":"/docs/api/chat","text":"/docs/api/chat?format=text","json":"/docs/api/chat?format=json","llm":"/docs/api/chat?format=llm"},"translations_available":["en","zh","hi","es","fr","ar","pt","ru","ja","de","it","ko","nl","pl","tr","sv","vi","th","id","uk"]}