Executions

get

Retrieves an execution with its children.

Query parameters
chatMessageIdstring · uuidOptional

A UUID v4 string that identifies an entity.

executionIdstring · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves an execution with its children.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
creditsUsednumberRequired

The total number of credits used by this execution.

detailany ofRequired

The execution detail containing type-specific information.

or
or
endedAtstring · date-time · nullableRequired

When this execution ended.

isAgenticbooleanRequired

Whether this execution is agentic.

isPurgedbooleanRequired

Whether this execution has been purged.

parentIdstring · uuid · nullableRequired

The parent execution ID of this execution.

responderIdstringRequired

The responder ID of this execution.

startedAtstring · date-timeRequired

When this execution started.

statusstring · enumRequired

The status of the execution.

Possible values:
workspaceIdstringRequired

The workspace ID of this execution.

get
/api/v1/executions/nestings
get

Retrieves an execution.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves an execution.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
creditsUsednumberRequired

The total number of credits used by this execution.

detailany ofRequired

The execution detail containing type-specific information.

or
or
endedAtstring · date-time · nullableRequired

When this execution ended.

isAgenticbooleanRequired

Whether this execution is agentic.

isPurgedbooleanRequired

Whether this execution has been purged.

parentIdstring · uuid · nullableRequired

The parent execution ID of this execution.

responderIdstringRequired

The responder ID of this execution.

startedAtstring · date-timeRequired

When this execution started.

statusstring · enumRequired

The status of the execution.

Possible values:
workspaceIdstringRequired

The workspace ID of this execution.

get
/api/v1/executions/{id}
get

Retrieves multiple executions.

Query parameters
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
responderIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all executions for the workspace.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
creditsUsednumberRequired

The total number of credits used by this execution.

detailany ofRequired

The execution detail containing type-specific information.

or
or
endedAtstring · date-time · nullableRequired

When this execution ended.

isAgenticbooleanRequired

Whether this execution is agentic.

isPurgedbooleanRequired

Whether this execution has been purged.

parentIdstring · uuid · nullableRequired

The parent execution ID of this execution.

responderIdstringRequired

The responder ID of this execution.

startedAtstring · date-timeRequired

When this execution started.

statusstring · enumRequired

The status of the execution.

Possible values:
workspaceIdstringRequired

The workspace ID of this execution.

get
/api/v1/executions

Last updated