Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

pipelineId
string
required

Pipeline ID with prefix pl..

Pattern: ^pl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json
itemFilter
object

Filter selecting items to price. Defaults to the Start node's itemFilter.

itemLimit
integer

Maximum number of items to price. Defaults to the Start node's itemLimit, or all matching items if no limit is set.

Required range: x <= 9007199254740991

Response

Cost estimate

A forecast of pipeline cost for the current graph. Expected and maximum are forecasts; billing is pay-as-you-go.

dataset
object
required

Dataset and item count used for the forecast.

disclaimer
string
required

Explanation of the estimate assumptions and billing limitations.

graphVersion
string
required

The snapshot version expected to still be active. A stale version is rejected with HTTP 409.

Pattern: ^ple\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
nodes
object[]
required

Per-node cost forecasts, including nodes that cannot be priced.

total
object
required

Forecast costs for all priced nodes.