client.projects.createToken()

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

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

const token = await client.projects.createToken({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  preset: "read"
});
console.log(token);

{
  "id": "pst.019a0000-0000-7000-8000-000000000001",
  "token": "<string>",
  "expiresAt": "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 token = await client.projects.createToken({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  preset: "read"
});
console.log(token);

{
  "id": "pst.019a0000-0000-7000-8000-000000000001",
  "token": "<string>",
  "expiresAt": "2026-01-01T00:00:00Z"
}

Send a permission preset or explicit permissions to create a token limited to this project and any listed projectIds. Send the returned token in the X-Scoped-Token header. Tokens last at most six hours and cannot issue other tokens.

Signature

Method signature on client.projects:

createToken(args: {
  projectId: string;
  preset: "write" | "read" | "deploy" | "labeling-read" | "labeling-write" | "labeling-deploy";
  projectIds?: string[];
  expiresInSeconds?: number;
} | {
  projectId: string;
  permissions: string[];
  projectIds?: string[];
  expiresInSeconds?: number;
}): Promise<ScopedToken>;

Parameters

Pass one of the argument shapes shown in the signature.

string

required

Project ID with prefix pp..

A named permission set: read (Read everything), write (Read, write and decide customer reviews; cannot launch runs), deploy (Read, write, decide customer reviews and launch runs that spend money), labeling-read (Data labeling: read), labeling-write (Data labeling: read, write and decide customer reviews; cannot launch pipelines), labeling-deploy (Data labeling: read, write, decide customer reviews and launch pipelines that spend money).

string[]

Further projects the token may act in; the project in the path is always included. All projects must belong to the same team.

number

Token lifetime in seconds, from 60 to 21600; defaults to 21600.

string[]

Explicit resource:operation permissions.

Returns

Promise<ScopedToken>

string

required

Public handle of the token; use it to revoke without holding the secret.

string

required

The access token. Returned only when created; save it before closing the response.

string

required

When the token stops working.

Errors

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

Status	Description
403	Your team does not allow one of the requested permissions
404	Project not found
429	Rate limit exceeded, or you already hold 1000 live tokens for one of the projects; revoke unused tokens first

HTTP endpoint: POST /projects/{projectId}/tokens.

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

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

const token = await client.projects.createToken({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  preset: "read"
});
console.log(token);

{
  "id": "pst.019a0000-0000-7000-8000-000000000001",
  "token": "<string>",
  "expiresAt": "2026-01-01T00:00:00Z"
}

Reference

TypeScript SDK

CLI

HTTP API

client.projects.createToken()

Signature

Parameters

Returns

Errors