Developer API

Справочник API

Справочник по gateway routes: для разработчиков, web session и callback/internal аудиторий.

Маршруты для разработчиков

Сначала перечислены маршруты для разработчиков, затем для них раскрыты параметры, тело запроса, формат ответа, поведение ошибок и операционные заметки из gateway-кода.

POST

Endpoint

/auth/device/code

Создает device code, user code, verification URL, срок действия и polling interval.

Авторизация

Нет

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`client` и optional `scope`; если scope не указан, используется `ricochet_code`.

Ответ

Возвращает `device_code`, `user_code`, `verification_url`, `expires_in`, `interval`, включая snake_case/camelCase aliases где реализовано.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

POST

Endpoint

/auth/device/token

Меняет approved device code на access и refresh tokens.

Авторизация

Нет

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`device_code`, полученный из `/auth/device/code`.

Ответ

Возвращает Grik `access_token`, `refresh_token`, expiry и related token metadata.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

POST

Endpoint

/auth/refresh

Ротирует refresh token и выдает новый access token.

Авторизация

Нет

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`refresh_token`; server rotates token и возвращает новую token pair.

Ответ

Возвращает Grik `access_token`, `refresh_token`, expiry и related token metadata.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

GET

Endpoint

/users/me

Возвращает authenticated user profile для billing и ownership.

Авторизация

Bearer token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

POST

Endpoint

/auth/api-keys

Выпускает organization API key вида grik_live_... для server-side integrations.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`name`, `scopes`, optional `product`, `mode`, `environment`, `spend_limit_micros`, `spend_reset_interval`.

Ответ

Возвращает API key record и raw key только один раз. Сохраните его сразу.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

GET

Endpoint

/auth/api-keys

Показывает active и revoked API keys без raw secret.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает API key records с prefix/last4 и controls, без raw secrets.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

PATCH

Endpoint

/auth/api-keys/:id

Обновляет key metadata, scopes, environment, status или spend controls без раскрытия raw secret.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

Любые mutable API key metadata: `name`, `scopes`, `status`, `environment`, `spend_limit_micros`, `spend_reset_interval`.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

DELETE

Endpoint

/auth/api-keys/:id

Отзывает API key по id. Revoked keys сразу перестают проходить auth.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

GET

Endpoint

/models

Показывает модели AI Gateway: provider availability, context length, pricing, capabilities и data policy metadata.

Авторизация

Bearer необязателен

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает provider model metadata, capabilities, pricing, context limits, availability и data policy где доступно.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

GET

Endpoint

/rico/models

Показывает RICO recipes, workflows и effect presets. Optional filters: recipe, workflow, effect.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Optional `type` query parameter фильтрует catalog по models, recipes, workflows или effects.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/models/:id

Показывает один RICO recipe, workflow, model или effect preset по id.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/workflows

Показывает recipes и разрешённые executor workflows RICO Supercomputer для web, MCP, CLI и API.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/recipes

Показывает только recipes RICO Supercomputer.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/chat/completions

Запускает OpenAI/OpenRouter-compatible chat completions через GRIKAI AI Gateway со streaming, tools, fallbacks и provider routing.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

OpenAI-compatible chat request: `model`, optional `models`, `provider`, `messages`, `stream`, tools и sampling fields.

Ответ

Возвращает или stream-ит OpenAI-compatible chat completion response. Non-stream responses включают AI Gateway charge/provider headers.

Ошибки

AI Gateway chat errors используют OpenAI-compatible `error.type`, `error.code`, `error.message`; важные retry/billing signals: `402`, `429`, `502`, `503`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
POST

Endpoint

/responses

Запускает OpenAI Responses-compatible requests через GRIKAI AI Gateway с тем же model catalog, routing, fallbacks и usage billing.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

OpenAI Responses-compatible request: `model`, `input`, optional `models`, `provider`, `stream`, tools, instructions и `max_output_tokens`.

Ответ

Возвращает или stream-ит OpenAI Responses-compatible response. Non-stream responses включают AI Gateway charge/provider headers.

Ошибки

AI Gateway chat errors используют OpenAI-compatible `error.type`, `error.code`, `error.message`; важные retry/billing signals: `402`, `429`, `502`, `503`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
POST

Endpoint

/responses/input_tokens

Считает входные токены Responses до запуска. Для моделей OpenAI используется upstream token count, для остальных providers возвращается estimate.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

OpenAI Responses-compatible request: `model`, `input`, optional `models`, `provider`, `stream`, tools, instructions и `max_output_tokens`.

Ответ

Возвращает `input_tokens`, model/provider metadata, `estimated`, `estimate_method` и context length.

Ошибки

AI Gateway chat errors используют OpenAI-compatible `error.type`, `error.code`, `error.message`; важные retry/billing signals: `402`, `429`, `502`, `503`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Вызывайте до upstream hosted model execution, чтобы оценить токены, стоимость, баланс или approval state до платного запроса.
GET

Endpoint

/ai-gateway/balance

Возвращает balance_micros, pending reservation micros, available balance и USD display values.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает `balance_micros`, pending reservations, available balance, currency и unit metadata.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
GET

Endpoint

/ai-gateway/pricing

Возвращает AI Gateway packages, platform fee, minimum charge и видимые клиенту model pricing.

Авторизация

Bearer необязателен

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает AI Gateway packages, platform fee basis points, minimum charge, model rates и chat/responses endpoint URLs.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Pricing values приходят из backend config endpoints; не копируйте static tables в client code.
POST

Endpoint

/ai-gateway/quote

Оценивает токены, стоимость для клиента, доступный баланс, spend-limit decision и fallback-route charge до запуска. Баланс не резервируется и не списывается.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`endpoint`, `model`, `input` или `messages`, optional fallback `models`, `provider` routing и `max_output_tokens`/`max_tokens`. Quote read-only и не резервирует баланс.

Ответ

Возвращает estimated input/output tokens, customer charge, available balance, spend-limit decision, pricing и candidate route breakdown без списания баланса.

Ошибки

AI Gateway chat errors используют OpenAI-compatible `error.type`, `error.code`, `error.message`; важные retry/billing signals: `402`, `429`, `502`, `503`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Вызывайте до upstream hosted model execution, чтобы оценить токены, стоимость, баланс или approval state до платного запроса.
GET

Endpoint

/ai-gateway/usage

Показывает AI Gateway usage events с filters по provider, model, status, date и limit.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Optional query parameters: `status`, `model`, `from`, `to` и `limit`.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает usage/reservation events с provider, model, token counts, charge, route attempts, status и metadata.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
GET

Endpoint

/ai-gateway/usage/:id

Возвращает один usage event с token counts, provider cost, platform fee, charge, route attempts и metadata.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает usage/reservation events с provider, model, token counts, charge, route attempts, status и metadata.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
GET

Endpoint

/ai-gateway/reservations

Показывает active, failed и settled preflight reservations для idempotency и pending-balance debugging.

Авторизация

API key

Область API-ключа

ai.gateway

Аудитория

Разработчики

Параметры

Optional query parameters: `status`, `model`, `from`, `to` и `limit`.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает usage/reservation events с provider, model, token counts, charge, route attempts, status и metadata.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
GET

Endpoint

/keys

Показывает account API keys без raw secret.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает API key records с prefix/last4 и controls, без raw secrets.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

POST

Endpoint

/keys

Создаёт API key с ai.gateway scope и optional spend controls. Raw key возвращается только один раз.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`name`, `scopes`, optional `product`, `mode`, `environment`, `spend_limit_micros`, `spend_reset_interval`.

Ответ

Возвращает API key record и raw key только один раз. Сохраните его сразу.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

PATCH

Endpoint

/keys/:id

Обновляет key name, status, scopes, environment, spend limit или reset interval без rotation секрета.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

Любые mutable API key metadata: `name`, `scopes`, `status`, `environment`, `spend_limit_micros`, `spend_reset_interval`.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

DELETE

Endpoint

/keys/:id

Отзывает API key по id.

Авторизация

User token

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

GET

Endpoint

/billing/credits

Возвращает product credit wallets плюс ai_gateway_balance_micros.

Авторизация

API key

Область API-ключа

billing.read

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает payment, subscription, entitlement, transaction, wallet или provider status records.

Ошибки

Billing endpoints возвращают structured API errors: `invalid_request`, `payment_provider_not_configured`, `payment_provider_unavailable`, `not_found`, `provider_unavailable`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
GET

Endpoint

/billing/transactions

Показывает billing transactions с optional product filter.

Авторизация

API key

Область API-ключа

billing.read

Аудитория

Разработчики

Параметры

Optional query parameters: `limit` (default 50, max 100) и `product`, например `ai_gateway`.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает payment, subscription, entitlement, transaction, wallet или provider status records.

Ошибки

Billing endpoints возвращают structured API errors: `invalid_request`, `payment_provider_not_configured`, `payment_provider_unavailable`, `not_found`, `provider_unavailable`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
GET

Endpoint

/billing/entitlements

Возвращает active subscriptions и period-end cancellation fields.

Авторизация

API key

Область API-ключа

billing.read

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает payment, subscription, entitlement, transaction, wallet или provider status records.

Ошибки

Billing endpoints возвращают structured API errors: `invalid_request`, `payment_provider_not_configured`, `payment_provider_unavailable`, `not_found`, `provider_unavailable`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
POST

Endpoint

/rico/sessions

Создаёт RICO Supercomputer session с brief, recipe, inputs, cost estimate, messages и pending steps.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Optional `limit` query parameter ограничивает recent rows. Gateway режет слишком большие limits.

Тело запроса

`workflow`, optional `brief`, `channel`, `inputs`, `attached_asset_ids`, `auto_run_limit`.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/rico/sessions/:id/approve

Подтверждает RICO Supercomputer session, списывает RICO media credits и ставит deterministic execution в очередь.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON object. Точные поля операции смотрите в OpenAPI schema.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/rico/mcp

Вызывает RICO MCP endpoint с tools вроде rico_estimate_cost, rico_apply_effect, rico_repurpose и rico_get_job.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON-RPC style MCP request или direct tool call с `tool`/`name` и `arguments`.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/generate/video

Запускает text-to-video или image-to-video generation с model, aspect ratio, duration, mode, image URL и sound options.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`prompt` required. Optional: `model`, `model_name`, `aspect_ratio`, image/video inputs, `mode`, `duration`, `sound`, `external_task_id`, `callback_url`.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/videos/effects

Ставит Kling Video Effects Center task в очередь по effect_scene с single-image или dual-image input.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`effect_scene` и `input.image` или ровно два `input.images` required. Top-level `image`/`images` нормализуются в `input`.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/lipsync

Ставит Kling advanced lip-sync в очередь и отслеживает его через реестр provider tasks.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/multi-elements

Ставит Kling multi-elements video editing task в очередь.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose

Запускает repurposing pipeline из YouTube или file URL с optional language.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`url` required; `language` optional.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/sessions

Показывает recent RICO Supercomputer sessions для authenticated account.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Optional `limit` query parameter ограничивает recent rows. Gateway режет слишком большие limits.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/sessions/:id

Возвращает RICO Supercomputer session с messages, workflow steps, status и current assets.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/sessions/:id/events

Возвращает polling-friendly RICO session timeline с messages, steps и assets.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/rico/sessions/:id/messages

Добавляет user или assistant message в существующую RICO session.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

`content` required. Optional `workflow`, `inputs`, `attached_asset_ids` могут продвинуть session.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/sessions/:id/assets

Показывает media assets, созданные RICO Supercomputer session.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/assets

Показывает recent RICO media assets.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Optional `limit` query parameter ограничивает recent rows. Gateway режет слишком большие limits.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/rico/assets

Загружает или регистрирует RICO media asset через multipart file, URL или data URL.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Optional `limit` query parameter ограничивает recent rows. Gateway режет слишком большие limits.

Тело запроса

JSON принимает `url`, `media_url`, `data_url`, `type`, `title`, `prompt`, `source_id`, `parent_project_id`, `metadata`; multipart использует field `file` плюс form fields.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/rico/assets/:id

Показывает один RICO media asset по id.

Авторизация

API key

Область API-ключа

rico.media or video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает RICO models, sessions, messages, assets, timeline events или MCP tool results в зависимости от операции.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/generation/:id

Возвращает generation record, status, output video URL, metadata, file size и error message.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/tasks/:id

Возвращает любую Kling provider task по local task ID, provider task ID или external task ID.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает stored provider task по local id, provider task id или `external_task_id`.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/repurpose

Показывает recent repurpose jobs.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/repurpose/:id

Возвращает repurposing task с rendered clips, transcripts, segments, viral scores и output URLs.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose/:id/retry

Повторяет failed repurpose job.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON object. Точные поля операции смотрите в OpenAPI schema.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
DELETE

Endpoint

/repurpose/:id

Удаляет repurpose job по id.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
PUT

Endpoint

/repurpose/:task_id/clip/:clip_id

Обновляет clip edit state для repurpose task.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters `task_id` и `clip_id` идентифицируют repurpose project и clip для edit/render.

Тело запроса

Optional editable clip fields: `title`, `transcript`, `segments`, `caption_settings`, `timeline_edit`.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose/:task_id/clip/:clip_id/render-captions

Рендерит repurpose clip с timeline edits и optional burned captions.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters `task_id` и `clip_id` идентифицируют repurpose project и clip для edit/render.

Тело запроса

Optional `caption_settings` и `timeline_edit`. Если body пустой, берутся сохранённые clip settings; caption settings должны существовать до render.

Ответ

Возвращает stored generation или repurpose record с current status, outputs, clips, metadata и errors где доступны.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/images/generate

Генерирует images по prompt, reference image, palette, model и resolution. Kling models идут через реестр provider tasks.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`prompt` или `image_url` required для non-Kling image jobs. Kling models используют `prompt`, `model_name`, references, `n`, `resolution`, `aspect_ratio`.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/images/generations

Ставит Kling image generation в очередь напрямую с model_name, n, aspect ratio, references и provider task status.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`prompt` required. Optional Kling fields: `model_name`, `negative_prompt`, `image`, `image_reference`, `n`, `resolution`, `aspect_ratio`, `external_task_id`.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/general/ai-multi-shot

Ставит Kling AI Multi-Shot в очередь по одному frontal image и сохраняет все returned shots в media library.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`element_frontal_image` required. Остальные provider fields проходят в Kling.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/images/kolors-virtual-try-on

Ставит Kling Kolors virtual try-on в очередь с human и cloth images.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`human_image` и `cloth_image` required. Остальные provider fields проходят в Kling.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/images/edit

Редактирует image по prompt и source image URL.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`image_url` required; `prompt` описывает edit.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/images/enhance

Улучшает или upscale image asset.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`image_url` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/images/faceswap

Делает face swap между target и source images.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`target_image` и `swap_image` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/images/3d-angles

Генерирует 3D/360-style video из image.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`image_url` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/images/character-gen

Создает consistent character из prompt и optional reference image.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`image_url` и `prompt` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/image-recognize

Запускает Kling image recognition и segmentation utilities для object, head, face и clothing masks.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/audio/text-to-audio

Ставит Kling text-to-audio generation в очередь и сохраняет audio в media library.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/audio/video-to-audio

Ставит Kling video-to-audio generation в очередь для переданного video source.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/lipsync/identify-face

Определяет faces для Kling lip-sync workflows перед созданием final lip-sync task.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/voices

Создает Kling custom voice task.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/voices

Показывает Kling custom voices.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/voices/:id

Показывает одну Kling custom voice task по id.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/voices/delete

Ставит удаление Kling custom voice в очередь.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/voices/presets

Показывает Kling preset voices для audio и avatar tools.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/elements

Создает Kling advanced custom elements для multi-element video editing.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/elements

Показывает Kling advanced custom elements.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/elements/:id

Показывает один Kling advanced custom element по id.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/multi-elements/init-selection

Инициализирует Kling multi-elements selections для editing workflows.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/multi-elements/add-selection

Добавляет Kling multi-elements selection.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/multi-elements/delete-selection

Удаляет Kling multi-elements selection.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/multi-elements/clear-selection

Очищает все Kling multi-elements selections.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/kling/multi-elements/preview-selection

Preview Kling multi-elements selection.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider-shaped JSON object. Gateway injects route `task_type`, strips data URL prefixes и передаёт остальные поля в Kling worker.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/multi-elements

Показывает Kling multi-elements tasks.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/kling/multi-elements/:id

Показывает одну Kling multi-elements task по id.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает local provider task id, provider, `task_type`, `external_task_id`, status и credit fields для charged Kling tools.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta provider passthrough route: gateway validations описаны, но extra payload fields следуют Kling/provider semantics.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose/tts

Генерирует speech audio из text и voice selection.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`text` required; `voice` optional.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose/enhance-audio

Ставит audio enhancement для source video в очередь.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`video_url` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose/lipsync

Синхронизирует video с переданным audio track.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`video_url` и `audio_url` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/repurpose/recast

Заменяет или recast персонажа в source video по target image.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`video_url` и `target_image` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/video/transitions

Создаёт transitions между двумя или более input video URLs.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`video_urls` должен содержать минимум два videos.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/video/edit

Редактирует existing video по natural-language prompt.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`video_url` и `prompt` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/ads/generate

Генерирует ad creative из product URL.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`product_url` required.

Ответ

Возвращает `task_id`, queued status, credit fields при списании и timestamps где реализовано.

Ошибки

Часть legacy media handlers всё ещё возвращает string error body; clients должны поддерживать string и structured error bodies.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/broll/search

Ищет B-roll media для repurpose и editing workflows.

Авторизация

API key

Область API-ключа

video

Аудитория

Разработчики

Параметры

Required `query` query parameter ищет B-roll у provider.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/ricochet/budget

Проверяет ricochet_code credits, plan, window limits, task limits и upgrade URL перед hosted AI run.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Optional `task_id`, `run_id` или `session_id` query parameter ограничивает budget check одним hosted run.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает credits, plan/budget windows, task limits, approval requirements и upgrade URL.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/ricochet/usage/quote

Считает и резервирует hosted Ricochet usage перед upstream model call.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Usage preflight fields: `idempotency_key`, `session_id`, `run_id`, `turn_id`, `provider`, `model`, `key_source`, token estimates, `operation`.

Ответ

Возвращает quote, reservation или settled usage details плюс decision flags вроде `approval_required` или `budget_exceeded`.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Вызывайте до upstream hosted model execution, чтобы оценить токены, стоимость, баланс или approval state до платного запроса.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/ricochet/usage/report

Отправляет hosted model usage с idempotency, token counts, provider, model и billing metadata.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Usage settlement fields: `reservation_id`, `idempotency_key`, session/run ids, provider/model, key source, token counts, source metadata.

Ответ

Возвращает quote, reservation или settled usage details плюс decision flags вроде `approval_required` или `budget_exceeded`.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/ricochet/usage

Показывает Ricochet hosted usage events с filters по session, run, provider, model и limit.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Optional query parameters: `session_id`, `run_id`, `provider`, `model` и `limit`.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/ricochet/usage/approve-premium

Сохраняет temporary approval для premium model usage в task, run или session.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`task_id`, `run_id` или `session_id` указывает premium approval target; можно передать approval metadata.

Ответ

Возвращает quote, reservation или settled usage details плюс decision flags вроде `approval_required` или `budget_exceeded`.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/ricochet/sessions

Показывает Ricochet IDE и device sessions для current user.

Авторизация

User token

Область API-ключа

-

Аудитория

Ricochet-клиенты

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

DELETE

Endpoint

/ricochet/sessions/:id

Отзывает Ricochet IDE или device session.

Авторизация

User token

Область API-ключа

-

Аудитория

Ricochet-клиенты

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает resource или list, описанный операцией.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

POST

Endpoint

/ricochet/openai/v1/chat/completions

Legacy alias для Ricochet hosted coding chat completions. Для новых generic model integrations используйте /chat/completions в AI Gateway.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

OpenAI-compatible chat request: `model`, optional `models`, `provider`, `messages`, `stream`, tools и sampling fields.

Ответ

Возвращает или stream-ит OpenAI-compatible chat completion response. Non-stream responses включают AI Gateway charge/provider headers.

Ошибки

AI Gateway chat errors используют OpenAI-compatible `error.type`, `error.code`, `error.message`; важные retry/billing signals: `402`, `429`, `502`, `503`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Compatibility endpoint для существующих Ricochet clients; новые generic model integrations должны использовать AI Gateway route.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
POST

Endpoint

/ricochet/openai/v1/responses

Ricochet hosted coding Responses API alias для клиентов, которые используют OpenAI Responses.

Авторизация

API key

Область API-ключа

ricochet_code

Аудитория

Ricochet-клиенты

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

OpenAI Responses-compatible request: `model`, `input`, optional `models`, `provider`, `stream`, tools, instructions и `max_output_tokens`.

Ответ

Возвращает или stream-ит OpenAI Responses-compatible response. Non-stream responses включают AI Gateway charge/provider headers.

Ошибки

AI Gateway chat errors используют OpenAI-compatible `error.type`, `error.code`, `error.message`; важные retry/billing signals: `402`, `429`, `502`, `503`.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Compatibility endpoint для существующих Ricochet clients; новые generic model integrations должны использовать AI Gateway route.
  • `Idempotency-Key` реализован для этого create/hosted-usage flow и должен быть стабильным на одно user action.
  • Может списывать video, Ricochet или media credits. Успешные charged responses возвращают `credits_deducted`, `remaining_credits` или usage decision fields где реализовано.
GET

Endpoint

/social/accounts

Показывает social accounts текущего пользователя.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
POST

Endpoint

/social/accounts/connect

Создаёт social account record для YouTube, Instagram, TikTok, LinkedIn, X или Facebook.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`provider`, `provider_id`, `name`, optional `avatar_url`. Текущий handler сохраняет mock token.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
DELETE

Endpoint

/social/accounts/:id

Отключает social account по id.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
GET

Endpoint

/social/posts

Показывает scheduled posts с optional date range filters.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Optional `start` и `end` query parameters фильтруют scheduled posts по date/time.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
POST

Endpoint

/social/posts

Создаёт draft или scheduled post с content, hashtags, media, accounts и platform options.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Optional `start` и `end` query parameters фильтруют scheduled posts по date/time.

Тело запроса

`content`, `hashtags`, `media_id`, `media_type`, optional `scheduled_at`, `account_ids`, `platform_options`.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
PUT

Endpoint

/social/posts/:id

Обновляет post content, hashtags, schedule или status.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

Mutable fields: `content`, `hashtags`, `scheduled_at`, `status`.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
DELETE

Endpoint

/social/posts/:id

Удаляет scheduled post и очищает account associations.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameter `id` идентифицирует API key, job, session, payment, subscription, model или provider resource.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
POST

Endpoint

/social/generate-caption

Генерирует social caption из transcript или media id.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`transcript` или `media_id`; media id fallback читает transcript сохранённого clip.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
POST

Endpoint

/social/upload

Загружает MP4 для social publishing workflows.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Multipart form field `file`; только MP4, максимум 200 MB.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
POST

Endpoint

/import/auto

Регистрирует platform channel или folder для automated video import monitoring.

Авторизация

API key

Область API-ключа

social

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`platform` и `channel` идентифицируют monitored source.

Ответ

Возвращает social account, post, caption, upload или auto-import status objects из текущей beta implementation.

Ошибки

Social beta routes могут возвращать legacy string errors для validation, provider configuration, upload или database failures.

Заметки по операции

  • Указанный scope проверяется для API keys. User bearer tokens аутентифицируются отдельно и не несут API-key scopes.
  • Advanced/Beta route: части social integration сейчас mock или provider-dependent.
GET

Endpoint

/config/pricing

Возвращает generation costs, subscription plans, credit packages, Ricochet plans и model billing policy из pricing.yaml.

Авторизация

Нет

Область API-ключа

-

Аудитория

Разработчики

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает `pricing.yaml` backed generation costs, subscriptions, credit packages, Ricochet plans, storage policy и model billing policy.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Pricing values приходят из backend config endpoints; не копируйте static tables в client code.
POST/auth/device/code

Создает device code, user code, verification URL, срок действия и polling interval.

Авторизация: НетОбласть: -Аудитория: Разработчики
POST/auth/device/token

Меняет approved device code на access и refresh tokens.

Авторизация: НетОбласть: -Аудитория: Разработчики
POST/auth/refresh

Ротирует refresh token и выдает новый access token.

Авторизация: НетОбласть: -Аудитория: Разработчики
GET/users/me

Возвращает authenticated user profile для billing и ownership.

Авторизация: Bearer tokenОбласть: -Аудитория: Разработчики
POST/auth/api-keys

Выпускает organization API key вида grik_live_... для server-side integrations.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
GET/auth/api-keys

Показывает active и revoked API keys без raw secret.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
PATCH/auth/api-keys/:id

Обновляет key metadata, scopes, environment, status или spend controls без раскрытия raw secret.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
DELETE/auth/api-keys/:id

Отзывает API key по id. Revoked keys сразу перестают проходить auth.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
GET/models

Показывает модели AI Gateway: provider availability, context length, pricing, capabilities и data policy metadata.

Авторизация: Bearer необязателенОбласть: -Аудитория: Разработчики
GET/rico/models

Показывает RICO recipes, workflows и effect presets. Optional filters: recipe, workflow, effect.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/models/:id

Показывает один RICO recipe, workflow, model или effect preset по id.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/workflows

Показывает recipes и разрешённые executor workflows RICO Supercomputer для web, MCP, CLI и API.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/recipes

Показывает только recipes RICO Supercomputer.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
POST/chat/completions

Запускает OpenAI/OpenRouter-compatible chat completions через GRIKAI AI Gateway со streaming, tools, fallbacks и provider routing.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
POST/responses

Запускает OpenAI Responses-compatible requests через GRIKAI AI Gateway с тем же model catalog, routing, fallbacks и usage billing.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
POST/responses/input_tokens

Считает входные токены Responses до запуска. Для моделей OpenAI используется upstream token count, для остальных providers возвращается estimate.Используйте перед upstream hosted-model вызовом.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
GET/ai-gateway/balance

Возвращает balance_micros, pending reservation micros, available balance и USD display values.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
GET/ai-gateway/pricing

Возвращает AI Gateway packages, platform fee, minimum charge и видимые клиенту model pricing.

Авторизация: Bearer необязателенОбласть: -Аудитория: Разработчики
POST/ai-gateway/quote

Оценивает токены, стоимость для клиента, доступный баланс, spend-limit decision и fallback-route charge до запуска. Баланс не резервируется и не списывается.Используйте перед upstream hosted-model вызовом.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
GET/ai-gateway/usage

Показывает AI Gateway usage events с filters по provider, model, status, date и limit.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
GET/ai-gateway/usage/:id

Возвращает один usage event с token counts, provider cost, platform fee, charge, route attempts и metadata.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
GET/ai-gateway/reservations

Показывает active, failed и settled preflight reservations для idempotency и pending-balance debugging.

Авторизация: API keyОбласть: ai.gatewayАудитория: Разработчики
GET/keys

Показывает account API keys без raw secret.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
POST/keys

Создаёт API key с ai.gateway scope и optional spend controls. Raw key возвращается только один раз.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
PATCH/keys/:id

Обновляет key name, status, scopes, environment, spend limit или reset interval без rotation секрета.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
DELETE/keys/:id

Отзывает API key по id.

Авторизация: User tokenОбласть: -Аудитория: Разработчики
GET/billing/credits

Возвращает product credit wallets плюс ai_gateway_balance_micros.

Авторизация: API keyОбласть: billing.readАудитория: Разработчики
GET/billing/transactions

Показывает billing transactions с optional product filter.

Авторизация: API keyОбласть: billing.readАудитория: Разработчики
GET/billing/entitlements

Возвращает active subscriptions и period-end cancellation fields.

Авторизация: API keyОбласть: billing.readАудитория: Разработчики
POST/rico/sessions

Создаёт RICO Supercomputer session с brief, recipe, inputs, cost estimate, messages и pending steps.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
POST/rico/sessions/:id/approve

Подтверждает RICO Supercomputer session, списывает RICO media credits и ставит deterministic execution в очередь.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
POST/rico/mcp

Вызывает RICO MCP endpoint с tools вроде rico_estimate_cost, rico_apply_effect, rico_repurpose и rico_get_job.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
POST/generate/video

Запускает text-to-video или image-to-video generation с model, aspect ratio, duration, mode, image URL и sound options.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/videos/effects

Ставит Kling Video Effects Center task в очередь по effect_scene с single-image или dual-image input.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/lipsync

Ставит Kling advanced lip-sync в очередь и отслеживает его через реестр provider tasks.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/multi-elements

Ставит Kling multi-elements video editing task в очередь.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose

Запускает repurposing pipeline из YouTube или file URL с optional language.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/rico/sessions

Показывает recent RICO Supercomputer sessions для authenticated account.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/sessions/:id

Возвращает RICO Supercomputer session с messages, workflow steps, status и current assets.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/sessions/:id/events

Возвращает polling-friendly RICO session timeline с messages, steps и assets.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
POST/rico/sessions/:id/messages

Добавляет user или assistant message в существующую RICO session.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/sessions/:id/assets

Показывает media assets, созданные RICO Supercomputer session.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/assets

Показывает recent RICO media assets.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
POST/rico/assets

Загружает или регистрирует RICO media asset через multipart file, URL или data URL.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/rico/assets/:id

Показывает один RICO media asset по id.

Авторизация: API keyОбласть: rico.media or videoАудитория: Разработчики
GET/generation/:id

Возвращает generation record, status, output video URL, metadata, file size и error message.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/tasks/:id

Возвращает любую Kling provider task по local task ID, provider task ID или external task ID.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/repurpose

Показывает recent repurpose jobs.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/repurpose/:id

Возвращает repurposing task с rendered clips, transcripts, segments, viral scores и output URLs.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose/:id/retry

Повторяет failed repurpose job.

Авторизация: API keyОбласть: videoАудитория: Разработчики
DELETE/repurpose/:id

Удаляет repurpose job по id.

Авторизация: API keyОбласть: videoАудитория: Разработчики
PUT/repurpose/:task_id/clip/:clip_id

Обновляет clip edit state для repurpose task.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose/:task_id/clip/:clip_id/render-captions

Рендерит repurpose clip с timeline edits и optional burned captions.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/images/generate

Генерирует images по prompt, reference image, palette, model и resolution. Kling models идут через реестр provider tasks.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/images/generations

Ставит Kling image generation в очередь напрямую с model_name, n, aspect ratio, references и provider task status.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/general/ai-multi-shot

Ставит Kling AI Multi-Shot в очередь по одному frontal image и сохраняет все returned shots в media library.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/images/kolors-virtual-try-on

Ставит Kling Kolors virtual try-on в очередь с human и cloth images.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/images/edit

Редактирует image по prompt и source image URL.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/images/enhance

Улучшает или upscale image asset.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/images/faceswap

Делает face swap между target и source images.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/images/3d-angles

Генерирует 3D/360-style video из image.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/images/character-gen

Создает consistent character из prompt и optional reference image.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/image-recognize

Запускает Kling image recognition и segmentation utilities для object, head, face и clothing masks.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/audio/text-to-audio

Ставит Kling text-to-audio generation в очередь и сохраняет audio в media library.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/audio/video-to-audio

Ставит Kling video-to-audio generation в очередь для переданного video source.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/lipsync/identify-face

Определяет faces для Kling lip-sync workflows перед созданием final lip-sync task.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/voices

Создает Kling custom voice task.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/voices

Показывает Kling custom voices.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/voices/:id

Показывает одну Kling custom voice task по id.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/voices/delete

Ставит удаление Kling custom voice в очередь.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/voices/presets

Показывает Kling preset voices для audio и avatar tools.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/elements

Создает Kling advanced custom elements для multi-element video editing.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/elements

Показывает Kling advanced custom elements.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/elements/:id

Показывает один Kling advanced custom element по id.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/multi-elements/init-selection

Инициализирует Kling multi-elements selections для editing workflows.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/multi-elements/add-selection

Добавляет Kling multi-elements selection.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/multi-elements/delete-selection

Удаляет Kling multi-elements selection.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/multi-elements/clear-selection

Очищает все Kling multi-elements selections.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/kling/multi-elements/preview-selection

Preview Kling multi-elements selection.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/multi-elements

Показывает Kling multi-elements tasks.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/kling/multi-elements/:id

Показывает одну Kling multi-elements task по id.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose/tts

Генерирует speech audio из text и voice selection.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose/enhance-audio

Ставит audio enhancement для source video в очередь.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose/lipsync

Синхронизирует video с переданным audio track.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/repurpose/recast

Заменяет или recast персонажа в source video по target image.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/video/transitions

Создаёт transitions между двумя или более input video URLs.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/video/edit

Редактирует existing video по natural-language prompt.

Авторизация: API keyОбласть: videoАудитория: Разработчики
POST/ads/generate

Генерирует ad creative из product URL.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/broll/search

Ищет B-roll media для repurpose и editing workflows.

Авторизация: API keyОбласть: videoАудитория: Разработчики
GET/ricochet/budget

Проверяет ricochet_code credits, plan, window limits, task limits и upgrade URL перед hosted AI run.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
POST/ricochet/usage/quote

Считает и резервирует hosted Ricochet usage перед upstream model call.Используйте перед upstream hosted-model вызовом.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
POST/ricochet/usage/report

Отправляет hosted model usage с idempotency, token counts, provider, model и billing metadata.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
GET/ricochet/usage

Показывает Ricochet hosted usage events с filters по session, run, provider, model и limit.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
POST/ricochet/usage/approve-premium

Сохраняет temporary approval для premium model usage в task, run или session.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
GET/ricochet/sessions

Показывает Ricochet IDE и device sessions для current user.

Авторизация: User tokenОбласть: -Аудитория: Ricochet-клиенты
DELETE/ricochet/sessions/:id

Отзывает Ricochet IDE или device session.

Авторизация: User tokenОбласть: -Аудитория: Ricochet-клиенты
POST/ricochet/openai/v1/chat/completions

Legacy alias для Ricochet hosted coding chat completions. Для новых generic model integrations используйте /chat/completions в AI Gateway.Совместимый route для существующих Ricochet-клиентов.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
POST/ricochet/openai/v1/responses

Ricochet hosted coding Responses API alias для клиентов, которые используют OpenAI Responses.Совместимый route для существующих Ricochet-клиентов.

Авторизация: API keyОбласть: ricochet_codeАудитория: Ricochet-клиенты
GET/social/accounts

Показывает social accounts текущего пользователя.

Авторизация: API keyОбласть: socialАудитория: Разработчики
POST/social/accounts/connect

Создаёт social account record для YouTube, Instagram, TikTok, LinkedIn, X или Facebook.

Авторизация: API keyОбласть: socialАудитория: Разработчики
DELETE/social/accounts/:id

Отключает social account по id.

Авторизация: API keyОбласть: socialАудитория: Разработчики
GET/social/posts

Показывает scheduled posts с optional date range filters.

Авторизация: API keyОбласть: socialАудитория: Разработчики
POST/social/posts

Создаёт draft или scheduled post с content, hashtags, media, accounts и platform options.

Авторизация: API keyОбласть: socialАудитория: Разработчики
PUT/social/posts/:id

Обновляет post content, hashtags, schedule или status.

Авторизация: API keyОбласть: socialАудитория: Разработчики
DELETE/social/posts/:id

Удаляет scheduled post и очищает account associations.

Авторизация: API keyОбласть: socialАудитория: Разработчики
POST/social/generate-caption

Генерирует social caption из transcript или media id.

Авторизация: API keyОбласть: socialАудитория: Разработчики
POST/social/upload

Загружает MP4 для social publishing workflows.

Авторизация: API keyОбласть: socialАудитория: Разработчики
POST/import/auto

Регистрирует platform channel или folder для automated video import monitoring.

Авторизация: API keyОбласть: socialАудитория: Разработчики
GET/config/pricing

Возвращает generation costs, subscription plans, credit packages, Ricochet plans и model billing policy из pricing.yaml.

Авторизация: НетОбласть: -Аудитория: Разработчики

Маршруты web session

Browser-session routes вынесены отдельно: они зависят от signed-in web session и не являются starter server-side API-key интеграциями.

GET

Endpoint

/gallery

Показывает media gallery items для current logged-in user.

Авторизация

Bearer token

Область API-ключа

-

Аудитория

Web session

Параметры

Browser route filters: `kind`, `status`, `sort`, `q`, `limit`, `offset`.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает browser-session data для signed-in user.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Browser-session route. Используйте его из signed-in web app, а не из server-side API-key integrations.
GET

Endpoint

/user/storage

Возвращает storage usage для current logged-in user.

Авторизация

Bearer token

Область API-ключа

-

Аудитория

Web session

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON request body отсутствует.

Ответ

Возвращает browser-session data для signed-in user.

Ошибки

Standard API errors используют structured error body с code и message для auth, scope, not found, conflict, rate limit и internal failures.

Заметки по операции

  • Browser-session route. Используйте его из signed-in web app, а не из server-side API-key integrations.
GET/gallery

Показывает media gallery items для current logged-in user.

Авторизация: Bearer tokenОбласть: -Аудитория: Web session
GET/user/storage

Возвращает storage usage для current logged-in user.

Авторизация: Bearer tokenОбласть: -Аудитория: Web session

Callbacks и внутренние маршруты

Callbacks и internal approval routes доступны по сети, но их должны вызывать только providers или trusted Grik services.

POST

Endpoint

/internal/notifications

Internal route сервиса GRIKAI для постановки notifications в очередь. Не является client integration endpoint.

Авторизация

Внутренний

Область API-ключа

-

Аудитория

Внутренний

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

JSON object. Точные поля операции смотрите в OpenAPI schema.

Ответ

Возвращает acknowledgement status или provider-specific webhook processing metadata.

Ошибки

Callback/internal routes используют provider или internal-secret validation errors и не являются обычной client retry surface.

Заметки по операции

  • Callback/internal route. Он публичен в сети, но не является обычным client API.
POST

Endpoint

/webhooks/mailgun

Mailgun provider webhook для email delivery и event notifications.

Авторизация

Подписанный callback

Область API-ключа

-

Аудитория

Callbacks

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider callback payload. Не вызывайте из client integrations.

Ответ

Возвращает acknowledgement status или provider-specific webhook processing metadata.

Ошибки

Callback/internal routes используют provider или internal-secret validation errors и не являются обычной client retry surface.

Заметки по операции

  • Callback/internal route. Он публичен в сети, но не является обычным client API.
POST

Endpoint

/auth/device/approve

Internal web approval route, который связывает browser-approved device code с Grik user.

Авторизация

Внутренний

Область API-ключа

-

Аудитория

Внутренний

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

`user_code` плюс authenticated user context или internal `user_id`/`email`. Это не обычный client integration endpoint.

Ответ

Возвращает acknowledgement status или provider-specific webhook processing metadata.

Ошибки

Callback/internal routes используют provider или internal-secret validation errors и не являются обычной client retry surface.

Заметки по операции

  • Callback/internal route. Он публичен в сети, но не является обычным client API.
POST

Endpoint

/provider-callbacks/kling

Kling provider callback для settlement asynchronous task status.

Авторизация

Подписанный callback

Область API-ключа

-

Аудитория

Callbacks

Параметры

Kling provider callbacks требуют `token` query parameter, совпадающий с `KLING_CALLBACK_TOKEN`.

Тело запроса

Provider callback payload. Не вызывайте из client integrations.

Ответ

Возвращает acknowledgement status или provider-specific webhook processing metadata.

Ошибки

Callback/internal routes используют provider или internal-secret validation errors и не являются обычной client retry surface.

Заметки по операции

  • Callback/internal route. Он публичен в сети, но не является обычным client API.
POST

Endpoint

/billing/passimpay/webhook

PassimPay billing webhook для idempotent payment settlement.

Авторизация

Подписанный callback

Область API-ключа

-

Аудитория

Callbacks

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider callback payload. Не вызывайте из client integrations.

Ответ

Возвращает acknowledgement status или provider-specific webhook processing metadata.

Ошибки

Billing endpoints возвращают structured API errors: `invalid_request`, `payment_provider_not_configured`, `payment_provider_unavailable`, `not_found`, `provider_unavailable`.

Заметки по операции

  • Callback/internal route. Он публичен в сети, но не является обычным client API.
POST

Endpoint

/billing/paypal/webhook

PayPal billing webhook для verified payment и subscription settlement.

Авторизация

Подписанный callback

Область API-ключа

-

Аудитория

Callbacks

Параметры

Path parameters отсутствуют. Некоторые list endpoints поддерживают optional filters, которые описаны в OpenAPI.

Тело запроса

Provider callback payload. Не вызывайте из client integrations.

Ответ

Возвращает acknowledgement status или provider-specific webhook processing metadata.

Ошибки

Billing endpoints возвращают structured API errors: `invalid_request`, `payment_provider_not_configured`, `payment_provider_unavailable`, `not_found`, `provider_unavailable`.

Заметки по операции

  • Callback/internal route. Он публичен в сети, но не является обычным client API.
POST/internal/notifications

Internal route сервиса GRIKAI для постановки notifications в очередь. Не является client integration endpoint.

Авторизация: ВнутреннийОбласть: -Аудитория: Внутренний
POST/webhooks/mailgun

Mailgun provider webhook для email delivery и event notifications.

Авторизация: Подписанный callbackОбласть: -Аудитория: Callbacks
POST/auth/device/approve

Internal web approval route, который связывает browser-approved device code с Grik user.

Авторизация: ВнутреннийОбласть: -Аудитория: Внутренний
POST/provider-callbacks/kling

Kling provider callback для settlement asynchronous task status.

Авторизация: Подписанный callbackОбласть: -Аудитория: Callbacks
POST/billing/passimpay/webhook

PassimPay billing webhook для idempotent payment settlement.

Авторизация: Подписанный callbackОбласть: -Аудитория: Callbacks
POST/billing/paypal/webhook

PayPal billing webhook для verified payment и subscription settlement.

Авторизация: Подписанный callbackОбласть: -Аудитория: Callbacks