spicyapiДокументация
Основное содержимое

OpenAPI и список эндпоинтов

Контракт OpenAPI 3.1, продакшен-origin и публичные эндпоинты.

Копируемые эталонные клиенты

Примеры без сторонних зависимостей: поиск моделей, создание задач, повторный запуск завершившихся ошибкой задач, чтение всех конечных состояний, ограниченное ожидание, идемпотентность и ошибки. Принятую задачу отменить нельзя.

Это примеры документации, а не опубликованные пакеты npm/PyPI. Десять минут — локальный предел, не производственный SLA.

Публичный контракт доступен как YAML OpenAPI 3.1. Продакшен-origin — https://api.spicyapi.ai; API задач используют /api/v1, совместимые протоколы — /v1 (формат Gemini — /v1beta).

MethodPath
POST/api/v1/jobs/quote
POST/api/v1/jobs/stream
GET/v1/models
POST/v1/chat/completions
POST/v1/responses
POST/v1/messages
POST/v1beta/models/{model}:generateContent
POST/v1beta/models/{model}:streamGenerateContent
POST/v1/videos
GET/v1/videos/{videoId}
GET/v1/videos/{videoId}/content
POST/api/v1/jobs/createTask
GET/api/v1/jobs
GET/api/v1/jobs/recordInfo
POST/api/v1/jobs/retry
GET/api/v1/models
GET/api/v1/models/{model}
GET/api/v1/chat/credit
GET/api/v1/usage
POST/api/v1/common/upload-url
POST/api/v1/files/{fileId}/commit
POST/api/v1/common/download-url

История через API, SDK и инструменты

GET /api/v1/jobs, client.listTasks в SDK, spicyapi tasks list в CLI и spicyapi_tasks_list в MCP предоставляют одну и ту же историю только для чтения в пределах текущего API-ключа. Результатов в списке нет; запросите выбранный taskId через recordInfo.

Использование контракта

Применяйте OpenAPI для генерации SDK, контрактных тестов и типов. Параметры модели берите из inputSchema в /models/{model}. Допускайте неизвестные поля ответа, но не придумывайте поля запроса.

Полные определения полей приведены в контракте OpenAPI 3.1.

Связанные разделы