Cancel the workspace's currently-running task

POST

/workspaces/{id}/task/cancel

const url = 'https://your-org.evershell.ai/v1/workspaces/example/task/cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://your-org.evershell.ai/v1/workspaces/example/task/cancel \
  --header 'Authorization: Bearer <token>'

Permissions: workspace:write or workspace:write:own (creator-match on :own).

Signals the agent to stop the in-flight task. The agent completes its current iteration (model + tool call) and commits a task_completed event with status=cancelled. Subsequent tasks on the same workspace continue normally — this does NOT stop the workspace pod.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Responses

202

Cancellation signal accepted

404

Resource not found in the caller’s org

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

409

workspace_stopped / workspace_failed / workspace_provisioning — the workspace isn’t in a state where it has a running task.

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}

502

Agent service couldn’t be reached (agent_unreachable).

application/json

object

error

required

object

code

required

Closed-enum slug (e.g. permission_denied, validation_error, workspace_not_found)

string

message

required

Human-readable summary

string

request_id

required

Server-generated request id for correlating logs

string

details

Optional structured context. Validation errors land at details.fields as a per-field map.

object

key

additional properties

any

Example

{
  "error": {
    "code": "permission_denied",
    "message": "caller lacks required scope",
    "request_id": "7f3a9c2e"
  }
}