Create a task suite

To create a task suite, send a POST request to the /task-suites resource. You can send a maximum of 100,000 requests of this type per minute and 2,000,000 requests per day.

Request

POST /api/v1/task-suites ?
  [async_mode=<true/false>]
& [allow_defaults=<true/false>]
& [skip_invalid_items=<true/false>]
& [open_pool=<true/false>]
& [operation_id=<operation ID>]

Host: https://sandbox.toloka.yandex.com
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

{task suite parameters}
Request parameters

Parameter

Overview

Data type

Required

async_mode

Mode for request processing:

  • true — Asynchronous. Creates an asynchronous operation that runs in the background. The response contains information about the operation (start and completion time, status).

  • false — Synchronous. The response contains information about the created task suite.

The default value is false.

Boolean

No

allow_defaults

Overlap settings:

The default value is false.

Boolean

No

skip_invalid_items

Validation parameters for JSON objects:

  • true — Create a task suite that passed validation.

  • false — Stop the operation and don't create the task suite if it didn't pass validation.

The default value is false.

Boolean

No

open_pool

Open the pool immediately after creating the task suite, if the pool is closed. The default value is false.

Boolean

No

operation_id

Operation ID for asynchronous task suite loading (if async_mode=true).

We recommend sending the ID in the POST request to avoid accidental errors, such as creating the operation multiple times for the same task suite.

The ID should conform to the RFC4122 standard.

You can use this ID in the future to get information about the operation.

String

No

Parameter

Overview

Data type

Required

async_mode

Mode for request processing:

  • true — Asynchronous. Creates an asynchronous operation that runs in the background. The response contains information about the operation (start and completion time, status).

  • false — Synchronous. The response contains information about the created task suite.

The default value is false.

Boolean

No

allow_defaults

Overlap settings:

The default value is false.

Boolean

No

skip_invalid_items

Validation parameters for JSON objects:

  • true — Create a task suite that passed validation.

  • false — Stop the operation and don't create the task suite if it didn't pass validation.

The default value is false.

Boolean

No

open_pool

Open the pool immediately after creating the task suite, if the pool is closed. The default value is false.

Boolean

No

operation_id

Operation ID for asynchronous task suite loading (if async_mode=true).

We recommend sending the ID in the POST request to avoid accidental errors, such as creating the operation multiple times for the same task suite.

The ID should conform to the RFC4122 standard.

You can use this ID in the future to get information about the operation.

String

No

Response

Contains the task suite data in JSON format.