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

Обновлено 11 марта 2025

Скачать спецификацию

GET

/get-batches

Возвращает информацию о существующих задачах для асинхронной обработки. Если у пользователя нет задач, возвращается пустой список. Если передан path-параметр batch_id, отобразится информация о конкретной задаче.

Запрос

Query Parameters

batch_id

string

Идентификатор ранее загруженной пакетной задачи.

Header Parameters

X-Request-ID
string
X-Session-ID
string
X-Client-ID
string

Ответы

• 200
• 400
• 401
• 404
• 429
• 500

OK

• application/json

• Схема
• Пример из схемы

Schema

batches

object[]

Список пакетных задач.

Array [

id

string

Идентификатор созданной пакетной задачи.

method

string

Возможные значения: [chat_completions, embedder]

Имя метода, в который далее пойдет запрос на выполнение.

request_counts

object[]

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

Array [

total

integer

По умолчанию: 0

Общее количество запросов.

completed

integer

По умолчанию: 0

Количество обработанных запросов.

failed

integer

По умолчанию: 0

Количество ошибочных запросов.

]

status

string

Возможные значения: [created, in_progress, completed]

Статус обработки файла.

output_file_id

string

Идентификатор файла с результатами обработки запросов батча. Заполняется, если status = completed. Cкачать результат можно с помощью метода get file/{file_id}/content.

created_at

unix timestamp

Время создания файла в формате unix timestamp.

updated_at

unix timestamp

Время обновления файла в формате unix timestamp.

]

{
  "batches": [
    {
      "id": "string",
      "method": "chat_completions",
      "request_counts": {},
      "status": "created",
      "output_file_id": "string",
      "created_at": 0,
      "updated_at": 0
    }
  ]
}

400 Bad request.

Некорректный формат запроса.

Ошибка авторизации.

• application/json

• Схема
• Пример из схемы

Schema

status

integer

По умолчанию: 401

HTTP-код сообщения.

message

string

Возможные значения: [Unauthorized, Token has expired]

Unauthorized — не предоставлен авторизационный токен; Token has expired — истекло время действия токена.

{
  "status": 401,
  "message": "Unauthorized"
}

Батч не найден.

• application/json

• Схема
• Пример из схемы

Schema

status

integer

По умолчанию: 404

HTTP-код сообщения.

message

string

По умолчанию: Batch task not found

Описание ошибки.

{
  "status": 404,
  "message": "Batch task not found"
}

Слишком много запросов в единицу времени.

• application/json

• Схема
• Пример из схемы

Schema

status

integer

По умолчанию: 429

HTTP-код сообщения.

message

string

По умолчанию: Too many requests

Описание ошибки.

{
  "status": 429,
  "message": "Too many requests"
}

Внутренняя ошибка сервера.

• application/json

• Схема
• Пример из схемы

Schema

status

integer

По умолчанию: 500

HTTP-код сообщения.

message

string

По умолчанию: Internal Server Error

Описание ошибки.

{
  "status": 500,
  "message": "Internal Server Error"
}

Loading...

Loading...