Introdução
A API v1 do Kadu dá a outro sistema tudo o que o Agent Console faz: listar e disparar tarefas, acompanhar execuções (logs, eventos, pendências, arquivos), configurar ambientes, secrets, agendamentos e webhooks, sincronizar o Playbook e consultar uso e custo.
Endereços
| Ambiente | URL base |
|---|---|
| Produção | https://api.kadu.ia.br/v1 |
| Staging | https://api.staging.kadu.ia.br/v1 |
curl -H "Authorization: Bearer $KOBANA_TOKEN" \
https://api.kadu.ia.br/v1/me
Toda rota exige um access token da Conta Kobana no header
Authorization: Bearer. Ver Autenticação.
O que dá para fazer
| Recurso | Endpoints | Para quê |
|---|---|---|
| Identidade | /v1/me | conferir de quem é o token |
| Organização | /v1/organizations | ler e alterar a organização do token |
| Estrutura | /v1/workspaces, /v1/activities, /v1/tasks | a árvore de tarefas |
| Disparo | POST /v1/tasks/{id}/run, GET /v1/tasks/{id}/readiness | rodar uma tarefa e conferir antes se o ambiente está pronto |
| Execuções | /v1/executions, /logs, /events, /todos, /cancel, /continue, /v1/executions/search | acompanhar, cancelar, continuar uma tarefa conversacional e buscar |
| Pendências | PATCH /v1/todos/{id} | resolver uma pendência |
| Arquivos | /v1/files | enviar arquivos de entrada e baixar os de saída |
| Configuração | /v1/environments, /v1/secrets, /v1/schedules, /v1/tasks/{id}/endpoint | ambientes, credenciais, agendamentos e o endpoint de disparo |
| Integrações | /v1/webhooks, /v1/webhook_deliveries | webhooks, entregas e reenvio |
| Repositório | /v1/repository, POST /v1/repository/sync | estado e sincronização do Playbook |
| Uso | /v1/usage | tokens, custo e preço por período |
| Pessoas | /v1/users, /v1/memberships, /v1/roles | membros, vínculos e papéis |
| Memória | /v1/memories | registros que a organização guarda por entidade |
| Eventos | /v1/system_events | eventos da organização |
A referência completa de cada endpoint está em Recursos, gerada da especificação OpenAPI (Especificação).
Contrato em uma tela
- JSON em
snake_casenos dois sentidos. - Sucesso:
{ "data": … }ou{ "data": […], "meta": { "next_cursor", "limit" } }. - Erro:
{ "error": { "code", "message", "details" } }, comcodeemUPPER_SNAKE_CASE. - Listagens por cursor (Paginação).
X-Idempotency-Keyem todoPOST,PUTePATCH(Idempotência).- 600 requisições por minuto por token (Limites).
Detalhes em Convenções.
Pelo terminal
O CLI kobana chama todos esses endpoints da linha de
comando (kobana kadu tasks run, kobana kadu executions logs), com o mesmo
token.
Disparo sem a API
Para que um sistema dispare uma tarefa específica sem token da Conta Kobana, use o endpoint de disparo: uma URL por tarefa, com credencial própria.