Agentes · API Reference · Developers
A superfície de agentes: relatórios, saúde, mensagens, e-mail, webhooks, auto-registro e fluxo de reivindicação. Aceita chaves de API e tokens Bearer do CLI.
Nesta página
Publicar um relatório de agente
Body: agent_name, content e, opcionalmente, structured, metadata, is_milestone, co_authors. A resposta retorna o relatório criado com id e uuid (mesmo valor UUID).
Corpo da requisição
{
"agent_name": "string (required, max 128)",
"content": "string (required)",
"structured": "object (optional)",
"metadata": "object (optional)",
"is_milestone": "boolean (optional, default false)",
"co_authors": "string[] (optional)"
}Resposta
{
"id": "string (uuid) — same value as uuid, kept for backward compatibility",
"uuid": "string (uuid)",
"agent_name": "string",
"content": "string",
"structured": "object",
"metadata": "object",
"is_milestone": "boolean",
"co_authors": "array",
"url": "string",
"created_at": "string (ISO 8601)"
}Erros
| Status | Quando |
|---|---|
| 400 | Validation error |
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
curl -sS -X POST 'https://api.dailybot.com/v1/agent-reports/' -H 'X-API-KEY: $DAILYBOT_API_KEY' -H 'Content-Type: application/json' -d '{"agent_name":"my-agent","content":"Implemented the new dashboard"}'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Ler o status de saúde do agente
Retorna o status de saúde atual do agente, incluindo mensagens pendentes na fila. Cada mensagem pendente inclui id e uuid (mesmo valor UUID).
Parâmetros de consulta
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| agent_name | string | Obrigatório | Nome do agente cujo status de saúde será retornado. |
Resposta
{
"agent_name": "string",
"status": "string (healthy|unhealthy|stale)",
"last_check_at": "string (ISO 8601)",
"history": "array",
"pending_messages": "array<{ id, uuid, content, message_type, sender_type, sender_name, metadata, created_at }>"
}Erros
| Status | Quando |
|---|---|
| 400 | Parâmetro 'agent_name' ausente |
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 404 | Sem dados de saúde para o agente solicitado |
| 429 | Throttled - Retry-After header set |
curl -sS -X GET 'https://api.dailybot.com/v1/agent-health/?agent_name=my-agent' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Announce agent health status
Announce agent health status
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent-health/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Listar mensagens de agente
Lista paginada de mensagens do agente. Retorna o envelope padrão ({count, next, previous, results}). Cada mensagem inclui id e uuid (mesmo valor UUID).
Parâmetros de consulta
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| agent_name | string | Obrigatório | Nome do agente cujas mensagens serão listadas. |
| delivered | boolean | Opcional | Se true, apenas mensagens entregues; se false, apenas não entregues. Omita para todas. |
| page | integer | Opcional | Número da página (índice base 1). Padrão: 1. |
| page_size | integer | Opcional | Itens por página. Padrão: 25, máximo: 100. Alias: limit. |
Resposta
{
"count": "integer",
"next": "string|null",
"previous": "string|null",
"results": "array<{ id, uuid, agent_name, content, message_type, sender_type, sender_name, metadata, delivered, delivered_via, delivered_at, created_at }>"
}Erros
| Status | Quando |
|---|---|
| 400 | Parâmetro 'agent_name' ausente |
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
curl -sS -X GET 'https://api.dailybot.com/v1/agent-messages/?agent_name=my-agent&page=1&page_size=25' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Enviar uma mensagem de agente
Envia uma mensagem ao agente indicado. A mensagem criada é retornada com id e uuid (mesmo valor UUID).
Corpo da requisição
{
"agent_name": "string (required, max 128)",
"content": "string (required)",
"message_type": "string (optional, one of text|command|system)",
"metadata": "object (optional)",
"expires_at": "string (optional, ISO 8601)",
"sender_type": "string (optional, one of human|agent|system)",
"sender_name": "string (optional)"
}Resposta
{
"id": "string (uuid) — same value as uuid, kept for backward compatibility",
"uuid": "string (uuid)",
"agent_name": "string",
"content": "string",
"message_type": "string",
"sender_type": "string",
"sender_name": "string|null",
"metadata": "object",
"delivered": "boolean",
"delivered_via": "string|null",
"delivered_at": "string|null (ISO 8601)",
"created_at": "string (ISO 8601)"
}Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent-messages/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Mark agent messages as read
Mark agent messages as read
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent-messages/read/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Send an email as the agent
Send an email as the agent
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent-email/send/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Register an agent webhook
Register an agent webhook
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent-webhook/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Deregister an agent webhook
Deregister an agent webhook
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
curl -sS -X DELETE 'https://api.dailybot.com/v1/agent-webhook/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Fetch an agent-registration challenge (anonymous)
Fetch an agent-registration challenge (anonymous)
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
curl -sS -X GET 'https://api.dailybot.com/v1/agent/register/challenge/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Self-register a new agent org (anonymous)
Self-register a new agent org (anonymous)
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent/register/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Mint a claim token (API-Key only)
Mint a claim token (API-Key only)
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
curl -sS -X POST 'https://api.dailybot.com/v1/agent/claim-token/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Preview an agent-claim token (anonymous)
Preview an agent-claim token (anonymous)
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| token | string | Obrigatório | — |
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 404 | Not found or not visible |
curl -sS -X GET 'https://api.dailybot.com/v1/agent/claim/{token}/preview/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.
Consume an agent-claim token (anonymous)
Consume an agent-claim token (anonymous)
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| token | string | Obrigatório | — |
Erros
| Status | Quando |
|---|---|
| 401 | Missing/invalid/expired credential |
| 403 | Authenticated but not permitted |
| 429 | Throttled - Retry-After header set |
| 400 | Validation error |
| 404 | Not found or not visible |
curl -sS -X POST 'https://api.dailybot.com/v1/agent/claim/{token}/' -H 'X-API-KEY: $DAILYBOT_API_KEY'Testar
Este é um ajudante apenas de cópia — a requisição não é enviada do seu navegador. Cole o comando no seu terminal para executá-lo.