client.datasets.getSlice()

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

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

const slice = await client.datasets.getSlice({
  sliceId: "dsl.019a0000-0000-7000-8000-000000000001"
});
console.log(slice);

{
  "id": "dsl.019a0000-0000-7000-8000-000000000001",
  "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "itemFilter": null,
  "frozenFieldIds": [
    "df.019a0000-0000-7000-8000-000000000001"
  ],
  "fromSliceId": null,
  "status": "creating",
  "rows": 0,
  "error": null,
  "cutoff": "2026-01-01T00:00:00Z",
  "createdAt": "2026-01-01T00:00:00Z"
}

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

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

const slice = await client.datasets.getSlice({
  sliceId: "dsl.019a0000-0000-7000-8000-000000000001"
});
console.log(slice);

{
  "id": "dsl.019a0000-0000-7000-8000-000000000001",
  "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "itemFilter": null,
  "frozenFieldIds": [
    "df.019a0000-0000-7000-8000-000000000001"
  ],
  "fromSliceId": null,
  "status": "creating",
  "rows": 0,
  "error": null,
  "cutoff": "2026-01-01T00:00:00Z",
  "createdAt": "2026-01-01T00:00:00Z"
}

Poll a slice while it is being created; read its row count once it is ready.

Signature

Method signature on client.datasets:

getSlice(args: {
  sliceId: string;
}): Promise<DatasetSlice>;

Parameters

string

required

ID of the dataset slice, with prefix dsl..

Returns

Promise<DatasetSlice>

string

required

Slice id. The same id always selects the same rows with the same frozen values.

string

required

ID of the dataset containing this slice, with prefix ds..

string

required

The name that tells this slice apart.

object | null

required

The filter the rows matched when the slice was taken; null for every row.

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.

string[]

required

Fields the slice reads as they were at its cutoff. Other fields read live.

string | null

required

The slice this one was taken from, if any.

"creating" | "ready" | "failed"

required

Only a ready slice can select rows.

number

required

Rows in the slice once it is ready; 0 until then.

object | null

required

Why the slice failed.

Show Fields

"no_rows" | "cutoff_not_settled"

required

Machine-readable reason the slice could not be created.

string

required

Explanation of the slice creation failure.

string

required

The moment the slice was taken: its rows and its frozen fields are read as they were just before it.

string

required

When the slice was requested.

Errors

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

Status	Description
404	Slice not found
429	Rate limit exceeded

HTTP endpoint: GET /slices/{sliceId}.

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

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

const slice = await client.datasets.getSlice({
  sliceId: "dsl.019a0000-0000-7000-8000-000000000001"
});
console.log(slice);

{
  "id": "dsl.019a0000-0000-7000-8000-000000000001",
  "datasetId": "ds.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "itemFilter": null,
  "frozenFieldIds": [
    "df.019a0000-0000-7000-8000-000000000001"
  ],
  "fromSliceId": null,
  "status": "creating",
  "rows": 0,
  "error": null,
  "cutoff": "2026-01-01T00:00:00Z",
  "createdAt": "2026-01-01T00:00:00Z"
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors