TOtoksta
Jobs

Cancel a running job

Cancel a running creator-discovery job. The {id} path parameter must be a plain UUID. A JSON body is required even when empty — send {} (sending no body returns 400 Request body must be valid JSON). Already-terminal jobs return canceled: false with a reason.

post/v1/jobs/{id}/cancel

Request

Path parameters

idstring required

Job UUID (plain, unprefixed).

Request body

object required

Empty object {} is valid.

Example request

{}

Response

Cancellation result.

successtrue required
dataobject required

Operation payload. See the example for the exact field structure.

Example response

{
  "success": true,
  "data": {
    "job": {
      "id": "56232ac2-8068-4dcb-9d1a-1f2e3a4b5c6d",
      "status": "canceled",
      "source_status": "cancelled",
      "canceled": true,
      "reason": "cancel_applied",
      "progress": {
        "total_items": 120,
        "completed_items": 40,
        "approved_items": 12,
        "failed_items": 28
      },
      "created_at": "2026-05-28T09:00:00Z",
      "updated_at": "2026-05-28T09:03:00Z",
      "completed_at": "2026-05-28T09:03:00Z",
      "result_expires_at": "2026-06-27T09:03:00Z",
      "result_retention_days": 30,
      "error_message": "Canceled via public API."
    }
  },
  "meta": {
    "request_id": "req_01HXYZ...",
    "trace_id": "4f1d...c2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.