NDNCI Docs
API v1API reference

Estimate an operation

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

POST/v1/estimates

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

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

curl -X POST "https://example.com/v1/estimates" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -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_ESTIMATE",  "message": "Successful response",  "data": {    "operationId": "link.preview",    "estimatedCostMillicents": 0,    "maximumCostMillicents": 0,    "usagePoints": 4  }}

Required scope: tools:run · Usage points: 4

Credits are charged separately for work that consumes paid services.

Discover available Tool operations GET

List the server operations authorized for the selected workspace and access grant, including their input contracts and execution mode.

Run a Tool operation POST

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.