> ## Documentation Index > Fetch the complete documentation index at: https://docs.platform.toloka.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Start a pipeline check > Send `nodeId` and `checkId` to check the current graph. Returns a check to poll. Returns 400 if the check is unavailable or cannot run for this graph. ## OpenAPI ````yaml /api-reference/openapi.json post /pipelines/{pipelineId}/checks openapi: 3.1.0 info: description: >- Manage projects, datasets, labeling pipelines, and model training. **Beta:** endpoints, request and response shapes, and error contracts can change without notice or a backward-compatibility promise. title: Toloka Platform API version: 2.0.0 servers: - url: https://platform.toloka.ai/api/v2-beta security: - apiKeyAuth: [] - scopedTokenAuth: [] tags: - description: The authenticated API key owner. name: Account - description: A project is the container for pipelines, datasets, and files. name: Projects - description: Rows and typed fields. Field schemas are immutable once created. name: Datasets - description: Append rows to a dataset from a file. name: Dataset uploads - description: Read a dataset out as a file. name: Dataset exports - description: A pipeline is a graph of nodes that processes each dataset item. name: Pipelines - description: The nodes, connections, fields, and version of a pipeline graph. name: Pipeline graph - description: Execute a pipeline over a dataset and inspect each item. name: Runs - description: Per-node checks that a pipeline must pass before deployment. name: Checks - description: Named credentials available to pipeline code. name: Secrets - description: Project files available to pipeline code and labeling interfaces. name: Files - description: >- Global, read-only catalog of the models a synthetic generation node can use, with their budget bounds. name: Generation models - description: >- Global, read-only catalog of the expert audience: the values a node `audience` filter can use. name: Audience - description: >- Project lists of experts a node can take its workforce from with `audienceMode: service`. Available only to teams with the audience service enabled. name: Expert lists - description: >- Experts banned in a project: they cannot be invited and are removed from the work they are in. Available only to teams with expert bans enabled. name: Expert ban list - description: Global, read-only base model catalog. name: Base models - description: Project-owned mutable model-training drafts. name: Trainings - description: Project-owned Models and immutable Model Versions. name: Models - name: Batch inference paths: /pipelines/{pipelineId}/checks: post: tags: - Checks summary: Start a pipeline check description: >- Send `nodeId` and `checkId` to check the current graph. Returns a check to poll. Returns 400 if the check is unavailable or cannot run for this graph. operationId: createPipelineCheck parameters: - in: path name: pipelineId required: true schema: $ref: '#/components/schemas/PipelineId' requestBody: content: application/json: schema: properties: checkId: description: >- Identifier of the check defined for this node, such as `dataset-lint` on the Start node. minLength: 1 type: string nodeId: description: Identifier of the pipeline graph node to check. minLength: 1 type: string required: - nodeId - checkId type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/CheckJob' description: Check started headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '400': description: Check does not exist or cannot run against the active graph headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '404': description: Pipeline not found headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '429': description: Rate limit exceeded headers: RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' x-codeSamples: - label: TypeScript SDK lang: typescript source: | import { createClient } from "@toloka-platform/sdk"; const client = createClient({ baseUrl: "https://platform.toloka.ai", apiKey: process.env.TOLOKA_API_KEY!, }); const check = await client.checks.start({ pipelineId: "pl.019a0000-0000-7000-8000-000000000001", nodeId: "root", checkId: "dataset-lint" }); console.log(check); components: schemas: PipelineId: description: Pipeline ID with prefix `pl.`. pattern: >- ^pl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ type: string CheckJob: description: >- An asynchronous pipeline check job. Poll until status is succeeded or failed. properties: checkId: description: >- Identifier of the check defined for this node, such as `dataset-lint` on the Start node. type: string createdAt: description: Time the check was started, as an ISO 8601 timestamp. format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ type: string error: description: >- Execution error message, or absent or null when no error is recorded. type: - string - 'null' id: $ref: '#/components/schemas/CheckRunId' nodeId: description: Identifier of the pipeline graph node to check. type: string pipelineId: $ref: '#/components/schemas/PipelineId' result: description: Output and structured findings returned by the check. properties: output: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: >- JSON output produced by the check, or absent or null when no output is available. report: anyOf: - $ref: '#/components/schemas/CheckReport' - type: 'null' description: >- Structured check findings, or absent or null when the check has no report. type: object status: description: >- Check state: `pending` while queued, `running` while executing, `succeeded` when execution finishes, or `failed` after an execution error; inspect `result.report` for findings. enum: - pending - running - succeeded - failed type: string required: - id - pipelineId - nodeId - checkId - status - createdAt - result type: object CheckRunId: description: Check run ID with prefix `plcr.`. pattern: >- ^plcr\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ type: string JsonValue: anyOf: - type: string - type: number - type: boolean - type: 'null' - items: $ref: '#/components/schemas/JsonValue' type: array - additionalProperties: $ref: '#/components/schemas/JsonValue' propertyNames: type: string type: object CheckReport: anyOf: - description: Structured results from a pipeline check. properties: checkedItemCount: description: Number of dataset items examined by this check. maximum: 9007199254740991 minimum: 0 type: integer findings: description: Findings produced by this check. items: description: One check finding. oneOf: - description: One check finding. properties: explanation: description: Explanation of the finding. type: string fieldName: description: Name of the affected field. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string itemCount: description: Number of dataset items affected by this finding. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer sampleItemIds: description: Sample of affected dataset item IDs. items: type: string type: array type: const: missing_required_values description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - fieldProxyId - fieldName - itemCount - sampleItemIds - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string fieldName: description: Name of the affected field. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string type: const: field_missing description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - fieldProxyId - fieldName - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string type: const: no_items_matched description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - explanation type: object type: array required: - findings - checkedItemCount type: object - description: Structured results from a pipeline check. properties: findings: description: Findings produced by this check. items: description: One check finding. properties: message: description: Explanation of the finding. type: string settingName: description: Node setting to which this finding applies. enum: - code - data - preprocess - postprocess - constants type: string severity: description: >- Finding severity: `error` blocks validation and `warning` calls for review. enum: - error - warning type: string required: - settingName - severity - message type: object type: array truncatedFindingCount: description: Number of additional findings omitted from the report. maximum: 9007199254740991 minimum: 0 type: integer required: - findings - truncatedFindingCount type: object - description: Structured results from a pipeline check. properties: checkedItemCount: description: Number of dataset items examined by this check. maximum: 9007199254740991 minimum: 0 type: integer findings: description: Findings produced by this check. items: description: One check finding. oneOf: - description: One check finding. properties: entityName: description: Name of the affected task entity. type: string explanation: description: Explanation of the finding. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string type: const: golden_field_missing description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - entityName - fieldProxyId - explanation type: object - description: One check finding. properties: entityName: description: Name of the affected task entity. type: string explanation: description: Explanation of the finding. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string itemCount: description: Number of dataset items affected by this finding. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer sampleItemIds: description: Sample of affected dataset item IDs. items: type: string type: array type: const: missing_golden_values description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - entityName - fieldProxyId - itemCount - sampleItemIds - explanation type: object - description: One check finding. properties: entityName: description: Name of the affected task entity. type: string explanation: description: Explanation of the finding. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string itemCount: description: Number of dataset items affected by this finding. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer sampleItemIds: description: Sample of affected dataset item IDs. items: type: string type: array type: const: invalid_golden_values description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - entityName - fieldProxyId - itemCount - sampleItemIds - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string fieldName: description: Name of the affected field. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string itemCount: description: Number of dataset items affected by this finding. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer sampleItemIds: description: Sample of affected dataset item IDs. items: type: string type: array type: const: missing_input_values description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - fieldName - fieldProxyId - itemCount - sampleItemIds - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string fieldName: description: Name of the affected field. type: string fieldProxyId: description: Identifier of the affected pipeline field. type: string type: const: input_field_missing description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - fieldName - fieldProxyId - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string type: const: no_items description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string itemCount: description: Number of dataset items affected by this finding. maximum: 9007199254740991 minimum: 0 type: integer tasksPerExpert: description: Number of exam tasks required per expert. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer type: const: not_enough_items description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - itemCount - tasksPerExpert - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string itemCount: description: Number of dataset items affected by this finding. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer type: const: too_many_items description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - itemCount - explanation type: object - description: One check finding. properties: explanation: description: Explanation of the finding. type: string totalValueBytes: description: >- Combined size of the reference-answer values, in bytes. exclusiveMinimum: 0 maximum: 9007199254740991 type: integer type: const: golden_values_too_large description: >- Finding category describing missing or invalid fields, values, or exam examples. type: string required: - type - totalValueBytes - explanation type: object type: array required: - findings - checkedItemCount type: object - description: Structured results from a pipeline check. properties: findings: description: Findings produced by this check. items: description: One check finding. properties: criterionId: description: Identifier of the affected quality criterion. type: string explanation: description: Explanation of the finding. type: string flag: description: >- Criterion issue: `redundant` duplicates another criterion; `guideline_conflict` contradicts instructions; `entity_irrelevant` targets the wrong entity; `not_in_ui` refers to an undefined entity; `not_atomic` combines unrelated checks; `measures_input_not_signal` grades supplied inputs; `unanchored_subjective` lacks a clear standard; `ui_check` belongs in form validation; `dataset_level` requires comparing items. enum: - redundant - guideline_conflict - entity_irrelevant - not_in_ui - not_atomic - measures_input_not_signal - unanchored_subjective - ui_check - dataset_level type: string settingName: description: Node setting to which this finding applies. enum: - qualityElement - targetEntity - thresholds.pass - thresholds.fail type: string required: - criterionId - settingName - flag - explanation type: object type: array required: - findings type: object - description: Structured results from a pipeline check. properties: tokens: description: Tokens used by a synthetic-generation check. properties: cached: description: Number of input tokens served from cache. maximum: 9007199254740991 minimum: 0 type: integer input: description: Number of input tokens used. maximum: 9007199254740991 minimum: 0 type: integer output: description: Number of output tokens generated. maximum: 9007199254740991 minimum: 0 type: integer required: - input - cached - output type: object required: - tokens type: object - description: Structured results from a pipeline check. properties: results: description: Quality-check verdict for each criterion. items: description: One criterion verdict. properties: criterionId: description: Identifier of the assessed quality criterion. type: string verdict: description: >- Assessment outcome: `pass` or `fail`; `unable_to_process`, `incorrect_data`, `jsonpath_error`, and `error` describe evaluation failures; `skipped` means the criterion was not evaluated. enum: - pass - fail - unable_to_process - incorrect_data - jsonpath_error - error - skipped type: string required: - criterionId - verdict type: object type: array required: - results type: object description: Structured results from a pipeline check. headers: RateLimit-Limit: description: The maximum number of requests allowed in the current window. schema: type: integer RateLimit-Policy: description: The rate limit policy (e.g., "60;w=60"). schema: type: string RateLimit-Remaining: description: The number of requests remaining in the current window. schema: type: integer RateLimit-Reset: description: The number of seconds until the current window resets. schema: type: integer X-Request-Id: description: >- The request id: the X-Request-Id you sent when it is 1-128 characters of letters, digits, ".", "_" or "-", otherwise a generated UUID. Present on every response, including errors; quote it when reporting a problem. schema: type: string securitySchemes: apiKeyAuth: description: >- Enter `ApiKey ` in Authorization, including the `ApiKey ` prefix. In cURL and Python samples, `` means this full value. The TypeScript SDK adds the prefix for you. in: header name: Authorization type: apiKey scopedTokenAuth: description: >- Enter the project-scoped token as `pst_...` in X-Scoped-Token, without an `ApiKey ` prefix. Create a token with POST /projects/{projectId}/tokens. in: header name: X-Scoped-Token type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.