NAnace
public-api

Cancel Job

Cancel a pending/running job.

Cancellation surfaces as status=failed with error.code=cancelled (there is no separate cancelled status). Idempotent: cancelling an already-terminal job returns its current state unchanged.

post/api/v1/jobs/{job_id}/cancel

Request

Path parameters

job_idstring uuid required

Response

Successful Response

job_idstring uuid required
actionstring required

One of parse/ground/categorize/extract.

statusstring required

One of pending/running/succeeded/failed.

is_exampleboolean

True for provisioned Playground example jobs.

created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
credits_usedinteger nullable

Credits charged to this job per the ledger. 0 for failed/cancelled jobs (never charged) and zero-credit example jobs; null while the job is non-terminal (not counted yet) or for a succeeded job predating the ledger.

Changes

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