client.pipelines.get()

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

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

const pipeline = await client.pipelines.get({
  pipelineId: "pl.019a0000-0000-7000-8000-000000000001"
});
console.log(pipeline);

{
  "id": "pl.019a0000-0000-7000-8000-000000000001",
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "version": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "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 pipeline = await client.pipelines.get({
  pipelineId: "pl.019a0000-0000-7000-8000-000000000001"
});
console.log(pipeline);

{
  "id": "pl.019a0000-0000-7000-8000-000000000001",
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "version": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

Return the pipeline name, project, version, and timestamps. Use the graph endpoint to read its configuration.

Signature

Method signature on client.pipelines:

get(args: {
  pipelineId: string;
}): Promise<Pipeline>;

Parameters

string

required

Pipeline ID with prefix pl..

Returns

Promise<Pipeline> A pipeline within a project.

PipelineId

required

Pipeline ID with prefix pl..

ProjectId

required

Project ID with prefix pp..

string

required

Name of the pipeline.

number

required

Pipeline version number; copying a pipeline increments the source version.

string

required

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

string

required

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

Errors

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

Status	Description
404	Pipeline not found
429	Rate limit exceeded

HTTP endpoint: GET /pipelines/{pipelineId}.

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

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

const pipeline = await client.pipelines.get({
  pipelineId: "pl.019a0000-0000-7000-8000-000000000001"
});
console.log(pipeline);

{
  "id": "pl.019a0000-0000-7000-8000-000000000001",
  "projectId": "pp.019a0000-0000-7000-8000-000000000001",
  "name": "<string>",
  "version": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors