Ошибки API

На этой странице приведены все коды ошибок Interactions API, описан формат ответа с ошибкой и объясняется, как API возвращает ошибки для разных типов запросов.

Стандартные коды ошибок API

Эти общие коды ошибок на уровне запроса соответствуют стандартным кодам статуса HTTP. Используйте поле code в логике приложения, чтобы обрабатывать ошибки программно.

Коды блокировки генерации

Эти коды ошибок указывают на то, что правила, безопасность или ограничения на контент заблокировали выходные данные модели. Если вы получили один из этих кодов, измените входные данные и повторите попытку.

Коды ошибок генерации

Эти коды ошибок указывают на структурную проблему с выходными данными, сгенерированными моделью (например, неправильный вызов функции или необъявленный вызов инструмента).

Формат ответа об ошибке

Все ошибки Interactions API возвращают объект error, содержащий code и message. Например, если передать неподдерживаемый тип инструмента, возвращается следующее:

{
  "error": {
    "code": "invalid_request",
    "message": "The value 'invalid_tool_type_xyz' is not supported for 'type' at 'tools[0]'. Supported values: 'function', 'code_execution', 'mcp_server', 'filesystem', 'google_maps', 'google_search', 'bash', 'computer_use', 'file_search', 'url_context'."
  }
}

Как отправляются сообщения об ошибках

API возвращает ошибки по-разному в зависимости от того, какой HTTP-запрос вы делаете: стандартный или потоковый (SSE).

Стандартные HTTP-запросы

Для стандартных (непотоковых) запросов API задает код статуса HTTP-ответа (например, 400 Bad Request, 401 Unauthorized или 429 Too Many Requests) и возвращает объект error в теле ответа JSON:

{
  "error": {
    "code": "invalid_request",
    "message": "The value 'invalid_tool_type_xyz' is not supported for 'type' at 'tools[0]'."
  }
}

Запросы потоковой передачи (SSE)

Для потоковых запросов (stream: true) API отправляет события ошибок через поток Server-Sent Events (SSE) с параметром event_type, установленным на "error". Поле error содержит ту же структуру code и message:

{
  "event_type": "error",
  "error": {
    "code": "not_found",
    "message": "Failed to get completed interaction: Result not found."
  }
}

Полная схема событий SSE приведена в документации по Interactions API.

Дальнейшие действия

• Устранение неполадок с API. Решение распространенных проблем и ошибок.
• Ограничения частоты запросов. Узнайте об ограничениях на количество запросов и обработке квот.