client.datasets.getUpload()

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

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

const upload = await client.datasets.getUpload({
  uploadId: "dfu.019a0000-0000-7000-8000-000000000001"
});
console.log(upload);

{
  "id": "dfu.019a0000-0000-7000-8000-000000000001",
  "status": "pending",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": null,
  "result": {
    "itemsIngested": 0
  }
}

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

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

const upload = await client.datasets.getUpload({
  uploadId: "dfu.019a0000-0000-7000-8000-000000000001"
});
console.log(upload);

{
  "id": "dfu.019a0000-0000-7000-8000-000000000001",
  "status": "pending",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": null,
  "result": {
    "itemsIngested": 0
  }
}

Return the upload status, imported row count, and error if it failed. After finalizing, poll until status is succeeded or failed.

Signature

Method signature on client.datasets:

getUpload(args: {
  uploadId: string;
}): Promise<UploadJob>;

Parameters

string

required

Dataset upload ID with prefix dfu..

Returns

Promise<UploadJob> A dataset upload and its import status. After finalizing, poll until status is succeeded or failed.

UploadId

required

Dataset upload ID with prefix dfu..

"pending" | "running" | "succeeded" | "failed"

required

Upload state: pending before finalization, running while rows are imported, succeeded when complete, or failed after failure or cancellation.

string

required

Time the upload was started, as an ISO 8601 timestamp.

string | null

required

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

object

required

Progress of the dataset import.

Show Fields

number

required

Number of rows imported so far, including rows imported before a partial failure.

Errors

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

Status	Description
404	Upload not found
429	Rate limit exceeded

HTTP endpoint: GET /uploads/{uploadId}.

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

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

const upload = await client.datasets.getUpload({
  uploadId: "dfu.019a0000-0000-7000-8000-000000000001"
});
console.log(upload);

{
  "id": "dfu.019a0000-0000-7000-8000-000000000001",
  "status": "pending",
  "createdAt": "2026-01-01T00:00:00Z",
  "error": null,
  "result": {
    "itemsIngested": 0
  }
}

Reference

TypeScript SDK

CLI

HTTP API

client.datasets.getUpload()

Signature

Parameters

Returns

Errors