client.runs.getItem()

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

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

const item = await client.runs.getItem({
  runId: "plr.019a0000-0000-7000-8000-000000000001",
  itemId: "plri.019a0000-0000-7000-8000-000000000001"
});
console.log(item);

{
  "id": "plri.019a0000-0000-7000-8000-000000000001",
  "runId": "plr.019a0000-0000-7000-8000-000000000001",
  "datasetItemId": "di.019a0000-0000-7000-8000-000000000001",
  "index": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "state": {
    "status": "idle",
    "startedAt": null,
    "finishedAt": null,
    "input": null,
    "output": null,
    "partialOutput": null
  }
}

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

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

const item = await client.runs.getItem({
  runId: "plr.019a0000-0000-7000-8000-000000000001",
  itemId: "plri.019a0000-0000-7000-8000-000000000001"
});
console.log(item);

{
  "id": "plri.019a0000-0000-7000-8000-000000000001",
  "runId": "plr.019a0000-0000-7000-8000-000000000001",
  "datasetItemId": "di.019a0000-0000-7000-8000-000000000001",
  "index": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "state": {
    "status": "idle",
    "startedAt": null,
    "finishedAt": null,
    "input": null,
    "output": null,
    "partialOutput": null
  }
}

Return the item status and references to input, output, and partial output field revisions. Returns 404 if the item does not belong to this run.

Signature

Method signature on client.runs:

getItem(args: {
  runId: string;
  itemId: string;
}): Promise<RunItem>;

Parameters

string

required

Pipeline run ID with prefix plr..

string

required

Run item ID with prefix plri..

Returns

Promise<RunItem> One item processed by a pipeline run.

RunItemId

required

Run item ID with prefix plri..

RunId

required

Pipeline run ID with prefix plr..

DatasetItemId

required

Dataset item ID with prefix di..

number

required

Index of this item within the run.

string

required

Time the run item was created, as an ISO 8601 timestamp.

string

required

Time the run item was last updated, as an ISO 8601 timestamp.

RunItemState

required

The current state and pipeline-level input, output and partial output revision references for a run item.

Show Fields

required

Item state: idle before processing, in_progress while processing, completed, failed, canceled, or paused.

string | null

required

Time processing started, as an ISO 8601 timestamp, or null before it starts.

string | null

required

Time processing ended, as an ISO 8601 timestamp, or null while unfinished.

string | null

Failure message when available; absent or null when no failure message is recorded.

object | null

required

Input field revision IDs selected for this item, or null before inputs are available.

Show Fields

object

required

Dataset field revision IDs keyed by the field IDs used in the pipeline graph.

object | null

required

The End field revisions of a completed item. Null for other statuses.

Show Fields

object

required

Dataset field revision IDs keyed by the field IDs used in the pipeline graph.

object | null

required

For a canceled item, revisions of End-node fields with values at cancellation, including fields passed through from the input. Null for other statuses or when no node wrote an End-node field.

Show Fields

object

required

Dataset field revision IDs keyed by the field IDs used in the pipeline graph.

Errors

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

Status	Description
404	Run item not found
429	Rate limit exceeded

HTTP endpoint: GET /runs/{runId}/items/{itemId}.

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

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

const item = await client.runs.getItem({
  runId: "plr.019a0000-0000-7000-8000-000000000001",
  itemId: "plri.019a0000-0000-7000-8000-000000000001"
});
console.log(item);

{
  "id": "plri.019a0000-0000-7000-8000-000000000001",
  "runId": "plr.019a0000-0000-7000-8000-000000000001",
  "datasetItemId": "di.019a0000-0000-7000-8000-000000000001",
  "index": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "state": {
    "status": "idle",
    "startedAt": null,
    "finishedAt": null,
    "input": null,
    "output": null,
    "partialOutput": null
  }
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors