Introduction
The Kadu v1 API gives another system everything the Agent Console does: list and run tasks, follow executions (logs, events, pending items, files), configure environments, secrets, schedules and webhooks, sync the Playbook, and query usage and cost.
Addresses​
| Environment | Base URL |
|---|---|
| Production | 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
Every route requires a Kobana Account access token in the
Authorization: Bearer header. See Authentication.
What you can do​
| Resource | Endpoints | What for |
|---|---|---|
| Identity | /v1/me | check whose token it is |
| Organization | /v1/organizations | read and change the token's organization |
| Structure | /v1/workspaces, /v1/activities, /v1/tasks | the task tree |
| Run | POST /v1/tasks/{id}/run, GET /v1/tasks/{id}/readiness | run a task and check beforehand whether the environment is ready |
| Executions | /v1/executions, /logs, /events, /todos, /cancel, /continue, /v1/executions/search | follow, cancel, continue a conversational task and search |
| Pending items | PATCH /v1/todos/{id} | resolve a pending item |
| Files | /v1/files | upload input files and download output files |
| Configuration | /v1/environments, /v1/secrets, /v1/schedules, /v1/tasks/{id}/endpoint | environments, credentials, schedules and the run endpoint |
| Integrations | /v1/webhooks, /v1/webhook_deliveries | webhooks, deliveries and resend |
| Repository | /v1/repository, POST /v1/repository/sync | state and sync of the Playbook |
| Usage | /v1/usage | tokens, cost and price per period |
| People | /v1/users, /v1/memberships, /v1/roles | members, memberships and roles |
| Memory | /v1/memories | records the organization keeps per entity |
| Events | /v1/system_events | organization events |
The full reference for each endpoint is in Resources, generated from the OpenAPI specification (Specification).
The contract on one screen​
- JSON in
snake_casein both directions. - Success:
{ "data": … }or{ "data": […], "meta": { "next_cursor", "limit" } }. - Error:
{ "error": { "code", "message", "details" } }, withcodeinUPPER_SNAKE_CASE. - Cursor-based listings (Pagination).
X-Idempotency-Keyon everyPOST,PUTandPATCH(Idempotency).- 600 requests per minute per token (Limits).
Details in Conventions.
From the terminal​
The kobana CLI calls every one of these endpoints
from the command line (kobana kadu tasks run, kobana kadu executions logs),
with the same token.
Running without the API​
For a system to run one specific task without a Kobana Account token, use the run endpoint: one URL per task, with its own credential.