Terminate Task

tasks.terminate(, ) -> Task

POST/tasks/{task_id}/terminate

Mark a running task as terminated.

ParametersExpand Collapse

task_id: str

reason: Optional[str]

ReturnsExpand 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]

Terminate Task

import os
from agentex import Agentex

client = Agentex(
    api_key=os.environ.get("AGENTEX_SDK_API_KEY"),  # This is the default and can be omitted
)
task = client.tasks.terminate(
    task_id="task_id",
)
print(task.id)

{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}