client.files.delete()

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

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

await client.files.delete({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  fileId: "ppf.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.files.delete({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  fileId: "ppf.019a0000-0000-7000-8000-000000000001"
});

Remove the file from the project. Returns 204, or 404 if the project or file is unavailable to you.

Signature

Method signature on client.files:

delete(args: {
  projectId: string;
  fileId: string;
}): Promise<void>;

Parameters

string

required

Project ID with prefix pp..

string

required

ID of the project file, with prefix ppf..

Returns

Promise<void> Resolves without a return value.

Errors

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

Status	Description
404	Project or file not found
429	Rate limit exceeded

HTTP endpoint: DELETE /projects/{projectId}/files/{fileId}.

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

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

await client.files.delete({
  projectId: "pp.019a0000-0000-7000-8000-000000000001",
  fileId: "ppf.019a0000-0000-7000-8000-000000000001"
});

This method resolves without a return value.

Reference

TypeScript SDK

CLI

HTTP API

Signature

Parameters

Returns

Errors