Формат ответов и ошибок
Структура успешных ответов, объект ошибки и категории ошибок
Успешные ответы
Обычный JSON в удобном для вас виде. Обрамляющие поля:
- Списочные ответы:
{ "object": "list", "data": [...] }(как в OpenAI). - Транскрипции по ссылке:
{ "data": { ... } }.
Ошибки
Все ошибки выглядят одинаково — в стиле OpenAI:
{
"error": {
"message": "Insufficient balance to process the transcription",
"type": "insufficient_quota",
"code": "insufficient_balance",
"param": null
}
}| Поле | Что это |
|---|---|
message | Человекочитаемое объяснение, что пошло не так |
type | Категория ошибки (см. таблицу ниже) |
code | Машинный код ошибки, полезен для обработки в коде |
param | Поле запроса, из-за которого ошибка; null, если не связано с конкретным полем |
Категории ошибок (type)
type | HTTP | Что значит |
|---|---|---|
invalid_request_error | 400 | Невалидный запрос: неверное поле, оба file и url сразу и т.п. |
authentication_error | 401 | Проблема с API-ключом |
permission_error | 403 | Нет прав на операцию (например, аккаунт заблокирован) |
not_found_error | 404 | Задача/ресурс не найден |
rate_limit_error | 429 | Превышен лимит запросов |
insufficient_quota | 402 | Недостаточно средств на балансе |
server_error | 500 | Внутренняя ошибка на нашей стороне. Повторите запрос позже |
При 429 в заголовке ответа приходит Retry-After с количеством секунд, после
которого стоит повторить.