NDNCI Docs
API v1API reference

Read a job

Retrieve one job in the selected workspace with a bounded inline output projection. If output.omittedFields is present, use the complete output endpoint to retrieve all public results and fresh owned file URLs.

GET/v1/jobs/{jobId}

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 GET "https://example.com/v1/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <NDNCI_API_KEY>"
{  "success": true,  "code": "PUBLIC_JOBS_GET",  "message": "Successful response",  "data": {    "id": "123e4567-e89b-42d3-a456-426614174002",    "workspaceId": "123e4567-e89b-42d3-a456-426614174001",    "toolSlug": "ai-image-generator",    "status": "completed",    "executionOrigin": "api",    "progress": {      "percentage": 100    },    "output": {      "metadata": {        "title": "Example Domain",        "url": "https://example.org"      }    },    "costMillicents": 0,    "maximumCostMillicents": 0,    "errorCode": null,    "createdAt": "2026-10-01T12:00:00Z",    "startedAt": "2026-10-01T12:00:01Z",    "completedAt": "2026-10-01T12:00:02Z"  }}

Required scope: jobs:read · Usage points: 1

Credits are charged separately for work that consumes paid services.

List workspace jobs GET

Read a bounded, cursor-paginated page of job metadata in the selected workspace, including status and execution origin. Use an individual job snapshot or the complete output endpoint to retrieve results.

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.