Cancel Session

Request graceful cancellation for the active agent session turn.

Deprecated: send a cancel control to /control instead.

POST /workspaces/{workspace_id}/agent/sessions/{session_id}/cancel

Error

A valid request URL is required to generate request examples

200

{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>"
}

Authorizations

APIKeyCookieServiceAccountApiKeyBearer

fastapiusersauth · string · cookie · required

Path Parameters

session_id · string<uuid> · required

workspace_id · string<uuid> · required

Body

application/json

Request schema for cancelling the active agent session turn.

reason · string · default: user_cancel

Allowed value: "user_cancel"

Response

200

application/json

Successful Response

Response schema for an accepted agent session cancellation request.

session_id · string<uuid> · required

run_id · string<uuid> · required

reason · string · required