NDNCI Docs
API v1API reference

Cancel a job

Request cancellation within the selected workspace. Work already accepted by an external provider may still incur a charge.

POST/v1/jobs/{jobId}/cancel

Authorization

bearerKey
AuthorizationBearer <token>

A scoped automation key authorized for the REST API.

In: header

Path Parameters

jobId*string
Formatuuid

Header Parameters

X-Ndnci-Workspace*string

Select a workspace explicitly included in this access grant.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <NDNCI_API_KEY>"
{  "success": true,  "code": "PUBLIC_JOBS_CANCEL",  "message": "Successful response",  "data": {    "accepted": true  }}

Required scope: jobs:write · Usage points: 2

Credits are charged separately for work that consumes paid services.

Retrieve complete job output GET

Retrieve complete authorized result JSON in ordered fragments of at most 8192 UTF-8 bytes, including large text, Sprite exports and fresh owned asset links. Concatenate fragments and parse the completed JSON document; cursors expire after 30 minutes and remain bound to the same job, workspace, access grant and immutable result. The complete public result is limited to 16 MiB.

Retry a job POST

Retry eligible failed work using its existing checkpoints and a new idempotency key. Authorization, available credits and budget ceilings are checked again.