Cancel Task

client.tasks.cancel(, ?, ?): Task { id, cleaned_at, created_at, 6 more }

POST/tasks/{task_id}/cancel

Mark a running task as canceled.

ParametersExpand Collapse

taskID: string

body: TaskCancelParams { reason }

reason?: string | null

ReturnsExpand Collapse

Task { id, cleaned_at, created_at, 6 more }

id: string

cleaned_at?: string | null

created_at?: string | null

name?: string | null

params?: Record<string, unknown> | null

status?: "CANCELED" | "COMPLETED" | "FAILED" | 5 more | null

One of the following:

"CANCELED"

"COMPLETED"

"FAILED"

"RUNNING"

"INTERRUPTED"

"TERMINATED"

"TIMED_OUT"

"DELETED"

status_reason?: string | null

task_metadata?: Record<string, unknown> | null

updated_at?: string | null

Cancel Task

import Agentex from 'agentex';

const client = new Agentex({
  apiKey: process.env['AGENTEX_SDK_API_KEY'], // This is the default and can be omitted
});

const task = await client.tasks.cancel('task_id');

console.log(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"
}