client.pipelines.getGraph()

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

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

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

{
  "graph": {
    "version": 1,
    "fields": [
      {
        "id": "example",
        "name": "<string>",
        "jsonSchema": {}
      }
    ],
    "nodes": [
      {
        "id": "example",
        "type": "root",
        "settings": {
          "startedFieldProxies": {},
          "completedFieldProxies": {}
        }
      }
    ],
    "connections": [
      {
        "from": {
          "node": "example",
          "handle": "example"
        },
        "to": {
          "node": "example",
          "handle": "example"
        },
        "settings": {}
      }
    ]
  },
  "version": "ple.019a0000-0000-7000-8000-000000000001",
  "invalidFieldSchemas": [
    {
      "fieldId": "<string>",
      "text": "<string>",
      "reason": "<string>"
    }
  ]
}

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

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

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

{
  "graph": {
    "version": 1,
    "fields": [
      {
        "id": "example",
        "name": "<string>",
        "jsonSchema": {}
      }
    ],
    "nodes": [
      {
        "id": "example",
        "type": "root",
        "settings": {
          "startedFieldProxies": {},
          "completedFieldProxies": {}
        }
      }
    ],
    "connections": [
      {
        "from": {
          "node": "example",
          "handle": "example"
        },
        "to": {
          "node": "example",
          "handle": "example"
        },
        "settings": {}
      }
    ]
  },
  "version": "ple.019a0000-0000-7000-8000-000000000001",
  "invalidFieldSchemas": [
    {
      "fieldId": "<string>",
      "text": "<string>",
      "reason": "<string>"
    }
  ]
}

Return the current graph, attached dataset, item filter, and version. Invalid stored field schemas appear in invalidFieldSchemas so you can repair them by replacing the graph.

Signature

Method signature on client.pipelines:

getGraph(args: {
  pipelineId: string;
}): Promise<PipelineGraphSnapshot>;

Parameters

string

required

Pipeline ID with prefix pl..

Returns

Promise<PipelineGraphSnapshot> A live pipeline graph and the version required for conflict-safe replacement.

PipelineGraphV1

required

Current pipeline configuration, including fields, nodes, connections, and optional layout.

Show Fields

required

Graph format version; always 1.

object[]

required

Fields used by the pipeline, with names and JSON Schemas.See the HTTP endpoint for the complete schema.

(RootNode | CodeNode | GenerationNode | MatchNode | QuorumNode)[]

required

Nodes that make up the pipeline.See the HTTP endpoint for the complete schema.

object[]

required

Directed connections between node handles.See the HTTP endpoint for the complete schema.

object

Optional node positions for the visual editor, keyed by node ID and block group; each position is an [x, y] pair.

Show Fields

object

PipelineGraphVersion

required

The snapshot version expected to still be active. A stale version is rejected with HTTP 409.

InvalidFieldSchema[]

required

Fields whose stored JSON Schema cannot be read, for example after an unfinished edit in the UI. Each one appears in graph.fields with a placeholder schema that only carries a description; replace the graph with a valid schema for the field to repair it.

Show Fields

string

required

The id of the field in graph.fields.

string

required

The stored JSON Schema text, exactly as saved.

string

required

Why the stored text is not a usable JSON Schema.

Errors

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

Status	Description
404	Pipeline not found
409	The stored pipeline graph does not satisfy the public graph contract
429	Rate limit exceeded

HTTP endpoint: GET /pipelines/{pipelineId}/graph.

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

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

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

Nested values in this example are abbreviated. The HTTP endpoint has the complete schema.

{
  "graph": {
    "version": 1,
    "fields": [
      {
        "id": "example",
        "name": "<string>",
        "jsonSchema": {}
      }
    ],
    "nodes": [
      {
        "id": "example",
        "type": "root",
        "settings": {
          "startedFieldProxies": {},
          "completedFieldProxies": {}
        }
      }
    ],
    "connections": [
      {
        "from": {
          "node": "example",
          "handle": "example"
        },
        "to": {
          "node": "example",
          "handle": "example"
        },
        "settings": {}
      }
    ]
  },
  "version": "ple.019a0000-0000-7000-8000-000000000001",
  "invalidFieldSchemas": [
    {
      "fieldId": "<string>",
      "text": "<string>",
      "reason": "<string>"
    }
  ]
}

Reference

TypeScript SDK

CLI

HTTP API

client.pipelines.getGraph()

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors