Skip to main content
GET
/
tasks
/
name
/
{task_name}
Get Task by Name
curl --request GET \
  --url https://api.example.com/tasks/name/{task_name}
{
  "id": "<string>",
  "name": "<string>",
  "status_reason": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cleaned_at": "2023-11-07T05:31:56Z",
  "params": {},
  "task_metadata": {},
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "Unknown",
      "status_reason": "<string>",
      "registration_metadata": {},
      "registered_at": "2023-11-07T05:31:56Z",
      "production_deployment_id": "<string>"
    }
  ]
}

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
​
task_metadata
Task metadata · object
​
agents
Agent · object[] | null