jobs

Cancel Job

Cancel a job by its job_id.

This endpoint marks a job as cancelled, which will cause any associated agent execution to terminate as soon as possible.

patch/v1/jobs/{job_id}/cancel

Path parameters

job_idstring required

Successful Response

created_by_idstring nullable

The id of the user that made this object.

last_updated_by_idstring nullable

The id of the user that made this object.

created_atstring date-time

The unix timestamp of when the job was created.

updated_atstring date-time nullable

The timestamp when the object was last updated.

Status of the job.

completed_atstring date-time nullable

The unix timestamp of when the job was completed.

metadataobject nullable

The metadata of the job.

job_type'job' | 'run' | 'batch'

backgroundboolean nullable

Whether the job was created in background mode.

agent_idstring nullable

The agent associated with this job/run.

callback_urlstring nullable

If set, POST to this URL when the job completes.

callback_sent_atstring date-time nullable

Timestamp when the callback was last attempted.

callback_status_codeinteger nullable

HTTP status code returned by the callback endpoint.

callback_errorstring nullable

Optional error message from attempting to POST the callback endpoint.

ttft_nsinteger nullable

Time to first token for a run in nanoseconds

total_duration_nsinteger nullable

Total run duration in nanoseconds

idstring

The human-friendly ID of the Job

{
  "id": "job-123e4567-e89b-12d3-a456-426614174000"
}

Changed in 1 of the 36 revisions of this API.2