Developer API
Справочник API
Справочник по gateway routes: для разработчиков, web session и callback/internal аудиторий.
#Маршруты для разработчиков
Сначала перечислены маршруты для разработчиков, затем для них раскрыты параметры, тело запроса, формат ответа, поведение ошибок и операционные заметки из gateway-кода.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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.
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.
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 до платного запроса.
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.
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.
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 до платного запроса.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
Endpoint
/kling/multi-elements/preview-selectionPreview 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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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 где реализовано.
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.
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.
Endpoint
/ricochet/openai/v1/chat/completionsLegacy 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 где реализовано.
Endpoint
/ricochet/openai/v1/responsesRicochet 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 где реализовано.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
| Метод | Endpoint | Авторизация | Область | Аудитория | Описание |
|---|---|---|---|---|---|
| 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 | Bearer token | - | Разработчики | Возвращает authenticated user profile для billing и ownership. |
| POST | /auth/api-keys | User token | - | Разработчики | Выпускает organization API key вида grik_live_... для server-side integrations. |
| GET | /auth/api-keys | User token | - | Разработчики | Показывает active и revoked API keys без raw secret. |
| PATCH | /auth/api-keys/:id | User token | - | Разработчики | Обновляет key metadata, scopes, environment, status или spend controls без раскрытия raw secret. |
| DELETE | /auth/api-keys/:id | User token | - | Разработчики | Отзывает API key по id. Revoked keys сразу перестают проходить auth. |
| GET | /models | Bearer необязателен | - | Разработчики | Показывает модели AI Gateway: provider availability, context length, pricing, capabilities и data policy metadata. |
| GET | /rico/models | API key | rico.media or video | Разработчики | Показывает RICO recipes, workflows и effect presets. Optional filters: recipe, workflow, effect. |
| GET | /rico/models/:id | API key | rico.media or video | Разработчики | Показывает один RICO recipe, workflow, model или effect preset по id. |
| GET | /rico/workflows | API key | rico.media or video | Разработчики | Показывает recipes и разрешённые executor workflows RICO Supercomputer для web, MCP, CLI и API. |
| GET | /rico/recipes | API key | rico.media or video | Разработчики | Показывает только recipes RICO Supercomputer. |
| POST | /chat/completions | API key | ai.gateway | Разработчики | Запускает OpenAI/OpenRouter-compatible chat completions через GRIKAI AI Gateway со streaming, tools, fallbacks и provider routing.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован. |
| POST | /responses | API key | ai.gateway | Разработчики | Запускает OpenAI Responses-compatible requests через GRIKAI AI Gateway с тем же model catalog, routing, fallbacks и usage billing.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован. |
| POST | /responses/input_tokens | API key | ai.gateway | Разработчики | Считает входные токены Responses до запуска. Для моделей OpenAI используется upstream token count, для остальных providers возвращается estimate.Используйте перед upstream hosted-model вызовом. |
| GET | /ai-gateway/balance | API key | ai.gateway | Разработчики | Возвращает balance_micros, pending reservation micros, available balance и USD display values. |
| GET | /ai-gateway/pricing | Bearer необязателен | - | Разработчики | Возвращает AI Gateway packages, platform fee, minimum charge и видимые клиенту model pricing. |
| POST | /ai-gateway/quote | API key | ai.gateway | Разработчики | Оценивает токены, стоимость для клиента, доступный баланс, spend-limit decision и fallback-route charge до запуска. Баланс не резервируется и не списывается.Используйте перед upstream hosted-model вызовом. |
| GET | /ai-gateway/usage | API key | ai.gateway | Разработчики | Показывает AI Gateway usage events с filters по provider, model, status, date и limit. |
| GET | /ai-gateway/usage/:id | API key | ai.gateway | Разработчики | Возвращает один usage event с token counts, provider cost, platform fee, charge, route attempts и metadata. |
| GET | /ai-gateway/reservations | API key | ai.gateway | Разработчики | Показывает active, failed и settled preflight reservations для idempotency и pending-balance debugging. |
| GET | /keys | User token | - | Разработчики | Показывает account API keys без raw secret. |
| POST | /keys | User token | - | Разработчики | Создаёт API key с ai.gateway scope и optional spend controls. Raw key возвращается только один раз. |
| PATCH | /keys/:id | User token | - | Разработчики | Обновляет key name, status, scopes, environment, spend limit или reset interval без rotation секрета. |
| DELETE | /keys/:id | User token | - | Разработчики | Отзывает API key по id. |
| GET | /billing/credits | API key | billing.read | Разработчики | Возвращает product credit wallets плюс ai_gateway_balance_micros. |
| GET | /billing/transactions | API key | billing.read | Разработчики | Показывает billing transactions с optional product filter. |
| GET | /billing/entitlements | API key | billing.read | Разработчики | Возвращает active subscriptions и period-end cancellation fields. |
| POST | /rico/sessions | API key | rico.media or video | Разработчики | Создаёт RICO Supercomputer session с brief, recipe, inputs, cost estimate, messages и pending steps. |
| POST | /rico/sessions/:id/approve | API key | rico.media or video | Разработчики | Подтверждает RICO Supercomputer session, списывает RICO media credits и ставит deterministic execution в очередь. |
| POST | /rico/mcp | API key | rico.media or video | Разработчики | Вызывает RICO MCP endpoint с tools вроде rico_estimate_cost, rico_apply_effect, rico_repurpose и rico_get_job. |
| POST | /generate/video | API key | video | Разработчики | Запускает text-to-video или image-to-video generation с model, aspect ratio, duration, mode, image URL и sound options.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован. |
| POST | /kling/videos/effects | API key | video | Разработчики | Ставит Kling Video Effects Center task в очередь по effect_scene с single-image или dual-image input. |
| POST | /kling/lipsync | API key | video | Разработчики | Ставит Kling advanced lip-sync в очередь и отслеживает его через реестр provider tasks. |
| POST | /kling/multi-elements | API key | video | Разработчики | Ставит Kling multi-elements video editing task в очередь. |
| POST | /repurpose | API key | video | Разработчики | Запускает repurposing pipeline из YouTube или file URL с optional language.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован. |
| GET | /rico/sessions | API key | rico.media or video | Разработчики | Показывает recent RICO Supercomputer sessions для authenticated account. |
| GET | /rico/sessions/:id | API key | rico.media or video | Разработчики | Возвращает RICO Supercomputer session с messages, workflow steps, status и current assets. |
| GET | /rico/sessions/:id/events | API key | rico.media or video | Разработчики | Возвращает polling-friendly RICO session timeline с messages, steps и assets. |
| POST | /rico/sessions/:id/messages | API key | rico.media or video | Разработчики | Добавляет user или assistant message в существующую RICO session. |
| GET | /rico/sessions/:id/assets | API key | rico.media or video | Разработчики | Показывает media assets, созданные RICO Supercomputer session. |
| GET | /rico/assets | API key | rico.media or video | Разработчики | Показывает recent RICO media assets. |
| POST | /rico/assets | API key | rico.media or video | Разработчики | Загружает или регистрирует RICO media asset через multipart file, URL или data URL. |
| GET | /rico/assets/:id | API key | rico.media or video | Разработчики | Показывает один RICO media asset по id. |
| GET | /generation/:id | API key | video | Разработчики | Возвращает generation record, status, output video URL, metadata, file size и error message. |
| GET | /kling/tasks/:id | API key | video | Разработчики | Возвращает любую Kling provider task по local task ID, provider task ID или external task ID. |
| GET | /repurpose | API key | video | Разработчики | Показывает recent repurpose jobs. |
| GET | /repurpose/:id | API key | video | Разработчики | Возвращает repurposing task с rendered clips, transcripts, segments, viral scores и output URLs. |
| POST | /repurpose/:id/retry | API key | video | Разработчики | Повторяет failed repurpose job. |
| DELETE | /repurpose/:id | API key | video | Разработчики | Удаляет repurpose job по id. |
| PUT | /repurpose/:task_id/clip/:clip_id | API key | video | Разработчики | Обновляет clip edit state для repurpose task. |
| POST | /repurpose/:task_id/clip/:clip_id/render-captions | API key | video | Разработчики | Рендерит repurpose clip с timeline edits и optional burned captions. |
| POST | /images/generate | API key | video | Разработчики | Генерирует images по prompt, reference image, palette, model и resolution. Kling models идут через реестр provider tasks. |
| POST | /kling/images/generations | API key | video | Разработчики | Ставит Kling image generation в очередь напрямую с model_name, n, aspect ratio, references и provider task status. |
| POST | /kling/general/ai-multi-shot | API key | video | Разработчики | Ставит Kling AI Multi-Shot в очередь по одному frontal image и сохраняет все returned shots в media library. |
| POST | /kling/images/kolors-virtual-try-on | API key | video | Разработчики | Ставит Kling Kolors virtual try-on в очередь с human и cloth images. |
| POST | /images/edit | API key | video | Разработчики | Редактирует image по prompt и source image URL. |
| POST | /images/enhance | API key | video | Разработчики | Улучшает или upscale image asset. |
| POST | /images/faceswap | API key | video | Разработчики | Делает face swap между target и source images. |
| POST | /images/3d-angles | API key | video | Разработчики | Генерирует 3D/360-style video из image. |
| POST | /images/character-gen | API key | video | Разработчики | Создает consistent character из prompt и optional reference image. |
| POST | /kling/image-recognize | API key | video | Разработчики | Запускает Kling image recognition и segmentation utilities для object, head, face и clothing masks. |
| POST | /kling/audio/text-to-audio | API key | video | Разработчики | Ставит Kling text-to-audio generation в очередь и сохраняет audio в media library. |
| POST | /kling/audio/video-to-audio | API key | video | Разработчики | Ставит Kling video-to-audio generation в очередь для переданного video source. |
| POST | /kling/lipsync/identify-face | API key | video | Разработчики | Определяет faces для Kling lip-sync workflows перед созданием final lip-sync task. |
| POST | /kling/voices | API key | video | Разработчики | Создает Kling custom voice task. |
| GET | /kling/voices | API key | video | Разработчики | Показывает Kling custom voices. |
| GET | /kling/voices/:id | API key | video | Разработчики | Показывает одну Kling custom voice task по id. |
| POST | /kling/voices/delete | API key | video | Разработчики | Ставит удаление Kling custom voice в очередь. |
| GET | /kling/voices/presets | API key | video | Разработчики | Показывает Kling preset voices для audio и avatar tools. |
| POST | /kling/elements | API key | video | Разработчики | Создает Kling advanced custom elements для multi-element video editing. |
| GET | /kling/elements | API key | video | Разработчики | Показывает Kling advanced custom elements. |
| GET | /kling/elements/:id | API key | video | Разработчики | Показывает один Kling advanced custom element по id. |
| POST | /kling/multi-elements/init-selection | API key | video | Разработчики | Инициализирует Kling multi-elements selections для editing workflows. |
| POST | /kling/multi-elements/add-selection | API key | video | Разработчики | Добавляет Kling multi-elements selection. |
| POST | /kling/multi-elements/delete-selection | API key | video | Разработчики | Удаляет Kling multi-elements selection. |
| POST | /kling/multi-elements/clear-selection | API key | video | Разработчики | Очищает все Kling multi-elements selections. |
| POST | /kling/multi-elements/preview-selection | API key | video | Разработчики | Preview Kling multi-elements selection. |
| GET | /kling/multi-elements | API key | video | Разработчики | Показывает Kling multi-elements tasks. |
| GET | /kling/multi-elements/:id | API key | video | Разработчики | Показывает одну Kling multi-elements task по id. |
| POST | /repurpose/tts | API key | video | Разработчики | Генерирует speech audio из text и voice selection. |
| POST | /repurpose/enhance-audio | API key | video | Разработчики | Ставит audio enhancement для source video в очередь. |
| POST | /repurpose/lipsync | API key | video | Разработчики | Синхронизирует video с переданным audio track. |
| POST | /repurpose/recast | API key | video | Разработчики | Заменяет или recast персонажа в source video по target image. |
| POST | /video/transitions | API key | video | Разработчики | Создаёт transitions между двумя или более input video URLs. |
| POST | /video/edit | API key | video | Разработчики | Редактирует existing video по natural-language prompt. |
| POST | /ads/generate | API key | video | Разработчики | Генерирует ad creative из product URL. |
| GET | /broll/search | API key | video | Разработчики | Ищет B-roll media для repurpose и editing workflows. |
| GET | /ricochet/budget | API key | ricochet_code | Ricochet-клиенты | Проверяет ricochet_code credits, plan, window limits, task limits и upgrade URL перед hosted AI run. |
| POST | /ricochet/usage/quote | API key | ricochet_code | Ricochet-клиенты | Считает и резервирует hosted Ricochet usage перед upstream model call.Используйте перед upstream hosted-model вызовом. |
| POST | /ricochet/usage/report | API key | ricochet_code | Ricochet-клиенты | Отправляет hosted model usage с idempotency, token counts, provider, model и billing metadata. |
| GET | /ricochet/usage | API key | ricochet_code | Ricochet-клиенты | Показывает Ricochet hosted usage events с filters по session, run, provider, model и limit. |
| POST | /ricochet/usage/approve-premium | API key | ricochet_code | Ricochet-клиенты | Сохраняет temporary approval для premium model usage в task, run или session. |
| GET | /ricochet/sessions | User token | - | Ricochet-клиенты | Показывает Ricochet IDE и device sessions для current user. |
| DELETE | /ricochet/sessions/:id | User token | - | Ricochet-клиенты | Отзывает Ricochet IDE или device session. |
| POST | /ricochet/openai/v1/chat/completions | API key | ricochet_code | Ricochet-клиенты | Legacy alias для Ricochet hosted coding chat completions. Для новых generic model integrations используйте /chat/completions в AI Gateway.Совместимый route для существующих Ricochet-клиентов. |
| POST | /ricochet/openai/v1/responses | API key | ricochet_code | Ricochet-клиенты | Ricochet hosted coding Responses API alias для клиентов, которые используют OpenAI Responses.Совместимый route для существующих Ricochet-клиентов. |
| GET | /social/accounts | API key | social | Разработчики | Показывает social accounts текущего пользователя. |
| POST | /social/accounts/connect | API key | social | Разработчики | Создаёт social account record для YouTube, Instagram, TikTok, LinkedIn, X или Facebook. |
| DELETE | /social/accounts/:id | API key | social | Разработчики | Отключает social account по id. |
| GET | /social/posts | API key | social | Разработчики | Показывает scheduled posts с optional date range filters. |
| POST | /social/posts | API key | social | Разработчики | Создаёт draft или scheduled post с content, hashtags, media, accounts и platform options. |
| PUT | /social/posts/:id | API key | social | Разработчики | Обновляет post content, hashtags, schedule или status. |
| DELETE | /social/posts/:id | API key | social | Разработчики | Удаляет scheduled post и очищает account associations. |
| POST | /social/generate-caption | API key | social | Разработчики | Генерирует social caption из transcript или media id. |
| POST | /social/upload | API key | social | Разработчики | Загружает MP4 для social publishing workflows. |
| POST | /import/auto | API key | social | Разработчики | Регистрирует platform channel или folder для automated video import monitoring. |
| GET | /config/pricing | Нет | - | Разработчики | Возвращает generation costs, subscription plans, credit packages, Ricochet plans и model billing policy из pricing.yaml. |
/auth/device/codeСоздает device code, user code, verification URL, срок действия и polling interval.
/auth/device/tokenМеняет approved device code на access и refresh tokens.
/auth/refreshРотирует refresh token и выдает новый access token.
/users/meВозвращает authenticated user profile для billing и ownership.
/auth/api-keysВыпускает organization API key вида grik_live_... для server-side integrations.
/auth/api-keysПоказывает active и revoked API keys без raw secret.
/auth/api-keys/:idОбновляет key metadata, scopes, environment, status или spend controls без раскрытия raw secret.
/auth/api-keys/:idОтзывает API key по id. Revoked keys сразу перестают проходить auth.
/modelsПоказывает модели AI Gateway: provider availability, context length, pricing, capabilities и data policy metadata.
/rico/modelsПоказывает RICO recipes, workflows и effect presets. Optional filters: recipe, workflow, effect.
/rico/models/:idПоказывает один RICO recipe, workflow, model или effect preset по id.
/rico/workflowsПоказывает recipes и разрешённые executor workflows RICO Supercomputer для web, MCP, CLI и API.
/rico/recipesПоказывает только recipes RICO Supercomputer.
/chat/completionsЗапускает OpenAI/OpenRouter-compatible chat completions через GRIKAI AI Gateway со streaming, tools, fallbacks и provider routing.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.
/responsesЗапускает OpenAI Responses-compatible requests через GRIKAI AI Gateway с тем же model catalog, routing, fallbacks и usage billing.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.
/responses/input_tokensСчитает входные токены Responses до запуска. Для моделей OpenAI используется upstream token count, для остальных providers возвращается estimate.Используйте перед upstream hosted-model вызовом.
/ai-gateway/balanceВозвращает balance_micros, pending reservation micros, available balance и USD display values.
/ai-gateway/pricingВозвращает AI Gateway packages, platform fee, minimum charge и видимые клиенту model pricing.
/ai-gateway/quoteОценивает токены, стоимость для клиента, доступный баланс, spend-limit decision и fallback-route charge до запуска. Баланс не резервируется и не списывается.Используйте перед upstream hosted-model вызовом.
/ai-gateway/usageПоказывает AI Gateway usage events с filters по provider, model, status, date и limit.
/ai-gateway/usage/:idВозвращает один usage event с token counts, provider cost, platform fee, charge, route attempts и metadata.
/ai-gateway/reservationsПоказывает active, failed и settled preflight reservations для idempotency и pending-balance debugging.
/keysПоказывает account API keys без raw secret.
/keysСоздаёт API key с ai.gateway scope и optional spend controls. Raw key возвращается только один раз.
/keys/:idОбновляет key name, status, scopes, environment, spend limit или reset interval без rotation секрета.
/keys/:idОтзывает API key по id.
/billing/creditsВозвращает product credit wallets плюс ai_gateway_balance_micros.
/billing/transactionsПоказывает billing transactions с optional product filter.
/billing/entitlementsВозвращает active subscriptions и period-end cancellation fields.
/rico/sessionsСоздаёт RICO Supercomputer session с brief, recipe, inputs, cost estimate, messages и pending steps.
/rico/sessions/:id/approveПодтверждает RICO Supercomputer session, списывает RICO media credits и ставит deterministic execution в очередь.
/rico/mcpВызывает RICO MCP endpoint с tools вроде rico_estimate_cost, rico_apply_effect, rico_repurpose и rico_get_job.
/generate/videoЗапускает text-to-video или image-to-video generation с model, aspect ratio, duration, mode, image URL и sound options.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.
/kling/videos/effectsСтавит Kling Video Effects Center task в очередь по effect_scene с single-image или dual-image input.
/kling/lipsyncСтавит Kling advanced lip-sync в очередь и отслеживает его через реестр provider tasks.
/kling/multi-elementsСтавит Kling multi-elements video editing task в очередь.
/repurposeЗапускает repurposing pipeline из YouTube или file URL с optional language.Передавайте Idempotency-Key только для create/retry запросов, где он реально реализован.
/rico/sessionsПоказывает recent RICO Supercomputer sessions для authenticated account.
/rico/sessions/:idВозвращает RICO Supercomputer session с messages, workflow steps, status и current assets.
/rico/sessions/:id/eventsВозвращает polling-friendly RICO session timeline с messages, steps и assets.
/rico/sessions/:id/messagesДобавляет user или assistant message в существующую RICO session.
/rico/sessions/:id/assetsПоказывает media assets, созданные RICO Supercomputer session.
/rico/assetsПоказывает recent RICO media assets.
/rico/assetsЗагружает или регистрирует RICO media asset через multipart file, URL или data URL.
/rico/assets/:idПоказывает один RICO media asset по id.
/generation/:idВозвращает generation record, status, output video URL, metadata, file size и error message.
/kling/tasks/:idВозвращает любую Kling provider task по local task ID, provider task ID или external task ID.
/repurposeПоказывает recent repurpose jobs.
/repurpose/:idВозвращает repurposing task с rendered clips, transcripts, segments, viral scores и output URLs.
/repurpose/:id/retryПовторяет failed repurpose job.
/repurpose/:idУдаляет repurpose job по id.
/repurpose/:task_id/clip/:clip_idОбновляет clip edit state для repurpose task.
/repurpose/:task_id/clip/:clip_id/render-captionsРендерит repurpose clip с timeline edits и optional burned captions.
/images/generateГенерирует images по prompt, reference image, palette, model и resolution. Kling models идут через реестр provider tasks.
/kling/images/generationsСтавит Kling image generation в очередь напрямую с model_name, n, aspect ratio, references и provider task status.
/kling/general/ai-multi-shotСтавит Kling AI Multi-Shot в очередь по одному frontal image и сохраняет все returned shots в media library.
/kling/images/kolors-virtual-try-onСтавит Kling Kolors virtual try-on в очередь с human и cloth images.
/images/editРедактирует image по prompt и source image URL.
/images/enhanceУлучшает или upscale image asset.
/images/faceswapДелает face swap между target и source images.
/images/3d-anglesГенерирует 3D/360-style video из image.
/images/character-genСоздает consistent character из prompt и optional reference image.
/kling/image-recognizeЗапускает Kling image recognition и segmentation utilities для object, head, face и clothing masks.
/kling/audio/text-to-audioСтавит Kling text-to-audio generation в очередь и сохраняет audio в media library.
/kling/audio/video-to-audioСтавит Kling video-to-audio generation в очередь для переданного video source.
/kling/lipsync/identify-faceОпределяет faces для Kling lip-sync workflows перед созданием final lip-sync task.
/kling/voicesСоздает Kling custom voice task.
/kling/voicesПоказывает Kling custom voices.
/kling/voices/:idПоказывает одну Kling custom voice task по id.
/kling/voices/deleteСтавит удаление Kling custom voice в очередь.
/kling/voices/presetsПоказывает Kling preset voices для audio и avatar tools.
/kling/elementsСоздает Kling advanced custom elements для multi-element video editing.
/kling/elementsПоказывает Kling advanced custom elements.
/kling/elements/:idПоказывает один Kling advanced custom element по id.
/kling/multi-elements/init-selectionИнициализирует Kling multi-elements selections для editing workflows.
/kling/multi-elements/add-selectionДобавляет Kling multi-elements selection.
/kling/multi-elements/delete-selectionУдаляет Kling multi-elements selection.
/kling/multi-elements/clear-selectionОчищает все Kling multi-elements selections.
/kling/multi-elements/preview-selectionPreview Kling multi-elements selection.
/kling/multi-elementsПоказывает Kling multi-elements tasks.
/kling/multi-elements/:idПоказывает одну Kling multi-elements task по id.
/repurpose/ttsГенерирует speech audio из text и voice selection.
/repurpose/enhance-audioСтавит audio enhancement для source video в очередь.
/repurpose/lipsyncСинхронизирует video с переданным audio track.
/repurpose/recastЗаменяет или recast персонажа в source video по target image.
/video/transitionsСоздаёт transitions между двумя или более input video URLs.
/video/editРедактирует existing video по natural-language prompt.
/ads/generateГенерирует ad creative из product URL.
/broll/searchИщет B-roll media для repurpose и editing workflows.
/ricochet/budgetПроверяет ricochet_code credits, plan, window limits, task limits и upgrade URL перед hosted AI run.
/ricochet/usage/quoteСчитает и резервирует hosted Ricochet usage перед upstream model call.Используйте перед upstream hosted-model вызовом.
/ricochet/usage/reportОтправляет hosted model usage с idempotency, token counts, provider, model и billing metadata.
/ricochet/usageПоказывает Ricochet hosted usage events с filters по session, run, provider, model и limit.
/ricochet/usage/approve-premiumСохраняет temporary approval для premium model usage в task, run или session.
/ricochet/sessionsПоказывает Ricochet IDE и device sessions для current user.
/ricochet/sessions/:idОтзывает Ricochet IDE или device session.
/ricochet/openai/v1/chat/completionsLegacy alias для Ricochet hosted coding chat completions. Для новых generic model integrations используйте /chat/completions в AI Gateway.Совместимый route для существующих Ricochet-клиентов.
/ricochet/openai/v1/responsesRicochet hosted coding Responses API alias для клиентов, которые используют OpenAI Responses.Совместимый route для существующих Ricochet-клиентов.
/social/accountsПоказывает social accounts текущего пользователя.
/social/accounts/connectСоздаёт social account record для YouTube, Instagram, TikTok, LinkedIn, X или Facebook.
/social/accounts/:idОтключает social account по id.
/social/postsПоказывает scheduled posts с optional date range filters.
/social/postsСоздаёт draft или scheduled post с content, hashtags, media, accounts и platform options.
/social/posts/:idОбновляет post content, hashtags, schedule или status.
/social/posts/:idУдаляет scheduled post и очищает account associations.
/social/generate-captionГенерирует social caption из transcript или media id.
/social/uploadЗагружает MP4 для social publishing workflows.
/import/autoРегистрирует platform channel или folder для automated video import monitoring.
/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 интеграциями.
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.
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.
| Метод | Endpoint | Авторизация | Область | Аудитория | Описание |
|---|---|---|---|---|---|
| GET | /gallery | Bearer token | - | Web session | Показывает media gallery items для current logged-in user. |
| GET | /user/storage | Bearer token | - | Web session | Возвращает storage usage для current logged-in user. |
/galleryПоказывает media gallery items для current logged-in user.
/user/storageВозвращает storage usage для current logged-in user.
#Callbacks и внутренние маршруты
Callbacks и internal approval routes доступны по сети, но их должны вызывать только providers или trusted Grik services.
Endpoint
/internal/notificationsInternal 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.
Endpoint
/webhooks/mailgunMailgun 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.
Endpoint
/auth/device/approveInternal 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.
Endpoint
/provider-callbacks/klingKling 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.
Endpoint
/billing/passimpay/webhookPassimPay 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.
Endpoint
/billing/paypal/webhookPayPal 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.
| Метод | Endpoint | Авторизация | Область | Аудитория | Описание |
|---|---|---|---|---|---|
| POST | /internal/notifications | Внутренний | - | Внутренний | Internal route сервиса GRIKAI для постановки notifications в очередь. Не является client integration endpoint. |
| POST | /webhooks/mailgun | Подписанный callback | - | Callbacks | Mailgun provider webhook для email delivery и event notifications. |
| POST | /auth/device/approve | Внутренний | - | Внутренний | Internal web approval route, который связывает browser-approved device code с Grik user. |
| POST | /provider-callbacks/kling | Подписанный callback | - | Callbacks | Kling provider callback для settlement asynchronous task status. |
| POST | /billing/passimpay/webhook | Подписанный callback | - | Callbacks | PassimPay billing webhook для idempotent payment settlement. |
| POST | /billing/paypal/webhook | Подписанный callback | - | Callbacks | PayPal billing webhook для verified payment и subscription settlement. |
/internal/notificationsInternal route сервиса GRIKAI для постановки notifications в очередь. Не является client integration endpoint.
/webhooks/mailgunMailgun provider webhook для email delivery и event notifications.
/auth/device/approveInternal web approval route, который связывает browser-approved device code с Grik user.
/provider-callbacks/klingKling provider callback для settlement asynchronous task status.
/billing/passimpay/webhookPassimPay billing webhook для idempotent payment settlement.
/billing/paypal/webhookPayPal billing webhook для verified payment и subscription settlement.