Create a training pool

To create a training pool, send a POST request to the /trainings resource. You can send a maximum of 20 requests of this kind per minute and 100 requests per day.

Learn about creating a main pool in Create a pool.

Request

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

{<training pool parameters>}

Response

Contains information about the created training pool:

{
  "id": "123456",
  "project_id": "654321",
  "private_name": "Selection for a labeling task",
  "inherited_instructions": false,
  "public_instructions": "Unpaid selection for a project: 10 tasks, 90% threshold.",
  "may_contain_adult_content": false,
  "assignment_max_duration_seconds": 600,
  "mix_tasks_in_creation_order": true,
  "shuffle_tasks_in_task_suite": true,
  "training_tasks_in_task_suite_count": 10,
  "task_suites_required_to_pass": 1,
  "retry_training_after_days": 7,
  "owner": {
    "id": "ec00d2407f7241258d0faba610110d95",
    "myself": true
  },
  "status": "CLOSED",
  "created": "2021-02-24T18:12:57.962"
}
Key descriptions
Key Value Data type Required during creation
id
ID of the training pool. String Not used
project_id
ID of the project that the training pool was created for. String Yes
private_name
Name of the training pool (only visible to the requester). String Yes
inherited_instructions

Indicates whether to use the project instructions. To provide separate instructions for the training, enter it in public_instructions.

The default value is false.

Boolean Yes
public_instructions
Instructions for completing a training task. You can use any HTML markup. String No
may_contain_adult_content
Whether training tasks contain adult content. Boolean Yes
assignment_max_duration_seconds
The time allowed for completing a task suite, in seconds. We recommend allowing no more than 60 seconds per task suite (including the time for loading the page and submitting assignments). Number Yes
mix_tasks_in_creation_order
Whether training tasks are issued in their upload order:
  • true — Tasks are grouped into task suites in the order of rows in the uploaded file (top-to-bottom).
  • false — Tasks are taken at random.
The default value is true.
Boolean No
shuffle_tasks_in_task_suite
Whether training tasks are shuffled within each task suite:
  • true — Yes.
  • false — No, they are listed in their upload order.
The default value is true.
Boolean No
training_tasks_in_task_suite_count
Number of training tasks per suite. Number Yes
task_suites_required_to_pass
Number of task suites the user needs to complete to get a skill and access the main tasks. Number Yes
retry_training_after_days
Number of days until retry becomes available. Number No
owner.id
Requester ID. String Not used
owner.myself
Checks who the object belongs to:
  • true — The user who made the request.
  • false — Another account (employee or owner).
Boolean Not used
status
Training pool status:
  • OPEN
  • CLOSED
  • ARCHIVED
String Not used
created
The UTC date and time when the training pool was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss]. String Not used
Key Value Data type Required during creation
id
ID of the training pool. String Not used
project_id
ID of the project that the training pool was created for. String Yes
private_name
Name of the training pool (only visible to the requester). String Yes
inherited_instructions

Indicates whether to use the project instructions. To provide separate instructions for the training, enter it in public_instructions.

The default value is false.

Boolean Yes
public_instructions
Instructions for completing a training task. You can use any HTML markup. String No
may_contain_adult_content
Whether training tasks contain adult content. Boolean Yes
assignment_max_duration_seconds
The time allowed for completing a task suite, in seconds. We recommend allowing no more than 60 seconds per task suite (including the time for loading the page and submitting assignments). Number Yes
mix_tasks_in_creation_order
Whether training tasks are issued in their upload order:
  • true — Tasks are grouped into task suites in the order of rows in the uploaded file (top-to-bottom).
  • false — Tasks are taken at random.
The default value is true.
Boolean No
shuffle_tasks_in_task_suite
Whether training tasks are shuffled within each task suite:
  • true — Yes.
  • false — No, they are listed in their upload order.
The default value is true.
Boolean No
training_tasks_in_task_suite_count
Number of training tasks per suite. Number Yes
task_suites_required_to_pass
Number of task suites the user needs to complete to get a skill and access the main tasks. Number Yes
retry_training_after_days
Number of days until retry becomes available. Number No
owner.id
Requester ID. String Not used
owner.myself
Checks who the object belongs to:
  • true — The user who made the request.
  • false — Another account (employee or owner).
Boolean Not used
status
Training pool status:
  • OPEN
  • CLOSED
  • ARCHIVED
String Not used
created
The UTC date and time when the training pool was created, in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss]. String Not used