Skip to content
agentex-sdk
API Reference

Tasks

Get Task by ID
tasks.retrieve(strtask_id, TaskRetrieveParams**kwargs) -> TaskRetrieveResponse
GET/tasks/{task_id}
Delete Task by ID
tasks.delete(strtask_id) -> DeleteResponse
DELETE/tasks/{task_id}
List Tasks
tasks.list(TaskListParams**kwargs) -> TaskListResponse
GET/tasks
Stream Task Events by ID
tasks.stream_events(strtask_id) -> object
GET/tasks/{task_id}/stream
Get Task by Name
tasks.retrieve_by_name(strtask_name, TaskRetrieveByNameParams**kwargs) -> TaskRetrieveByNameResponse
GET/tasks/name/{task_name}
Delete Task by Name
tasks.delete_by_name(strtask_name) -> DeleteResponse
DELETE/tasks/name/{task_name}
Stream Task Events by Name
tasks.stream_events_by_name(strtask_name) -> object
GET/tasks/name/{task_name}/stream
Update Task by ID
tasks.update_by_id(strtask_id, TaskUpdateByIDParams**kwargs) -> Task
PUT/tasks/{task_id}
Update Task by Name
tasks.update_by_name(strtask_name, TaskUpdateByNameParams**kwargs) -> Task
PUT/tasks/name/{task_name}
Complete Task
tasks.complete(strtask_id, TaskCompleteParams**kwargs) -> Task
POST/tasks/{task_id}/complete
Fail Task
tasks.fail(strtask_id, TaskFailParams**kwargs) -> Task
POST/tasks/{task_id}/fail
Cancel Task
tasks.cancel(strtask_id, TaskCancelParams**kwargs) -> Task
POST/tasks/{task_id}/cancel
Terminate Task
tasks.terminate(strtask_id, TaskTerminateParams**kwargs) -> Task
POST/tasks/{task_id}/terminate
Timeout Task
tasks.timeout(strtask_id, TaskTimeoutParams**kwargs) -> Task
POST/tasks/{task_id}/timeout
Query Task Workflow
tasks.query_workflow(strquery_name, TaskQueryWorkflowParams**kwargs) -> TaskQueryWorkflowResponse
GET/tasks/{task_id}/query/{query_name}
Interrupt Task
tasks.interrupt(strtask_id, TaskInterruptParams**kwargs) -> Task
POST/tasks/{task_id}/interrupt
ModelsExpand Collapse
class Task: …
id: str
cleaned_at: Optional[datetime]
created_at: Optional[datetime]
name: Optional[str]
params: Optional[Dict[str, object]]
status: Optional[Literal["CANCELED", "COMPLETED", "FAILED", 5 more]]
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: Optional[str]
task_metadata: Optional[Dict[str, object]]
updated_at: Optional[datetime]
class TaskRetrieveResponse: …

Task response model with optional related data based on relationships

id: str
agents: Optional[List[Agent]]
id: str

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: datetime

The timestamp when the agent was created

formatdate-time
description: str

The description of the action.

name: str

The unique name of the agent.

updated_at: datetime

The timestamp when the agent was last updated

formatdate-time
agent_input_type: Optional[Literal["text", "json"]]

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: Optional[str]

ID of the current production deployment.

registered_at: Optional[datetime]

The timestamp when the agent was last registered

formatdate-time
registration_metadata: Optional[Dict[str, object]]

The metadata for the agent’s registration.

status: Optional[Literal["Ready", "Failed", "Unknown", 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[str]

The reason for the status of the action.

cleaned_at: Optional[datetime]
created_at: Optional[datetime]
name: Optional[str]
params: Optional[Dict[str, object]]
status: Optional[Literal["CANCELED", "COMPLETED", "FAILED", 5 more]]
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: Optional[str]
task_metadata: Optional[Dict[str, object]]
updated_at: Optional[datetime]
List[TaskListResponseItem]
id: str
agents: Optional[List[Agent]]
id: str

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: datetime

The timestamp when the agent was created

formatdate-time
description: str

The description of the action.

name: str

The unique name of the agent.

updated_at: datetime

The timestamp when the agent was last updated

formatdate-time
agent_input_type: Optional[Literal["text", "json"]]

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: Optional[str]

ID of the current production deployment.

registered_at: Optional[datetime]

The timestamp when the agent was last registered

formatdate-time
registration_metadata: Optional[Dict[str, object]]

The metadata for the agent’s registration.

status: Optional[Literal["Ready", "Failed", "Unknown", 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[str]

The reason for the status of the action.

cleaned_at: Optional[datetime]
created_at: Optional[datetime]
name: Optional[str]
status: Optional[Literal["CANCELED", "COMPLETED", "FAILED", 5 more]]
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: Optional[str]
task_metadata: Optional[Dict[str, object]]
updated_at: Optional[datetime]
class TaskRetrieveByNameResponse: …

Task response model with optional related data based on relationships

id: str
agents: Optional[List[Agent]]
id: str

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: datetime

The timestamp when the agent was created

formatdate-time
description: str

The description of the action.

name: str

The unique name of the agent.

updated_at: datetime

The timestamp when the agent was last updated

formatdate-time
agent_input_type: Optional[Literal["text", "json"]]

The type of input the agent expects.

One of the following:
"text"
"json"
production_deployment_id: Optional[str]

ID of the current production deployment.

registered_at: Optional[datetime]

The timestamp when the agent was last registered

formatdate-time
registration_metadata: Optional[Dict[str, object]]

The metadata for the agent’s registration.

status: Optional[Literal["Ready", "Failed", "Unknown", 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[str]

The reason for the status of the action.

cleaned_at: Optional[datetime]
created_at: Optional[datetime]
name: Optional[str]
params: Optional[Dict[str, object]]
status: Optional[Literal["CANCELED", "COMPLETED", "FAILED", 5 more]]
One of the following:
"CANCELED"
"COMPLETED"
"FAILED"
"RUNNING"
"INTERRUPTED"
"TERMINATED"
"TIMED_OUT"
"DELETED"
status_reason: Optional[str]
task_metadata: Optional[Dict[str, object]]
updated_at: Optional[datetime]
Dict[str, object]