createClient

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

const apiKey = process.env.TOLOKA_API_KEY;
if (!apiKey) throw new Error("Set TOLOKA_API_KEY");

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

const me = await client.me();
console.log(me.id, me.email);

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

const apiKey = process.env.TOLOKA_API_KEY;
if (!apiKey) throw new Error("Set TOLOKA_API_KEY");

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

const me = await client.me();
console.log(me.id, me.email);

import type { ClientConfig, PotatoClient } from "@toloka-platform/sdk";

declare function createClient(config: ClientConfig): PotatoClient;

Parameters

ClientConfig

required

The platform URL and exactly one credential.

Show Configuration

string

required

Absolute platform URL, usually https://platform.toloka.ai. Path prefixes are preserved. Do not append /api/v2-beta.

string

Sends Authorization: ApiKey <key>. A value starting with pst_ sends X-Scoped-Token instead. Mutually exclusive with the other credentials.

string

Sends X-Scoped-Token: <token>. Mutually exclusive with the other credentials.

() => Promise<string>

Called for each SDK request. Sends the returned value as Authorization: Bearer <token>. Mutually exclusive with the other credentials.

typeof globalThis.fetch

default:"globalThis.fetch"

Custom fetch implementation, for example to inspect response headers.

Returns

PotatoClient

A client with typed resource methods and waitFor. Construction makes no request. See the client method index for operations and waitFor for polling.

Throws

Throws a local error for an empty base URL, an invalid absolute URL, or an empty API key or scoped token. It does not verify credentials against the platform during construction. See client and credentials for token management, request bodies, and rate limits.

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

const apiKey = process.env.TOLOKA_API_KEY;
if (!apiKey) throw new Error("Set TOLOKA_API_KEY");

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

const me = await client.me();
console.log(me.id, me.email);

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Returns

Throws