Skip to main content
GET
Get Task by Name

Path Parameters

task_name
string
required

Query Parameters

relationships
enum<string>[]

Task relationships that can be loaded

Available options:
agents

Response

Successful Response

Task response model with optional related data based on relationships

id
string
required
name
string | null
status
enum<string> | null
Available options:
CANCELED,
COMPLETED,
FAILED,
RUNNING,
TERMINATED,
TIMED_OUT,
DELETED
status_reason
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
cleaned_at
string<date-time> | null
params
Task parameters · object | null
task_metadata
Task metadata · object | null
agents
Agent · object[] | null