Cancel a job
Stops a copilot reply or a note generation, the two jobs the app has a Stop button for. A stopped copilot reply ends as cancelled. A stopped note generation keeps the sections it already wrote: it finishes as succeeded with result.stopped true, or as cancelled when nothing was written. A stopped job still counts as an AI use. cancelled is false when the job had already finished.
Required scopes: copilot:use or generation:start
In: header
Path Parameters
Job id, scoped to the key's user.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.
^[\x21-\x7E]{1,255}$1 <= length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"{ "data": { "id": "7d6c5b4a-3f2e-4d1c-8b0a-9f8e7d6c5b4a", "cancelled": true }}