Usage

Syntax

kobana <product> <resource> <method> [flags]

• <product> — banking, finance, billing, inbox, dunning, dashboards or kadu.
• <resource> — can be nested: tasks, executions search, webhook-deliveries. It is the first segment after /v1, with - in place of _.
• <method> — the action: list, get, create, update, delete, or the endpoint's action name (run, cancel, replay).

The API version never appears in the command — the CLI resolves the URL from the embedded OpenAPI spec.

URL and query parameters go in --params; the request body goes in --json. The CLI knows from the spec where each parameter goes: id goes in the path, the rest in the query.

The whole surface is discovered with --help, at any level:

kobana --help                       # products
kobana kadu --help                  # Kadu resources
kobana kadu tasks --help            # methods of a resource

kadu resources

Resource	Description
me	Who is behind the token.
organizations	The token's organization: name, time zone, monthly cost cap and custom_metadata.
workspaces	Business domains of the organization. Each workspace is a plugin of the Kadu Playbook.
activities	Groupings of tasks within a workspace.
tasks	The organization's executable skills: registration, run, pre-check and the HTTP run endpoint.
executions	Each run of a task, with logs, events, pending items and text search.
memories	Organization memory: records per entity (entity_type + entity_value), scoped to the organization, a workspace or an activity.
environments	Execution environments (Production, Sandbox…). Each secret and schedule belongs to one.
secrets	Credentials delivered to executions. The value is stored encrypted and is never returned.
schedules	Recurring executions of a task in an environment, defined by a cron expression.
files	Input files (attached to the run) and output files (published by the execution).
repository	The organization's Kadu Playbook and its sync.
usage	Tokens, cost and price of executions.
todos	Pending items created by executions.
webhooks	Signed HTTP notifications sent when events occur.
webhook-deliveries	History and resending of webhook deliveries.
operation-approvals	Operations an assistant requested through MCP that wait for the person's confirmation by link (read-only).
roles	Roles and the agent.* permissions they grant.
users	Organization members.
memberships	Links between people and the organization.
system-events	Organization events (the same ones that feed webhooks).

Each resource has its own page, with the full command table and examples — see the catalog.

Examples

# Executions that failed or were cancelled this month
kobana kadu executions list \
  --params '{"status[in]": "failed,cancelled", "reference_date[gte]": "2026-10-01"}' \
  --fields "id,status,reference_date"

# Every page, one item per line (NDJSON)
kobana kadu executions list --page-all --fields "id,status"

# Table output
kobana kadu tasks list --output-format table

# Save the response to a file
kobana kadu tasks get --params '{"id": "TASK_ID"}' --output tarefa.json

Example: trigger and follow

# 1. The task and the environment
kobana kadu tasks list --fields "id,skill_slug,label"
kobana kadu environments list --fields "id,label"

# 2. Check the environment is ready
kobana kadu tasks readiness --params '{"id": "TASK_ID"}'

# 3. Trigger (first with --dry-run)
kobana kadu tasks run --dry-run --params '{"id": "TASK_ID"}' \
  --json '{"reference_date": "2026-10-30", "environment_id": "ENVIRONMENT_ID"}'

# 4. Follow the execution
kobana kadu executions get --params '{"id": "EXECUTION_ID"}' --fields "id,status"
kobana kadu executions events --params '{"id": "EXECUTION_ID"}'
kobana kadu executions logs --params '{"id": "EXECUTION_ID"}'

# 5. Resolve the pending items it left
kobana kadu executions todos --params '{"id": "EXECUTION_ID"}'
kobana kadu todos update --params '{"id": "TODO_ID"}' --json '{"status": "resolved"}'

Next steps

• Schema introspection — inspect the parameters and body of any endpoint.
• Global flags — every flag a command accepts.
• Helpers — +verb shortcuts for common flows.
• Resources — the full catalog, resource by resource.