client.datasets.cancelUpload()

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

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

await client.datasets.cancelUpload({
  uploadId: "dfu.019a0000-0000-7000-8000-000000000001"
});

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

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

await client.datasets.cancelUpload({
  uploadId: "dfu.019a0000-0000-7000-8000-000000000001"
});

Cancel an upload before finalization to allow another upload to the dataset. Returns 204, or 409 if the upload has already been finalized.

Signature

Method signature on client.datasets:

cancelUpload(args: {
  uploadId: string;
}): Promise<void>;

Parameters

string

required

Dataset upload ID with prefix dfu..

Returns

Promise<void> Resolves without a return value.

Errors

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

Status	Description
404	Upload not found
409	Upload has already been finalized
429	Rate limit exceeded

HTTP endpoint: POST /uploads/{uploadId}/cancel.

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

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

await client.datasets.cancelUpload({
  uploadId: "dfu.019a0000-0000-7000-8000-000000000001"
});

This method resolves without a return value.

Reference

TypeScript SDK

CLI

HTTP API

client.datasets.cancelUpload()

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors