Справочник API
Async Routes
Асинхронные задачи для долгих запросов
Асинхронные маршруты нужны для задач, которые могут выполняться дольше обычного HTTP-запроса.
Общий поток:
- Отправить задачу через
POST /v1/async/.... - Получить
job_id. - Проверять результат через
GET /v1/async/.../{job_id}. - Повторять проверку, пока задача не завершится.
job_id принадлежит рабочему пространству, где задача была создана. Чужой ключ не сможет получить результат.
Тело запроса на создание задачи
Асинхронный POST принимает те же основные поля, что и соответствующий обычный маршрут.
| Поле | Обязательность | Описание |
|---|---|---|
model | Да | Публичное имя модели. |
| Основной ввод | Да | Например messages, prompt, input, file, image, query или documents. |
| Параметры модели | Нет | Например temperature, max_tokens, size, voice, top_n. |
Поля ответа при создании
| Поле | Обязательность | Описание |
|---|---|---|
id | Да | Публичный идентификатор задачи. Обычно имеет вид job_*. |
status | Да | Начальный статус задачи. |
created_at | Нет | Время создания, если доступно. |
Пример создания
curl {{PUBLIC_API_BASE_URL}}/async/chat/completions \
-H "Authorization: Bearer gw_live_..." \
-H "Content-Type: application/json" \
-d '{
"model": "provider/model-name",
"messages": [
{"role": "user", "content": "Подготовь черновик письма."}
]
}'{
"id": "job_example",
"status": "queued"
}Проверка результата
job_id передаётся в пути.
| Поле ответа | Обязательность | Описание |
|---|---|---|
id | Да | Идентификатор задачи. |
status | Да | queued, processing, completed, failed или другой статус поставщика. |
result | Нет | Итог обычного маршрута, если задача завершилась. |
error | Нет | Ошибка, если задача завершилась неуспешно. |
curl {{PUBLIC_API_BASE_URL}}/async/chat/completions/job_example \
-H "Authorization: Bearer gw_live_..."{
"id": "job_example",
"status": "completed",
"result": {
"id": "chatcmpl_example",
"object": "chat.completion",
"choices": [
{
"message": {
"role": "assistant",
"content": "Черновик письма готов."
},
"finish_reason": "stop"
}
]
}
}Повторы
Не опрашивайте задачу слишком часто. Начните с задержки в несколько секунд и увеличивайте её для долгих задач.