Saltar al contenido principal

Introducción

La API v1 de Kadu le da a otro sistema todo lo que hace el Agent Console: listar y lanzar tareas, seguir ejecuciones (logs, eventos, pendientes, archivos), configurar entornos, secrets, programaciones y webhooks, sincronizar el Playbook y consultar uso y costo.

Direcciones​

EntornoURL base
Producciónhttps://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 ruta exige un access token de la Cuenta Kobana en el header Authorization: Bearer. Ver Autenticación.

Qué se puede hacer​

RecursoEndpointsPara qué
Identidad/v1/meverificar de quién es el token
Organización/v1/organizationsleer y modificar la organización del token
Estructura/v1/workspaces, /v1/activities, /v1/tasksel árbol de tareas
LanzamientoPOST /v1/tasks/{id}/run, GET /v1/tasks/{id}/readinessejecutar una tarea y verificar antes si el entorno está listo
Ejecuciones/v1/executions, /logs, /events, /todos, /cancel, /continue, /v1/executions/searchseguir, cancelar, continuar una tarea conversacional y buscar
PendientesPATCH /v1/todos/{id}resolver un pendiente
Archivos/v1/filesenviar archivos de entrada y descargar los de salida
Configuración/v1/environments, /v1/secrets, /v1/schedules, /v1/tasks/{id}/endpointentornos, credenciales, programaciones y el endpoint de lanzamiento
Integraciones/v1/webhooks, /v1/webhook_deliverieswebhooks, entregas y reenvío
Repositorio/v1/repository, POST /v1/repository/syncestado y sincronización del Playbook
Uso/v1/usagetokens, costo y precio por período
Personas/v1/users, /v1/memberships, /v1/rolesmiembros, vínculos y roles
Memoria/v1/memoriesregistros que la organización guarda por entidad
Eventos/v1/system_eventseventos de la organización

La referencia completa de cada endpoint está en Recursos, generada a partir de la especificación OpenAPI (Especificación).

El contrato en una pantalla​

  • JSON en snake_case en ambos sentidos.
  • Éxito: { "data": … } o { "data": […], "meta": { "next_cursor", "limit" } }.
  • Error: { "error": { "code", "message", "details" } }, con code en UPPER_SNAKE_CASE.
  • Listados por cursor (Paginación).
  • X-Idempotency-Key en todo POST, PUT y PATCH (Idempotencia).
  • 600 solicitudes por minuto por token (Límites).

Detalles en Convenciones.

Desde la terminal​

La CLI kobana llama a todos estos endpoints desde la línea de comandos (kobana kadu tasks run, kobana kadu executions logs), con el mismo token.

Lanzamiento sin la API​

Para que un sistema lance una tarea específica sin token de la Cuenta Kobana, usa el endpoint de lanzamiento: una URL por tarea, con credencial propia.