client.runs.cancel()

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.cancel({
  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.cancel({
  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
  }
}

Stop processing remaining items and return the current run state. Completed items are retained. Poll until the run reports failed with Run canceled. pendingHumanQa defaults to wait_for_review; reviews can finish after cancellation. After 14 days on the node, eligible waiting items are accepted and charged. Set accept_without_review to accept eligible waiting items immediately. Returns 409 before deployment or once cancellation or finalization has started.

Signature

Method signature on client.runs:

cancel(args: {
  runId: string;
  pendingHumanQa?: "accept_without_review" | "wait_for_review";
}): Promise<RunJob>;

Parameters

string

required

Pipeline run ID with prefix plr..

"accept_without_review" | "wait_for_review"

How to handle items waiting for Human QA. wait_for_review (default) keeps them waiting; after 14 days on the node, eligible items are accepted without review. accept_without_review accepts eligible waiting items now. Items rejected by LLM QA or already under review are excluded. Accepted items are charged as completed items.

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
409	Run cannot be canceled (not yet deployed, or already canceling/finished)
429	Rate limit exceeded

HTTP endpoint: POST /runs/{runId}/cancel.

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.cancel({
  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