Pular para o conteúdo principal

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​

AmbienteURL base
Produçãohttps://api.kadu.ia.br/v1
Staginghttps://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​

RecursoEndpointsPara quê
Identidade/v1/meconferir de quem é o token
Organização/v1/organizationsler e alterar a organização do token
Estrutura/v1/workspaces, /v1/activities, /v1/tasksa árvore de tarefas
DisparoPOST /v1/tasks/{id}/run, GET /v1/tasks/{id}/readinessrodar uma tarefa e conferir antes se o ambiente está pronto
Execuções/v1/executions, /logs, /events, /todos, /cancel, /continue, /v1/executions/searchacompanhar, cancelar, continuar uma tarefa conversacional e buscar
PendênciasPATCH /v1/todos/{id}resolver uma pendência
Arquivos/v1/filesenviar arquivos de entrada e baixar os de saída
Configuração/v1/environments, /v1/secrets, /v1/schedules, /v1/tasks/{id}/endpointambientes, credenciais, agendamentos e o endpoint de disparo
Integrações/v1/webhooks, /v1/webhook_deliverieswebhooks, entregas e reenvio
Repositório/v1/repository, POST /v1/repository/syncestado e sincronização do Playbook
Uso/v1/usagetokens, custo e preço por período
Pessoas/v1/users, /v1/memberships, /v1/rolesmembros, vínculos e papéis
Memória/v1/memoriesregistros que a organização guarda por entidade
Eventos/v1/system_eventseventos 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_case nos dois sentidos.
  • Sucesso: { "data": … } ou { "data": […], "meta": { "next_cursor", "limit" } }.
  • Erro: { "error": { "code", "message", "details" } }, com code em UPPER_SNAKE_CASE.
  • Listagens por cursor (Paginação).
  • X-Idempotency-Key em todo POST, PUT e PATCH (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.