Change the task suite overlap

Attention

The toloka.yandex.com domain will be disabled starting July 1, 2023. Please use the toloka.dev domain for API requests.

Changes the task suite overlap.

You can specify a numeric value or set infinite overlap to assign the task suite to all Tolokers (this is useful for training tasks).

Request

Tip

Try our new API reference: more parameter details, request/response examples, and code samples in various programming languages, including the Toloka-Kit usage samples.

Production version

Sandbox

PATCH https://toloka.dev/api/v1/task-suites/<task_suite_id>
Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Path parameters

Parameter	Overview
task_suite_id	ID of a task suite.

Headers

Title	Overview
Authorization	A token for account authorization. Add OAuth as a prefix.
Content-Type	Specifies the data format in the request body.

Query parameters

Specified in the link after the question mark; separated by &.

Parameter	Overview
open_pool	boolean

Open the pool immediately after the operation is completed, if the pool is closed. The default value is false.

Request body

Numeric overlap value

{
  "overlap": <new overlap value>,
  "infinite_overlap": false
}

Infinite overlap

{
  "overlap": null,
  "infinite_overlap": true
}

Parameter Overview

overlap integer | required if

Required if the parameter is not used when creating a task suite allow_defaults=true, and the overlap is not specified in the pool parameters (in the defaults.default_overlap_for_new_task_suites) key).

Task suite overlap.

Parameter	Overview
overlap	integer \| required if Required if the parameter is not used when creating a task suite `allow_defaults=true`, and the overlap is not specified in the pool parameters (in the `defaults.default_overlap_for_new_task_suites`) key). Task suite overlap.
infinite_overlap	boolean \| required Assigning a task suite with infinite overlap. This option is used, for instance, for suites of training tasks when you want to assign them to all Tolokers: `true` — Use infinite overlap. `false` — Use the overlap that is set for the task suite or pool.

infinite_overlap

boolean | required

Assigning a task suite with infinite overlap. This option is used, for instance, for suites of training tasks when you want to assign them to all Tolokers:

true — Use infinite overlap.
false — Use the overlap that is set for the task suite or pool.

Response

Contains a task suite in JSON format.