NDNCI Docs
API v1API reference

Run a Tool operation

Execute a bounded, authorized operation. Immediate operations return a result; queued operations return an accepted job identifier. Send a stable idempotency key for safe retries.

POST/v1/runs

Authorization

bearerKey
AuthorizationBearer <token>

A scoped automation key authorized for the REST API.

In: header

Header Parameters

X-Ndnci-Workspace*string

Select a workspace explicitly included in this access grant.

Formatuuid
Idempotency-Key*string
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/runs" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: string" \  -H "Authorization: Bearer <NDNCI_API_KEY>" \  -H "Content-Type: application/json" \  -d '{    "operationId": "link.preview",    "input": {      "url": "https://example.org"    }  }'
{  "success": true,  "code": "PUBLIC_TOOLS_RUN",  "message": "Successful response",  "data": {    "kind": "result",    "result": {      "metadata": {        "title": "Example Domain",        "description": null,        "image": null,        "url": "https://example.org",        "siteName": null,        "favicon": null      }    },    "costMillicents": 0  }}

Required scope: tools:run · Usage points: Operation-specific; returned by the estimate

Credits are charged separately for work that consumes paid services.

Estimate an operation POST

Validate the operation input and return its estimated and maximum monetary cost before starting work. The estimate does not reserve credits.

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.