Получить список заданий

GET /tasks

Получает список заданий в пуле.

Примеры запросов

curl -X GET 'https://tasks.yandex.ru/api/v1/tasks?pool_id=1227652' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'
import requests

url = "https://tasks.yandex.ru/api/v1/tasks"
params = {
  'pool_id': '1227652'
}
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, params=params, headers=headers)

print(response.text)
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/tasks',
  'qs': {'pool_id': '1227652'},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте OAuth.

Query-параметры

Указываются в ссылке после знака вопроса, перечисляются через &.

Параметр

Описание

pool_id*

string

Идентификатор пула, из которого нужно получить задания.

sort

string

Параметры для сортировки:

  • id — идентификатор задания;
  • created — дата создания задания по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss]. О том, как задать сортировку, читайте на странице Сортировка списка объектов.

overlap

integer

Задания с перекрытием, равным указанному значению.

limit

integer

Ограничение на количество возвращаемых результатов. По умолчанию — 50, максимум — 100 000.

id_gt

string

Объекты с идентификатором больше указанного значения.

id_gte

string

Объекты с идентификатором больше или равным указанному значению.

id_lt

string

Объекты с идентификатором меньше указанного значения.

id_lte

string

Объекты с идентификатором меньше или равным указанному значению.

created_gt

string

Объекты, выданные или созданные после указанной даты.

created_gte

string

Объекты, выданные или созданные после указанной даты включительно.

created_lt

string

Объекты, выданные или созданные до указанной даты.

created_lte

string

Объекты, выданные или созданные до указанной даты включительно.

overlap_gt

integer

Объекты с перекрытием больше указанного значения.

overlap_gte

integer

Объекты с перекрытием, больше или равным указанному значению.

overlap_lt

integer

Объекты с перекрытием меньше указанного значения.

overlap_lte

integer

Объекты с перекрытием, меньше или равным указанному значению.

Больше примеров

Можно настроить показ списка заданий частями (например, по 10 заданий):

  1. Показать первые 10 заданий, начиная с подписки с наименьшим идентификатором.
  2. Показывать оставшиеся задания по 10 штук в порядке возрастания.

Показать первые 10 заданий

curl -X GET 'https://tasks.yandex.ru/api/v1/tasks?pool_id=1227652&sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Показать остальные части с сортировкой по возрастанию идентификатора

curl -X GET 'https://tasks.yandex.ru/api/v1/tasks?pool_id=1227652&sort=id&limit=10&id_gt={ID_последнего_задания_из_предыдущего_ответа}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

Содержит данные заданий в массиве items:

{
  "items": [
    {task 1},
    {task 2},
    ...
    {task n}
  ],
  "has_more": true
}
Пример ответа
{
  "id": "000248a756--6422ca21e5997032541d856b",
  "created": "2023-03-28T11:06:09.827",
  "pool_id": "38315862",
  "input_values": {
    "image_url": "https://example.com/image1.jpg"
  },
  "known_solutions": [
    {
      "output_values": {
        "result": "OK",
        "like": false
      },
      "correctness_weight": 0.8
    },
    {
      "output_values": {
        "result": "OK",
        "like": true
      },
      "correctness_weight": 1
    }
  ],
  "baseline_solutions": [
    {
      "output_values": {
        "result": "OK",
        "like": false
      },
      "confidence_weight": 0.8
    },
    {
      "output_values": {
        "result": "OK",
        "like": true
      },
      "confidence_weight": 1
    }
  ],
  "message_on_unknown_solution": "The cat is in a good mood.",
  "overlap": 3,
  "infinite_overlap": false,
  "remaining_overlap": 3,
  "reserved_for": [],
  "unavailable_for": []
}

Параметр

Описание

items

array of objects

Массив со списком заданий и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

Возможные значения:

  • true — не все элементы вошли в ответ из-за ограничений в параметре limit.

    Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.

Обязательный параметр