client.runs.get()

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

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

const run = await client.runs.get({
  runId: "plr.019a0000-0000-7000-8000-000000000001"
});
console.log(run);

{
  "id": "plr.019a0000-0000-7000-8000-000000000001",
  "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
  "status": "pending",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": null,
  "result": {
    "total": 0,
    "completed": 0,
    "failed": 0,
    "canceled": 0,
    "paused": 0
  }
}

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

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

const run = await client.runs.get({
  runId: "plr.019a0000-0000-7000-8000-000000000001"
});
console.log(run);

{
  "id": "plr.019a0000-0000-7000-8000-000000000001",
  "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
  "status": "pending",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": null,
  "result": {
    "total": 0,
    "completed": 0,
    "failed": 0,
    "canceled": 0,
    "paused": 0
  }
}

Return run status, item counts, and any error. Poll until status is succeeded or failed. A canceled run reports failed with Run canceled.

Signature

Method signature on client.runs:

get(args: {
  runId: string;
}): Promise<RunJob>;

Parameters

string

required

Pipeline run ID with prefix plr..

Returns

Promise<RunJob> A pipeline run job. Poll until status is succeeded or failed.

RunId

required

Pipeline run ID with prefix plr..

DatasetId

required

Dataset ID with prefix ds..

"pending" | "running" | "succeeded" | "failed"

required

Run state: pending before deployment, running while processing, succeeded when processing ends, or failed if deployment fails; individual item failures are counted in result.

string

required

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

string | null

required

Deployment failure message, or null when the run deployed successfully.

RunStats

required

Counts of items and their current outcomes.

Show Fields

number

required

Total number of items in this run.

number

required

Number of items that completed successfully.

number

required

Number of items that failed.

number

required

Number of items that were canceled.

number

required

Number of items currently paused.

Errors

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

Status	Description
404	Run not found
429	Rate limit exceeded

HTTP endpoint: GET /runs/{runId}.

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

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

const run = await client.runs.get({
  runId: "plr.019a0000-0000-7000-8000-000000000001"
});
console.log(run);

{
  "id": "plr.019a0000-0000-7000-8000-000000000001",
  "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
  "status": "pending",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": null,
  "result": {
    "total": 0,
    "completed": 0,
    "failed": 0,
    "canceled": 0,
    "paused": 0
  }
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors