client.datasets.listAllFields()

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

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

for await (const item of client.datasets.listAllFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
})) {
  console.log(item);
}

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

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

const page = await client.datasets.listFieldsPage({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
});
console.log(page);

{
  "id": "df.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "description": null,
  "jsonSchema": {},
  "internal": false,
  "split": null,
  "operations": [
    {
      "type": "copy",
      "sourceFieldId": "df.019a0000-0000-7000-8000-000000000001",
      "blocking": false
    }
  ],
  "createdAt": "2026-01-01T00:00:00Z"
}

{
  "fields": [
    {
      "id": "df.019a0000-0000-7000-8000-000000000001",
      "name": "<string>",
      "description": null,
      "jsonSchema": {},
      "internal": false,
      "split": null,
      "operations": [
        {
          "type": "copy",
          "sourceFieldId": "df.019a0000-0000-7000-8000-000000000001",
          "blocking": false
        }
      ],
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

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

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

for await (const item of client.datasets.listAllFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
})) {
  console.log(item);
}

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

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

const page = await client.datasets.listFieldsPage({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
});
console.log(page);

{
  "id": "df.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "description": null,
  "jsonSchema": {},
  "internal": false,
  "split": null,
  "operations": [
    {
      "type": "copy",
      "sourceFieldId": "df.019a0000-0000-7000-8000-000000000001",
      "blocking": false
    }
  ],
  "createdAt": "2026-01-01T00:00:00Z"
}

{
  "fields": [
    {
      "id": "df.019a0000-0000-7000-8000-000000000001",
      "name": "<string>",
      "description": null,
      "jsonSchema": {},
      "internal": false,
      "split": null,
      "operations": [
        {
          "type": "copy",
          "sourceFieldId": "df.019a0000-0000-7000-8000-000000000001",
          "blocking": false
        }
      ],
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Return field definitions, split status, and active write operations. Omit names for all fields, or send a comma-separated list of field names. The listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.

Signature

Method signatures on client.datasets:

listAllFields(args: {
  datasetId: string;
  limit?: number;
  offset?: number;
  names?: string;
}): AsyncGenerator<DatasetField>;

listFieldsPage(args: {
  datasetId: string;
  limit?: number;
  offset?: number;
  names?: string;
}): Promise<{ fields: DatasetField[]; pagination: Pagination }>;

Parameters

listAllFields()

string

required

Dataset ID with prefix ds..

number

default:"20"

Maximum number of results to return; defaults to 20.

number

default:"0"

Number of results to skip before this page; defaults to 0.

string

Comma-separated field names to include; omit to list all fields.

listFieldsPage()

string

required

Dataset ID with prefix ds..

number

default:"20"

Maximum number of results to return; defaults to 20.

number

default:"0"

Number of results to skip before this page; defaults to 0.

string

Comma-separated field names to include; omit to list all fields.

Returns

listAllFields() result

AsyncGenerator<DatasetField> Yields one item at a time. The fields below describe each yielded item. A field of a dataset.

DatasetFieldId

required

Dataset field ID with prefix df..

string

required

Name of the dataset field.

string | null

required

Description of the field, or null when none is set.

JsonSchema

required

JSON Schema that values in this field must satisfy.See the HTTP endpoint for the supported JSON Schema fields.

boolean

required

True when this field is excluded from pipeline input bindings. The field is still included in dataset field responses.

object | null

required

Set when this is a split field: each row’s value names its part.

Show Fields

object[]

required

The parts, with their roles: trainings learn on train parts and validate on validate parts. Test parts are held out for evaluations: no training learns on them, and only a training on this field validates on a part that has both the validate and test roles.See the HTTP endpoint for the complete schema.

object | null

required

How the next fill samples parts; null for an adopted field until a fill gives it shares.

Show Fields

object[]

required

Target proportion of rows for each split part.See the HTTP endpoint for the complete schema.

string | null

required

Field ID with prefix df. used to balance labels, or null when balancing is disabled.

number

required

Seed used to make the part assignments repeatable.

"filling" | "ready" | "failed"

required

A slice cannot be taken while the field is filling.

object | null

required

Rows placed so far while the field is filling.

Show Fields

number

required

Number of previously unassigned rows placed so far.

number

required

Number of rows to place in this fill.

object | null

required

The last fill: rows it placed, rows that already had a part, and the rows each part held after it.

Show Fields

number

required

Number of previously unassigned rows placed by the last fill.

number

required

Number of rows whose existing part assignments were kept.

object

required

Row counts for each part after the last fill, keyed by part name.

object | null

required

Why the last fill failed.

Show Fields

"too_many_labels" | "slice_failed"

required

Machine-readable reason the split fill failed.

string

required

Explanation of the split fill failure.

DatasetFieldOperation[]

required

Operations currently writing to this field. A split or slice that reads the field is rejected while a blocking operation runs.

Show type: "copy"

"copy"

required

Operation kind: copy copies field values, split_fill assigns split parts, and write writes new field revisions.

DatasetFieldId

required

The field the values are copied from.

boolean

required

True when splits and slices that read this field must wait for the operation to finish.

Show type: "split_fill"

"split_fill"

required

Operation kind: copy copies field values, split_fill assigns split parts, and write writes new field revisions.

boolean

required

True when splits and slices that read this field must wait for the operation to finish.

Show type: "write"

"write"

required

Operation kind: copy copies field values, split_fill assigns split parts, and write writes new field revisions.

string

required

The source of the new field revisions. For a batch inference run, this is batch-inference-run:<id>.

object | null

required

The number of rows written and the total number expected, when known.See the HTTP endpoint for the complete schema.

boolean

required

True when splits and slices that read this field must wait for the operation to finish.

string

required

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

listFieldsPage() result

Promise<{ fields: DatasetField[]; pagination: Pagination }>

DatasetField[]

required

Nested fields inferred from the first validated dataset upload.

Show Fields

DatasetFieldId

required

Dataset field ID with prefix df..

string

required

Name of the dataset field.

string | null

required

Description of the field, or null when none is set.

JsonSchema

required

JSON Schema that values in this field must satisfy.See the HTTP endpoint for the supported JSON Schema fields.

boolean

required

True when this field is excluded from pipeline input bindings. The field is still included in dataset field responses.

object | null

required

Set when this is a split field: each row’s value names its part.See the HTTP endpoint for the complete schema.

DatasetFieldOperation[]

required

Operations currently writing to this field. A split or slice that reads the field is rejected while a blocking operation runs.See the HTTP endpoint for the complete schema.

string

required

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

Pagination

required

Pagination information for this page.

Show Fields

number

required

Total number of matching results.

number

required

Maximum number of results requested for this page.

number

required

Number of results skipped before this page.

boolean

required

Whether more matching results follow this page.

Errors

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

Status	Description
404	Dataset not found
429	Rate limit exceeded

HTTP endpoint: GET /datasets/{datasetId}/fields.

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

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

for await (const item of client.datasets.listAllFields({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
})) {
  console.log(item);
}

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

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

const page = await client.datasets.listFieldsPage({
  datasetId: "ds.019a0000-0000-7000-8000-000000000001"
});
console.log(page);

{
  "id": "df.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "description": null,
  "jsonSchema": {},
  "internal": false,
  "split": null,
  "operations": [
    {
      "type": "copy",
      "sourceFieldId": "df.019a0000-0000-7000-8000-000000000001",
      "blocking": false
    }
  ],
  "createdAt": "2026-01-01T00:00:00Z"
}

{
  "fields": [
    {
      "id": "df.019a0000-0000-7000-8000-000000000001",
      "name": "<string>",
      "description": null,
      "jsonSchema": {},
      "internal": false,
      "split": null,
      "operations": [
        {
          "type": "copy",
          "sourceFieldId": "df.019a0000-0000-7000-8000-000000000001",
          "blocking": false
        }
      ],
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Reference

TypeScript SDK

CLI

HTTP API

client.datasets.listAllFields()

Signature

Parameters

listAllFields()

listFieldsPage()

Returns

listAllFields() result

listFieldsPage() result

Errors

​Signature

​Parameters

​listAllFields()

​listFieldsPage()

​Returns

​listAllFields() result

​listFieldsPage() result

​Errors

Signature

Parameters

listAllFields()

listFieldsPage()

Returns

listAllFields() result

listFieldsPage() result

Errors