client.me()

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

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

const user = await client.me();
console.log(user);

{
  "id": "<string>",
  "email": null,
  "teams": [
    {
      "id": "<string>",
      "writable": false
    }
  ]
}

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

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

const user = await client.me();
console.log(user);

{
  "id": "<string>",
  "email": null,
  "teams": [
    {
      "id": "<string>",
      "writable": false
    }
  ]
}

Return the API key owner’s user id, email, and teams with their write access. Pass a writable team’s id as teamId when creating a project.

Signature

Method signature on client:

me(): Promise<CurrentUser>;

Parameters

This method takes no arguments.

Returns

Promise<CurrentUser> The authenticated API key owner.

string

required

The platform user id of the API key owner.

string | null

required

The email of the API key owner, if known.

object[]

required

The teams the API key owner belongs to, excluding blocked ones.

Show Fields

string

required

The team id to pass as teamId when creating a project.

boolean

required

False when the API key owner has read-only access to the team.

Errors

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

Status	Description
429	Rate limit exceeded

HTTP endpoint: GET /me.

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

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

const user = await client.me();
console.log(user);

{
  "id": "<string>",
  "email": null,
  "teams": [
    {
      "id": "<string>",
      "writable": false
    }
  ]
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors