Skip to main content

kobana kadu executions

Commands of kobana kadu executions. Every global option (Global options) applies here.

CommandHTTPDescription
executions searchGET /v1/executions/searchText search across executions
executions listGET /v1/executionsList executions
executions getGET /v1/executions/{id}Get execution details
executions cancelPOST /v1/executions/{id}/cancelCancel the execution
executions consolidate-memoriesPOST /v1/executions/{id}/consolidate_memoriesConsolidates the execution's memories
executions continuePOST /v1/executions/{id}/continueContinue the conversation (next round)
executions eventsGET /v1/executions/{id}/eventsExecution events
executions logsGET /v1/executions/{id}/logsExecution logs
executions todosGET /v1/executions/{id}/todosPending items (todos) of the execution

Text search across executions

kobana kadu executions search [OPTIONS]

GET /v1/executions/search

Searches events, todos, logs, result and error. Up to 30 executions, most recent first, each with up to 3 snippets. Only sources the caller could read directly are included: logs require the organization's executions_logs.view permission, and on a person's token the role needs agent.logs.list, agent.events.list and agent.todos.list for logs, events and todos.

Query parameters

NameTypeRequiredDescription
qstringyes

Responses

HTTPDescription
200OK
400VALIDATION_ERROR β€” q shorter than 2 characters
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions list​

List executions

kobana kadu executions list [OPTIONS]

GET /v1/executions

Query parameters

NameTypeRequiredDescription
cursorstringno
limitnumberno
sort_bystringnoField in snake_case: created_at (default), updated_at or a filterable field.
sort_orderstringnoDefault: desc. Values: asc, desc.

Responses

HTTPDescription
200OK
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions get​

Get execution details

kobana kadu executions get [ID] [OPTIONS]

GET /v1/executions/{id}

Path arguments: id

Responses

HTTPDescription
200OK
404not found
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions cancel​

Cancel the execution

kobana kadu executions cancel [ID] [OPTIONS]

POST /v1/executions/{id}/cancel

Path arguments: id

Responses

HTTPDescription
200cancelled (or the current terminal status, if already finished)
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (or the route's CONFLICT)
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions consolidate-memories​

Consolidates the execution's memories

kobana kadu executions consolidate-memories [ID] [OPTIONS]

POST /v1/executions/{id}/consolidate_memories

Reads the result, the events, the pending items and the user request of this finished execution and saves the durable facts as memories, in the Task scope β€” even with memories off in it. Redoes it if already consolidated (updates the same memories). It is a model call charged to the organization. Asynchronous.

Path arguments: id

Responses

HTTPDescription
202queued
404NOT_FOUND
409CONFLICT β€” execution not finished / IDEMPOTENCY_KEY_REUSED
503SERVICE_UNAVAILABLE β€” queue unavailable

executions continue​

Continue the conversation (next round)

kobana kadu executions continue [ID] [OPTIONS]

POST /v1/executions/{id}/continue

Only for a conversational Task (conversational): creates a child execution of this one that resumes the agent session (context, output files and state) and handles the request in message. It uses this execution's parameters, reference date and environment, and this execution must be finished (success or failed). Continuing an older round opens a branch. The new execution carries parentExecutionId (this one) and rootExecutionId (the first round).

Path arguments: id

Request body

NameTypeRequiredDescription
messagestringyes
localestringno
input_file_idsarray<string (uuid)>noNew files for this round (POST /files, not yet used).

More fields and nested objects: kobana schema kadu.executions.continue.

Responses

HTTPDescription
201round created (in the Task queue)
404NOT_FOUND
409NOT_CONVERSATIONAL / EXECUTOR_NOT_SUPPORTED / EXECUTOR_CHANGED / NOT_FINISHED / SESSION_UNAVAILABLE
422ENVIRONMENT_REQUIRED / MISSING_SECRETS (details.keys) / INVALID_PARAMETERS / INVALID_INPUT_FILES / COST_LIMIT_REACHED
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions events​

Execution events

kobana kadu executions events [ID] [OPTIONS]

GET /v1/executions/{id}/events

By sequence, up to 500 per call. To follow along, pass the last sequence received in after_sequence and repeat.

Path arguments: id

Query parameters

NameTypeRequiredDescription
after_sequenceinteger,nullno

Responses

HTTPDescription
200OK
404NOT_FOUND
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions logs​

Execution logs

kobana kadu executions logs [ID] [OPTIONS]

GET /v1/executions/{id}/logs

In order of arrival, up to 1000 per call. To follow a running execution, pass the last id received in after_id and repeat.

Path arguments: id

Query parameters

NameTypeRequiredDescription
after_idinteger,nullno

Responses

HTTPDescription
200OK
404NOT_FOUND
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).

executions todos​

Pending items (todos) of the execution

kobana kadu executions todos [ID] [OPTIONS]

GET /v1/executions/{id}/todos

Path arguments: id

Responses

HTTPDescription
200OK
404NOT_FOUND
503AS_UNAVAILABLE β€” token verification is unavailable (Authorization Server down or configuration missing). Try again (Retry-After).