Cancel a training run

TypeScript SDK

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

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

const run = await client.trainings.cancelRun({
  trainingRunId: "trn.019a0000-0000-7000-8000-000000000001"
});
console.log(run);

curl --request POST \
  --url https://platform.toloka.ai/api/v2-beta/training-runs/{trainingRunId}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://platform.toloka.ai/api/v2-beta/training-runs/{trainingRunId}/cancel"

payload = {}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "billingStatus": "pending",
  "blockedReason": "funds",
  "chargedAmount": "<string>",
  "configuration": {
    "batchSize": 8,
    "epochs": 3,
    "learningRate": 0.000505,
    "loraRank": 8,
    "maxSequenceLength": 8224,
    "method": "sft",
    "source": {
      "baseModelId": "qwen3-4b",
      "type": "base_model"
    },
    "training": {
      "datasetId": "<string>",
      "itemFilter": {
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      }
    },
    "sliceId": "<string>",
    "splitFieldId": "<string>",
    "trainParts": [
      "<string>"
    ],
    "validation": {
      "datasetId": "<string>",
      "itemFilter": {
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      }
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "error": {
    "code": "data_export_failed",
    "message": "<string>",
    "retryable": true
  },
  "estimateFingerprint": "<string>",
  "estimateInputSetId": "<string>",
  "id": "<string>",
  "inputCutoff": "2023-11-07T05:31:56Z",
  "inputs": {
    "training": {
      "byteSize": 4503599627370495,
      "contract": "openai-chat-v1",
      "datasetExportId": "<string>",
      "datasetFileId": "<string>",
      "datasetId": "<string>",
      "format": "training-jsonl",
      "itemFilter": {
        "createdBefore": "2023-11-07T05:31:56Z",
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      },
      "report": {
        "errors": [
          {
            "itemIndex": 4503599627370495,
            "reason": "<string>"
          }
        ],
        "invalidCount": 4503599627370495,
        "tokens": {
          "max": 4503599627370495,
          "p50": 4503599627370495,
          "p95": 4503599627370495,
          "estimatorVersion": "utf16-code-units-div-4-v1",
          "total": 4503599627370495
        },
        "validCount": 4503599627370495
      },
      "sha256": "<string>"
    },
    "validation": {
      "byteSize": 4503599627370495,
      "contract": "openai-chat-v1",
      "datasetExportId": "<string>",
      "datasetFileId": "<string>",
      "datasetId": "<string>",
      "format": "training-jsonl",
      "itemFilter": {
        "createdBefore": "2023-11-07T05:31:56Z",
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      },
      "report": {
        "errors": [
          {
            "itemIndex": 4503599627370495,
            "reason": "<string>"
          }
        ],
        "invalidCount": 4503599627370495,
        "tokens": {
          "max": 4503599627370495,
          "p50": 4503599627370495,
          "p95": 4503599627370495,
          "estimatorVersion": "utf16-code-units-div-4-v1",
          "total": 4503599627370495
        },
        "validCount": 4503599627370495
      },
      "sha256": "<string>"
    }
  },
  "maxCost": "<string>",
  "message": "<string>",
  "outputModelVersionId": "<string>",
  "outputModelVersionName": "<string>",
  "outputModelVersionRevision": 4503599627370495,
  "progress": {
    "message": "<string>",
    "phase": "<string>",
    "step": 4503599627370495,
    "total": 4503599627370495
  },
  "quote": {
    "budget": {
      "estimatedGpuSeconds": 4503599627370495,
      "estimatedWallSeconds": 4503599627370495,
      "gpuCount": 123,
      "maximumGpuSeconds": 4503599627370495,
      "maximumWallSeconds": 4503599627370495,
      "methodWorkUnits": 4503599627370495
    },
    "calculatedAt": "2023-11-07T05:31:56Z",
    "capabilityVersion": "<string>",
    "currency": "USD",
    "cutoff": "2023-11-07T05:31:56Z",
    "inputSetId": "<string>",
    "inputs": {
      "training": {
        "datasetExportId": "<string>",
        "datasetId": "<string>",
        "failure": {
          "code": "empty_selection",
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        },
        "report": {
          "errors": [
            {
              "itemIndex": 4503599627370495,
              "reason": "<string>"
            }
          ],
          "invalidCount": 4503599627370495,
          "tokens": {
            "max": 4503599627370495,
            "p50": 4503599627370495,
            "p95": 4503599627370495,
            "estimatorVersion": "utf16-code-units-div-4-v1",
            "total": 4503599627370495
          },
          "validCount": 4503599627370495
        },
        "heldOutRows": 4503599627370495
      },
      "validation": {
        "datasetExportId": "<string>",
        "datasetId": "<string>",
        "failure": {
          "code": "empty_selection",
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        },
        "report": {
          "errors": [
            {
              "itemIndex": 4503599627370495,
              "reason": "<string>"
            }
          ],
          "invalidCount": 4503599627370495,
          "tokens": {
            "max": 4503599627370495,
            "p50": 4503599627370495,
            "p95": 4503599627370495,
            "estimatorVersion": "utf16-code-units-div-4-v1",
            "total": 4503599627370495
          },
          "validCount": 4503599627370495
        },
        "heldOutRows": 4503599627370495
      }
    },
    "maximumCharge": "<string>",
    "pricingVersion": "<string>"
  },
  "status": "queued",
  "trainingId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

POST

training-runs

{trainingRunId}

cancel

TypeScript SDK

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

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

const run = await client.trainings.cancelRun({
  trainingRunId: "trn.019a0000-0000-7000-8000-000000000001"
});
console.log(run);

curl --request POST \
  --url https://platform.toloka.ai/api/v2-beta/training-runs/{trainingRunId}/cancel \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://platform.toloka.ai/api/v2-beta/training-runs/{trainingRunId}/cancel"

payload = {}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "billingStatus": "pending",
  "blockedReason": "funds",
  "chargedAmount": "<string>",
  "configuration": {
    "batchSize": 8,
    "epochs": 3,
    "learningRate": 0.000505,
    "loraRank": 8,
    "maxSequenceLength": 8224,
    "method": "sft",
    "source": {
      "baseModelId": "qwen3-4b",
      "type": "base_model"
    },
    "training": {
      "datasetId": "<string>",
      "itemFilter": {
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      }
    },
    "sliceId": "<string>",
    "splitFieldId": "<string>",
    "trainParts": [
      "<string>"
    ],
    "validation": {
      "datasetId": "<string>",
      "itemFilter": {
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      }
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "error": {
    "code": "data_export_failed",
    "message": "<string>",
    "retryable": true
  },
  "estimateFingerprint": "<string>",
  "estimateInputSetId": "<string>",
  "id": "<string>",
  "inputCutoff": "2023-11-07T05:31:56Z",
  "inputs": {
    "training": {
      "byteSize": 4503599627370495,
      "contract": "openai-chat-v1",
      "datasetExportId": "<string>",
      "datasetFileId": "<string>",
      "datasetId": "<string>",
      "format": "training-jsonl",
      "itemFilter": {
        "createdBefore": "2023-11-07T05:31:56Z",
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      },
      "report": {
        "errors": [
          {
            "itemIndex": 4503599627370495,
            "reason": "<string>"
          }
        ],
        "invalidCount": 4503599627370495,
        "tokens": {
          "max": 4503599627370495,
          "p50": 4503599627370495,
          "p95": 4503599627370495,
          "estimatorVersion": "utf16-code-units-div-4-v1",
          "total": 4503599627370495
        },
        "validCount": 4503599627370495
      },
      "sha256": "<string>"
    },
    "validation": {
      "byteSize": 4503599627370495,
      "contract": "openai-chat-v1",
      "datasetExportId": "<string>",
      "datasetFileId": "<string>",
      "datasetId": "<string>",
      "format": "training-jsonl",
      "itemFilter": {
        "createdBefore": "2023-11-07T05:31:56Z",
        "excludeParts": [
          {
            "fieldId": "<string>",
            "names": [
              "<string>"
            ]
          }
        ],
        "fieldSources": [
          {
            "fieldId": "<string>",
            "sources": [
              {
                "type": "user",
                "userId": "<string>"
              }
            ]
          }
        ],
        "fieldValues": [
          {
            "fieldId": "<string>",
            "jsonPath": "<string>",
            "operator": "text_eq",
            "value": "<string>",
            "latestOnly": true,
            "sources": []
          }
        ],
        "missingRevisionFields": [
          "<string>"
        ],
        "parts": {
          "fieldId": "<string>",
          "names": [
            "<string>"
          ]
        },
        "slice": {
          "sliceId": "<string>"
        }
      },
      "report": {
        "errors": [
          {
            "itemIndex": 4503599627370495,
            "reason": "<string>"
          }
        ],
        "invalidCount": 4503599627370495,
        "tokens": {
          "max": 4503599627370495,
          "p50": 4503599627370495,
          "p95": 4503599627370495,
          "estimatorVersion": "utf16-code-units-div-4-v1",
          "total": 4503599627370495
        },
        "validCount": 4503599627370495
      },
      "sha256": "<string>"
    }
  },
  "maxCost": "<string>",
  "message": "<string>",
  "outputModelVersionId": "<string>",
  "outputModelVersionName": "<string>",
  "outputModelVersionRevision": 4503599627370495,
  "progress": {
    "message": "<string>",
    "phase": "<string>",
    "step": 4503599627370495,
    "total": 4503599627370495
  },
  "quote": {
    "budget": {
      "estimatedGpuSeconds": 4503599627370495,
      "estimatedWallSeconds": 4503599627370495,
      "gpuCount": 123,
      "maximumGpuSeconds": 4503599627370495,
      "maximumWallSeconds": 4503599627370495,
      "methodWorkUnits": 4503599627370495
    },
    "calculatedAt": "2023-11-07T05:31:56Z",
    "capabilityVersion": "<string>",
    "currency": "USD",
    "cutoff": "2023-11-07T05:31:56Z",
    "inputSetId": "<string>",
    "inputs": {
      "training": {
        "datasetExportId": "<string>",
        "datasetId": "<string>",
        "failure": {
          "code": "empty_selection",
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        },
        "report": {
          "errors": [
            {
              "itemIndex": 4503599627370495,
              "reason": "<string>"
            }
          ],
          "invalidCount": 4503599627370495,
          "tokens": {
            "max": 4503599627370495,
            "p50": 4503599627370495,
            "p95": 4503599627370495,
            "estimatorVersion": "utf16-code-units-div-4-v1",
            "total": 4503599627370495
          },
          "validCount": 4503599627370495
        },
        "heldOutRows": 4503599627370495
      },
      "validation": {
        "datasetExportId": "<string>",
        "datasetId": "<string>",
        "failure": {
          "code": "empty_selection",
          "message": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        },
        "report": {
          "errors": [
            {
              "itemIndex": 4503599627370495,
              "reason": "<string>"
            }
          ],
          "invalidCount": 4503599627370495,
          "tokens": {
            "max": 4503599627370495,
            "p50": 4503599627370495,
            "p95": 4503599627370495,
            "estimatorVersion": "utf16-code-units-div-4-v1",
            "total": 4503599627370495
          },
          "validCount": 4503599627370495
        },
        "heldOutRows": 4503599627370495
      }
    },
    "maximumCharge": "<string>",
    "pricingVersion": "<string>"
  },
  "status": "queued",
  "trainingId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

trainingRunId

string

required

ID of the training run, with prefix trn..

Pattern: ^trn\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

The body is of type object.

Response

Training run after the cancellation request

The configuration, inputs, and current state of one training run.

billingStatus

enum<string>

required

Billing state: pending before reservation, reserved while funds are held, release_pending or released for returned funds, settled after charging, payment_required for a shortfall, resolved after staff review, or reconciliation_required when charges need review.

Available options:

pending,

reserved,

release_pending,

released,

settled,

payment_required,

resolved,

reconciliation_required

blockedReason

enum<string> | null

required

Reason the run is blocked: funds to reserve the budget, payment to settle usage, or billing_review for staff review; otherwise null.

Available options:

funds,

payment,

billing_review

chargedAmount

string | null

required

Settled charge in US dollars as a decimal string, or null before a charge is recorded.

Pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$

configuration

object

required

A normalized method-specific Training draft.

Option 1
Option 2

Show child attributes

createdAt

string<date-time>

required

Time the training run was created, as an ISO 8601 timestamp.

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))$

error

object | null

required

Failure or cancellation details, or null when no error is recorded.

Show child attributes

estimateFingerprint

string

required

SHA-256 fingerprint of the accepted estimate, as 64 lowercase hexadecimal characters.

Pattern: ^[0-9a-f]{64}$

estimateInputSetId

string

required

The immutable input set used to calculate a Training Cost Estimate.

Pattern: ^tei\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

string

required

ID of the training run, with prefix trn..

Pattern: ^trn\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

inputCutoff

string<date-time>

required

Cutoff used to freeze the input rows, as an ISO 8601 timestamp.

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))$

inputs

object | null

required

Prepared training and validation inputs; null when unavailable or omitted from create and list responses.

Show child attributes

maxCost

string

required

Maximum accepted charge for this run, in US dollars as a decimal string.

message

string | null

required

Current status or billing explanation, or null when none is available.

outputModelVersionId

string

required

Model version ID with prefix mdv..

Pattern: ^mdv\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

outputModelVersionName

string

required

Name reserved for the model version this run produces.

Required string length: 1 - 120

outputModelVersionRevision

integer | null

required

Published model version revision, or null before publication.

Required range: 0 < x <= 9007199254740991

progress

object | null

required

Latest training progress while running or stopping; null in other states or when progress is unavailable.

Show child attributes

quote

object

required

Cost estimate accepted for this run.

Show child attributes

status

enum<string>

required

Run state: queued, running, stopping, blocked, completed, failed, or canceled; blocked requires resolving the reported reason.

Available options:

queued,

running,

stopping,

blocked,

completed,

failed,

canceled

trainingId

string

required

Training draft ID with prefix trg..

Pattern: ^trg\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

updatedAt

string<date-time>

required

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

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))$

Reference

TypeScript SDK

CLI

HTTP API

Authorizations

Path Parameters

Body

Response