client.pipelines.estimateCost()

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const estimate = await client.pipelines.estimateCost({
  pipelineId: "pl.019a0000-0000-7000-8000-000000000001",
  itemLimit: 100
});
console.log(estimate);

{
  "dataset": {
    "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
    "itemCount": 0
  },
  "total": {
    "expected": "<string>",
    "worstCase": "<string>",
    "perItemExpected": null,
    "perItemWorstCase": null
  },
  "disclaimer": "<string>",
  "nodes": [
    {
      "nodeId": "<string>",
      "nodeType": "root",
      "nodeNameDisplay": "<string>",
      "expectedItems": 0,
      "kind": "non-priced"
    }
  ],
  "graphVersion": "ple.019a0000-0000-7000-8000-000000000001"
}

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const estimate = await client.pipelines.estimateCost({
  pipelineId: "pl.019a0000-0000-7000-8000-000000000001",
  itemLimit: 100
});
console.log(estimate);

{
  "dataset": {
    "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
    "itemCount": 0
  },
  "total": {
    "expected": "<string>",
    "worstCase": "<string>",
    "perItemExpected": null,
    "perItemWorstCase": null
  },
  "disclaimer": "<string>",
  "nodes": [
    {
      "nodeId": "<string>",
      "nodeType": "root",
      "nodeNameDisplay": "<string>",
      "expectedItems": 0,
      "kind": "non-priced"
    }
  ],
  "graphVersion": "ple.019a0000-0000-7000-8000-000000000001"
}

Return expected and maximum costs for the current graph and attached dataset. Optional itemLimit and itemFilter override the Start node settings for this estimate. No run is started.

Signature

Method signature on client.pipelines:

estimateCost(args: {
  pipelineId: string;
  itemLimit?: number;
  itemFilter?: DatasetItemFilter;
}): Promise<PipelineCostEstimate>;

Parameters

string

required

Pipeline ID with prefix pl..

number

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

DatasetItemFilter

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

Show Fields

DatasetFieldValueConditions

Field-value conditions that selected rows must satisfy; defaults to no conditions.See the HTTP endpoint for the complete schema.

DatasetFieldSourceConditions

Field-author conditions that selected rows must satisfy; defaults to no conditions.See the HTTP endpoint for the complete schema.

string[]

Field IDs with prefix df. that must have no revision on a selected row; defaults to an empty array.

DatasetSliceSelection

Slice whose frozen rows and fields to read; omit to use live dataset rows.

Show Fields

string

required

Dataset slice ID with prefix dsl..

DatasetSplitPartInclusion

Split parts to include; omit to include every part.

Show Fields

string

required

Split field ID with prefix df..

string[]

required

Names of the split parts to select.See the HTTP endpoint for the complete schema.

DatasetSplitPartExclusions

Split-part selections to exclude; omit when no parts should be excluded.See the HTTP endpoint for the complete schema.

string

Cutoff for dataset items and field revisions, as an ISO 8601 timestamp; omit to use the endpoint’s cutoff.

Returns

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

object

required

Dataset and item count used for the forecast.

Show Fields

string

required

Dataset ID with prefix ds. being priced.

number

required

Number of matching dataset items included in the forecast.

object

required

Forecast costs for all priced nodes.

Show Fields

string

required

Expected pipeline cost in US dollars, formatted with a currency symbol.

string

required

Maximum forecast pipeline cost in US dollars, formatted with a currency symbol.

string | null

default:"null"

Minimum forecast pipeline cost in US dollars with a currency symbol, or null when unavailable.

string | null

required

Expected cost per input item in US dollars with a currency symbol, or null when no items are selected.

string | null

required

Maximum forecast cost per input item in US dollars with a currency symbol, or null when no items are selected.

string

required

Explanation of the estimate assumptions and billing limitations.

object[]

required

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

Show kind: "non-priced"

string

required

Identifier of the pipeline node being priced.

"root" | "code" | "generation_sft" | "match" | "quorum_sft"

required

Type of node being priced.

string

required

Display name of the node.

number

required

Expected number of items reaching this node.

"non-priced"

required

Estimate kind: non-priced for nodes without charges, validation-errors when configuration prevents pricing, or priced when a forecast is available.

Show kind: "validation-errors"

string

required

Identifier of the pipeline node being priced.

"root" | "code" | "generation_sft" | "match" | "quorum_sft"

required

Type of node being priced.

string

required

Display name of the node.

number

required

Expected number of items reaching this node.

"validation-errors"

required

Estimate kind: non-priced for nodes without charges, validation-errors when configuration prevents pricing, or priced when a forecast is available.

Show kind: "priced"

string

required

Identifier of the pipeline node being priced.

"root" | "code" | "generation_sft" | "match" | "quorum_sft"

required

Type of node being priced.

string

required

Display name of the node.

number

required

Expected number of items reaching this node.

"priced"

required

Estimate kind: non-priced for nodes without charges, validation-errors when configuration prevents pricing, or priced when a forecast is available.

object

required

Summary of the quantities and assumptions used for this node.See the HTTP endpoint for the complete schema.

string

required

Expected node cost in US dollars, formatted with a currency symbol.

string

required

Maximum forecast node cost in US dollars, formatted with a currency symbol.

string | null

required

Expected cost per item in US dollars with a currency symbol, or null when there are no items to price.

CostBreakdownLine[]

required

Cost lines and nested calculations for this node.See the HTTP endpoint for the complete schema.

string

Pricing warning; absent when no warning applies.

PipelineGraphVersion

required

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

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses:

Status	Description
400	Pipeline has no dataset attached or the graph is missing a root node
404	Pipeline not found
429	Rate limit exceeded

HTTP endpoint: POST /pipelines/{pipelineId}/cost-estimate.

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const estimate = await client.pipelines.estimateCost({
  pipelineId: "pl.019a0000-0000-7000-8000-000000000001",
  itemLimit: 100
});
console.log(estimate);

{
  "dataset": {
    "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
    "itemCount": 0
  },
  "total": {
    "expected": "<string>",
    "worstCase": "<string>",
    "perItemExpected": null,
    "perItemWorstCase": null
  },
  "disclaimer": "<string>",
  "nodes": [
    {
      "nodeId": "<string>",
      "nodeType": "root",
      "nodeNameDisplay": "<string>",
      "expectedItems": 0,
      "kind": "non-priced"
    }
  ],
  "graphVersion": "ple.019a0000-0000-7000-8000-000000000001"
}

Reference

TypeScript SDK

CLI

HTTP API

client.pipelines.estimateCost()

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors