client.models.listAll()

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.models.listAll({
  projectId: "pp.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.models.listPage({
  projectId: "pp.019a0000-0000-7000-8000-000000000001"
});
console.log(page);

{
  "id": "mdl.019a0000-0000-7000-8000-000000000001",
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "description": null,
  "baseModelId": "qwen3-4b",
  "archivedAt": null,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "models": [
    {
      "id": "mdl.019a0000-0000-7000-8000-000000000001",
      "projectId": "pp.019a0000-0000-7000-8000-000000000001",
      "name": "<string>",
      "description": null,
      "baseModelId": "qwen3-4b",
      "archivedAt": null,
      "createdAt": "2026-01-01T00:00:00Z",
      "updatedAt": "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.models.listAll({
  projectId: "pp.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.models.listPage({
  projectId: "pp.019a0000-0000-7000-8000-000000000001"
});
console.log(page);

{
  "id": "mdl.019a0000-0000-7000-8000-000000000001",
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "description": null,
  "baseModelId": "qwen3-4b",
  "archivedAt": null,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "models": [
    {
      "id": "mdl.019a0000-0000-7000-8000-000000000001",
      "projectId": "pp.019a0000-0000-7000-8000-000000000001",
      "name": "<string>",
      "description": null,
      "baseModelId": "qwen3-4b",
      "archivedAt": null,
      "createdAt": "2026-01-01T00:00:00Z",
      "updatedAt": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Return a page of non-archived models in the project, with pagination metadata. The listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.

Signature

Method signatures on client.models:

listAll(args: {
  projectId: string;
  limit?: number;
  offset?: number;
}): AsyncGenerator<Model>;

listPage(args: {
  projectId: string;
  limit?: number;
  offset?: number;
}): Promise<{ models: Model[]; pagination: Pagination }>;

Parameters

listAll()

string

required

Project ID with prefix pp..

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.

listPage()

string

required

Project ID with prefix pp..

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.

Returns

listAll() result

AsyncGenerator<Model> Yields one item at a time. The fields below describe each yielded item. A project-owned logical Model containing immutable versions.

ModelId

required

Model ID with prefix mdl..

ProjectId

required

Project ID with prefix pp..

string

required

Name of the model.

string | null

required

Description of the model, or null when none was provided.

BaseModelId

required

The stable product identifier of a catalog base model.

string | null

required

Time the model was archived, as an ISO 8601 timestamp, or null while it is active.

string

required

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

string

required

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

listPage() result

Promise<{ models: Model[]; pagination: Pagination }>

Model[]

required

Models in this page.

Show Fields

ModelId

required

Model ID with prefix mdl..

ProjectId

required

Project ID with prefix pp..

string

required

Name of the model.

string | null

required

Description of the model, or null when none was provided.

BaseModelId

required

The stable product identifier of a catalog base model.

string | null

required

Time the model was archived, as an ISO 8601 timestamp, or null while it is active.

string

required

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

string

required

Time the model was last updated, 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	Project not found
429	Rate limit exceeded

HTTP endpoint: GET /projects/{projectId}/models.

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.models.listAll({
  projectId: "pp.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.models.listPage({
  projectId: "pp.019a0000-0000-7000-8000-000000000001"
});
console.log(page);

{
  "id": "mdl.019a0000-0000-7000-8000-000000000001",
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "description": null,
  "baseModelId": "qwen3-4b",
  "archivedAt": null,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

{
  "models": [
    {
      "id": "mdl.019a0000-0000-7000-8000-000000000001",
      "projectId": "pp.019a0000-0000-7000-8000-000000000001",
      "name": "<string>",
      "description": null,
      "baseModelId": "qwen3-4b",
      "archivedAt": null,
      "createdAt": "2026-01-01T00:00:00Z",
      "updatedAt": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

listAll()

listPage()

Returns

listAll() result

listPage() result

Errors

​Signature

​Parameters

​listAll()

​listPage()

​Returns

​listAll() result

​listPage() result

​Errors

Signature

Parameters

listAll()

listPage()

Returns

listAll() result

listPage() result

Errors