client.pipelines.export()

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

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

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

{
  "name": "<string>",
  "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": {}
      }
    ]
  }
}

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

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

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

{
  "name": "<string>",
  "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": {}
      }
    ]
  }
}

Return a document containing the pipeline name and graph for import into another project. The attached dataset is omitted.

Signature

Method signature on client.pipelines:

export(args: {
  pipelineId: string;
}): Promise<{ name: string; graph: PipelineGraphV1 }>;

Parameters

string

required

Pipeline ID with prefix pl..

Returns

Promise<{ name: string; graph: PipelineGraphV1 }>

string

required

Name of the pipeline.

PipelineGraphV1

required

Pipeline graph in version 1 of the public graph format.

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

Errors

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

Status	Description
404	Pipeline not found
409	Pipeline graph contains a field schema that cannot be exported
429	Rate limit exceeded

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

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

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

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

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

{
  "name": "<string>",
  "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": {}
      }
    ]
  }
}

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors