API features

  1. At the project level
  2. At the pool level
  3. At the task suite level
  4. At the task level
  5. Aggregating responses to a single task
  6. Tracking operations

Toloka has a number of features that you can use through the API, but not through the interface. This document briefly describes the keys that are used at different stages in Toloka.

At the project level

Key

Value

When to use

assignments_automerge_enabled
Allow merging identical tasks in the project. The setting is helpful if the same task (with completely identical input data) might be uploaded to different pools. In this case, you can save money by merging tasks.
max_active_assignments_count
The number of task suitess the user can complete simultaneously. This setting is helpful in field tasks. With it, performers can reserve up to 30 tasks by default. For example, they can use it to reserve all available tasks nearby. You can limit the number of tasks that a single performer can reserve.

Learn more about API features at the project level.

At the pool level

Key

Value

When to use

mixer_config.golden_task_distribution_function

Assign control tasks at a variable rate. The option allows you to change the frequency of checking as the user completes more tasks.

You can use this setting to assign control tasks less often as the user completes tasks and becomes more experienced. In this case, you can trust the user and reducing the number of control tasks will save resources.

mixer_config.training_task_distribution_function

Assign training tasks at a variable rate. This option allows you to change the frequency of training tasks as the user completes more tasks.

You can use this setting to assign training tasks less often as the user completes tasks and becomes more experienced. In this case, you can trust the user and reducing the number of training tasks will save resources.

Learn more about API features at the pool level.

At the task suite level

Key

Value

When to use

issuing_order_override

Set the priority of a task suites among other pages in the pool. Defines the order in which task suites are assigned to performers. The larger the parameter value, the higher the priority.

Used to show task suites with a higher priority first.

reserved_for[]

IDs of users who will have access to the task suite.

Used to select users who can access this page.

unavailable_for[]

IDs of users who shouldn't have access to the task suite.

Used to select users who won't be able to access this page.

Learn more about API features at the task suite level.

At the task level

Key

Value

When to use

baseline_solutions[]

Preliminary responses. This data simulates performer responses when calculating confidence in a response. It's used in incremental relabeling and aggregation of results by skill.

This setting is necessary if you have preliminary responses that are correct with a certain probability. Then, when using this feature depending on the performer's response, the overlap will be different (if the performer's and preliminary responses match, the overlap won't increase).

reserved_for[]

IDs of users who will have access to the task.

Used to select users who will be able to access this task.

unavailable_for[]

IDs of users who shouldn't have access to the task.

Used to select users who won't be able to access this task.

Learn more about API features at the task level.

Aggregating responses to a single task

Response aggregation involves processing responses to a task and outputting the resulting response and its confidence level.

To start the response aggregation for a single task, send a POST request to the /api/v1/aggregated-solutions/aggregate-by-task resource.

Learn more about response aggregation.

Tracking operations

Some API requests (opening and closing a pool, loading task suites, and so on) are processed as operations that run in the background. Operation details (for example, status and creation time) are passed in JSON format.

You can use the API for tracking operation progress.

Learn more about tracking operations.