Skip to content
agentex-sdk
API Reference

Tasks

Get Task by ID
GET/tasks/{task_id}
Delete Task by ID
DELETE/tasks/{task_id}
List Tasks
GET/tasks
Stream Task Events by ID
GET/tasks/{task_id}/stream
Get Task by Name
GET/tasks/name/{task_name}
Delete Task by Name
DELETE/tasks/name/{task_name}
Stream Task Events by Name
GET/tasks/name/{task_name}/stream
Update Task by ID
PUT/tasks/{task_id}
Update Task by Name
PUT/tasks/name/{task_name}
Complete Task
POST/tasks/{task_id}/complete
Fail Task
POST/tasks/{task_id}/fail
Cancel Task
POST/tasks/{task_id}/cancel
Terminate Task
POST/tasks/{task_id}/terminate
Timeout Task
POST/tasks/{task_id}/timeout
Query Task Workflow
GET/tasks/{task_id}/query/{query_name}
Interrupt Task
POST/tasks/{task_id}/interrupt
ModelsExpand Collapse
Task object { id, cleaned_at, created_at, 6 more }
id: string
cleaned_at: optional string
created_at: optional string
name: optional string
params: optional map[unknown]
status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: optional string
task_metadata: optional map[unknown]
updated_at: optional string
TaskRetrieveResponse object { id, agents, cleaned_at, 7 more }

Task response model with optional related data based on relationships

id: string
agents: optional array of Agent { id, acp_type, created_at, 9 more }
id: string

The unique identifier of the agent.

acp_type: AcpType

The type of the ACP Server (Either sync or async)

One of the following:
"sync"
"async"
"agentic"
created_at: string

The timestamp when the agent was created

formatdate-time
description: string

The description of the action.

name: string

The unique name of the agent.

updated_at: string

The timestamp when the agent was last updated

formatdate-time
agent_input_type: optional "text" or "json"

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: optional string

ID of the current production deployment.

registered_at: optional string

The timestamp when the agent was last registered

formatdate-time
registration_metadata: optional map[unknown]

The metadata for the agent’s registration.

status: optional "Ready" or "Failed" or "Unknown" or 3 more

The status of the action, indicating if it’s building, ready, failed, etc.

One of the following:
"Ready"
"Failed"
"Unknown"
"Deleted"
"Unhealthy"
"BuildOnly"
status_reason: optional string

The reason for the status of the action.

cleaned_at: optional string
created_at: optional string
name: optional string
params: optional map[unknown]
status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: optional string
task_metadata: optional map[unknown]
updated_at: optional string
TaskListResponse = array of object { id, agents, cleaned_at, 6 more }
id: string
agents: optional array of Agent { id, acp_type, created_at, 9 more }
id: string

The unique identifier of the agent.

acp_type: AcpType

The type of the ACP Server (Either sync or async)

One of the following:
"sync"
"async"
"agentic"
created_at: string

The timestamp when the agent was created

formatdate-time
description: string

The description of the action.

name: string

The unique name of the agent.

updated_at: string

The timestamp when the agent was last updated

formatdate-time
agent_input_type: optional "text" or "json"

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: optional string

ID of the current production deployment.

registered_at: optional string

The timestamp when the agent was last registered

formatdate-time
registration_metadata: optional map[unknown]

The metadata for the agent’s registration.

status: optional "Ready" or "Failed" or "Unknown" or 3 more

The status of the action, indicating if it’s building, ready, failed, etc.

One of the following:
"Ready"
"Failed"
"Unknown"
"Deleted"
"Unhealthy"
"BuildOnly"
status_reason: optional string

The reason for the status of the action.

cleaned_at: optional string
created_at: optional string
name: optional string
status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: optional string
task_metadata: optional map[unknown]
updated_at: optional string
TaskStreamEventsResponse = unknown
TaskRetrieveByNameResponse object { id, agents, cleaned_at, 7 more }

Task response model with optional related data based on relationships

id: string
agents: optional array of Agent { id, acp_type, created_at, 9 more }
id: string

The unique identifier of the agent.

acp_type: AcpType

The type of the ACP Server (Either sync or async)

One of the following:
"sync"
"async"
"agentic"
created_at: string

The timestamp when the agent was created

formatdate-time
description: string

The description of the action.

name: string

The unique name of the agent.

updated_at: string

The timestamp when the agent was last updated

formatdate-time
agent_input_type: optional "text" or "json"

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: optional string

ID of the current production deployment.

registered_at: optional string

The timestamp when the agent was last registered

formatdate-time
registration_metadata: optional map[unknown]

The metadata for the agent’s registration.

status: optional "Ready" or "Failed" or "Unknown" or 3 more

The status of the action, indicating if it’s building, ready, failed, etc.

One of the following:
"Ready"
"Failed"
"Unknown"
"Deleted"
"Unhealthy"
"BuildOnly"
status_reason: optional string

The reason for the status of the action.

cleaned_at: optional string
created_at: optional string
name: optional string
params: optional map[unknown]
status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: optional string
task_metadata: optional map[unknown]
updated_at: optional string
TaskStreamEventsByNameResponse = unknown
TaskQueryWorkflowResponse = map[unknown]