NDNCI Docs
API v1API reference

Follow job updates

Receive bounded server-sent job updates for one authorized workspace job. Available with Pro; reconnect and read the job when an event gap is detected.

GET/v1/jobs/{jobId}/stream

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

text/event-stream

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/stream" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <NDNCI_API_KEY>"
"event: job\ndata: {\"success\":true,\"code\":\"PUBLIC_JOBS_STREAM\",\"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\"}}\n\n"

Required scope: jobs:read · Usage points: 3

Credits are charged separately for work that consumes paid services.

Server-sent events use the response schema as the JSON data of each event.

Create a download URL GET

Retrieve a temporary authorized download URL for one workspace media item. Treat the URL as a secret until it expires.

Read usage and budget limits GET

Return weighted usage counters, reset times, financial budget reservations and stream availability for the selected workspace.