Справочник API

Справочник описывает методы RenderFox API версии /v1. Спецификация OpenAPI 3.1 содержит схемы запросов, ответов и потоковых событий.

Для авторизации передайте API-ключ в заголовке Authorization: Bearer. Запросы на генерацию требуют Idempotency-Key; при сетевом повторе сохраняйте его и исходное тело. Ответы с приватными данными не кэшируются.

Модели, параметры и тарифы доступны в библиотеке. Примеры: Chat Completions, Responses, Messages, изображения, видео и файлы. Для диагностики сохраняйте X-Request-ID и ознакомьтесь с ошибками API.

`GET /v1/models`

Canonical allowed LLM and media models

Разрешение: models:read

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/models/{model_id}`

Разрешение: models:read

Параметры запроса

Поле	Где	Тип и ограничения
`model_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/chat/completions`

Разрешение: chat:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`model` · обязательно	application/json	`string`
`messages` · обязательно	application/json	`array; {"minItems": 1, "maxItems": 400}`
`max_tokens`	application/json	`integer; {"minimum": 1}`
`max_completion_tokens`	application/json	`integer; {"minimum": 1}`
`temperature`	application/json	`number`
`top_p`	application/json	`number`
`stream`	application/json	`boolean`
`stream_options`	application/json	`object; {"required": [], "additionalProperties": false}`
`tools`	application/json	`array; {"maxItems": 64}`
`tool_choice`	application/json	`oneOf; {"oneOf": [{"type": "string"}, {"type": "object"}]}`
`parallel_tool_calls`	application/json	`boolean`
`response_format`	application/json	`object`
`reasoning_effort`	application/json	`string`
`thinking`	application/json	`object; {"required": ["type"], "additionalProperties": false}`
`n`	application/json	`enum; {"const": 1}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/responses`

Разрешение: responses:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`model` · обязательно	application/json	`string`
`input` · обязательно	application/json	`oneOf; {"oneOf": [{"type": "string"}, {"type": "array", "minItems": 1, "maxItems": 400, "items": {"type": "object"}}]}`
`instructions`	application/json	`['string', 'null']`
`stream`	application/json	`boolean`
`stream_options`	application/json	`object`
`tools`	application/json	`array; {"maxItems": 64}`
`tool_choice`	application/json	`oneOf; {"oneOf": [{"type": "string"}, {"type": "object"}]}`
`parallel_tool_calls`	application/json	`boolean`
`reasoning`	application/json	`object`
`store`	application/json	`boolean`
`include`	application/json	`array`
`prompt_cache_key`	application/json	`string; {"maxLength": 512}`
`text`	application/json	`object`
`client_metadata`	application/json	`object`
`max_output_tokens`	application/json	`integer; {"minimum": 1}`
`temperature`	application/json	`number`
`top_p`	application/json	`number`
`previous_response_id`	application/json	`string`
`metadata`	application/json	`object`
`background`	application/json	`enum; {"const": false}`
`truncation`	application/json	`enum; {"const": "disabled"}`
`service_tier`	application/json	`enum; {"enum": ["auto", "default"]}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/responses/{response_id}`

Разрешение: responses:write

Параметры запроса

Поле	Где	Тип и ограничения
`response_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`DELETE /v1/responses/{response_id}`

Разрешение: responses:write

Параметры запроса

Поле	Где	Тип и ограничения
`response_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 204. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/messages`

Anthropic Messages with model-specific tools, streaming and vision capabilities

Разрешение: messages:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`anthropic-version` · обязательно	header	`enum; {"const": "2023-06-01"}`
`model` · обязательно	application/json	`string`
`max_tokens` · обязательно	application/json	`integer; {"minimum": 1}`
`messages` · обязательно	application/json	`array; {"minItems": 1, "maxItems": 400}`
`system`	application/json	`oneOf; {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "object"}}]}`
`stream`	application/json	`boolean`
`temperature`	application/json	`number`
`top_p`	application/json	`number`
`tools`	application/json	`array; {"maxItems": 64}`
`tool_choice`	application/json	`object`
`thinking`	application/json	`object`
`output_config`	application/json	`object`
`metadata`	application/json	`object`
`stop_sequences`	application/json	`array; {"maxItems": 4}`
`service_tier`	application/json	`enum; {"enum": ["auto", "standard_only"]}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/images/generations`

Exact canonical size; b64_json original;60s timeout retains durable job

Разрешение: images:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`model` · обязательно	application/json	`string`
`prompt` · обязательно	application/json	`string`
`size`	application/json	`string`
`quality`	application/json	`enum; {"enum": ["auto", "low", "medium", "high", "xhigh", "max"]}`
`background`	application/json	`enum; {"enum": ["auto", "opaque", "transparent"]}`
`output_format`	application/json	`enum; {"enum": ["png", "jpeg", "webp", "gif"]}`
`n`	application/json	`enum; {"const": 1}`
`response_format`	application/json	`enum; {"const": "b64_json"}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/images/edits`

Multipart requires files:write too;20MiB total; no mask/markup

Разрешение: images:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`model` · обязательно	application/json	`string`
`prompt` · обязательно	application/json	`string`
`size`	application/json	`string`
`quality`	application/json	`enum; {"enum": ["auto", "low", "medium", "high", "xhigh", "max"]}`
`background`	application/json	`enum; {"enum": ["auto", "opaque", "transparent"]}`
`output_format`	application/json	`enum; {"enum": ["png", "jpeg", "webp", "gif"]}`
`n`	application/json	`enum; {"const": 1}`
`response_format`	application/json	`enum; {"const": "b64_json"}`
`image` · обязательно	application/json	`oneOf; {"oneOf": [{"type": "string"}, {"type": "array", "minItems": 1, "maxItems": 16, "items": {"type": "string"}}]}`
`model` · обязательно	multipart/form-data	`string`
`prompt` · обязательно	multipart/form-data	`string`
`size`	multipart/form-data	`string`
`quality`	multipart/form-data	`enum; {"enum": ["auto", "low", "medium", "high", "xhigh", "max"]}`
`background`	multipart/form-data	`enum; {"enum": ["auto", "opaque", "transparent"]}`
`output_format`	multipart/form-data	`enum; {"enum": ["png", "jpeg", "webp", "gif"]}`
`n`	multipart/form-data	`enum; {"const": 1}`
`response_format`	multipart/form-data	`enum; {"const": "b64_json"}`
`image` · обязательно	multipart/form-data	`oneOf; {"oneOf": [{"type": "string", "format": "binary"}, {"type": "array", "minItems": 1, "maxItems": 16, "items": {"type": "string", "format": "binary"}}]}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/files`

Разрешение: files:write

Параметры запроса

Поле	Где	Тип и ограничения
`file` · обязательно	multipart/form-data	`string; {"format": "binary"}`
`purpose`	multipart/form-data	`enum; {"const": "generation"}`
`role`	multipart/form-data	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 201. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/files/{file_id}`

Разрешение: files:read

Параметры запроса

Поле	Где	Тип и ограничения
`file_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`DELETE /v1/files/{file_id}`

Разрешение: files:write

Параметры запроса

Поле	Где	Тип и ограничения
`file_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/files/{file_id}/content`

Разрешение: files:read

Параметры запроса

Поле	Где	Тип и ограничения
`file_id` · обязательно	path	`string`
`Range`	header	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200, 206, 416. Схема ответа и SSE: OpenAPI3.1.

`HEAD /v1/files/{file_id}/content`

Разрешение: files:read

Параметры запроса

Поле	Где	Тип и ограничения
`file_id` · обязательно	path	`string`
`Range`	header	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200, 206, 416. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/generations/quote`

Разрешение: generations:write

Параметры запроса

Поле	Где	Тип и ограничения
`model` · обязательно	application/json	`string`
`mode`	application/json	`string`
`prompt`	application/json	`string`
`settings`	application/json	`object`
`inputs`	application/json	`object; {"maxProperties": 16, "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "array", "maxItems": 64, "items": {"type": "string"}}]}}`
`expected_quote`	application/json	`object; {"required": ["price_mfc", "catalog_release_id", "quote_fingerprint"], "additionalProperties": false}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/generations`

Разрешение: generations:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`model` · обязательно	application/json	`string`
`mode`	application/json	`string`
`prompt`	application/json	`string`
`settings`	application/json	`object`
`inputs`	application/json	`object; {"maxProperties": 16, "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "array", "maxItems": 64, "items": {"type": "string"}}]}}`
`expected_quote`	application/json	`object; {"required": ["price_mfc", "catalog_release_id", "quote_fingerprint"], "additionalProperties": false}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 201. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/generations/{public_id}`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/generations/{public_id}/content/{index}`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`
`index` · обязательно	path	`integer; {"minimum": 0, "maximum": 100}`
`Range`	header	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200, 206, 416. Схема ответа и SSE: OpenAPI3.1.

`HEAD /v1/generations/{public_id}/content/{index}`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`
`index` · обязательно	path	`integer; {"minimum": 0, "maximum": 100}`
`Range`	header	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200, 206, 416. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/generations/{public_id}/cancel`

Accepted generations cannot currently be cancelled;409, no refund promise

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504. Схема ответа и SSE: OpenAPI3.1.

`POST /v1/videos`

RenderFox async video shape; explicit mode; not full OpenAI video wire compatibility

Разрешение: videos:write

Параметры запроса

Поле	Где	Тип и ограничения
`Idempotency-Key` · обязательно	header	`string; {"minLength": 1, "maxLength": 128}`
`model` · обязательно	application/json	`string`
`mode`	application/json	`string`
`prompt`	application/json	`string`
`settings`	application/json	`object`
`inputs`	application/json	`object; {"maxProperties": 16, "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "array", "maxItems": 64, "items": {"type": "string"}}]}}`
`expected_quote`	application/json	`object; {"required": ["price_mfc", "catalog_release_id", "quote_fingerprint"], "additionalProperties": false}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 201. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/videos/{public_id}`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/videos/{public_id}/content`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`
`Range`	header	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200, 206, 416. Схема ответа и SSE: OpenAPI3.1.

`HEAD /v1/videos/{public_id}/content`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`public_id` · обязательно	path	`string`
`Range`	header	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200, 206, 416. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/requests/{request_id}`

Разрешение: origin operation scope

Параметры запроса

Поле	Где	Тип и ограничения
`request_id` · обязательно	path	`string`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/usage`

Разрешение: usage:read

Параметры запроса

Поле	Где	Тип и ограничения
`start`	query	`integer; {"minimum": 0}`
`end`	query	`integer; {"minimum": 0}`

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.

`GET /v1/limits`

Разрешение: usage:read

HTTP: 400, 401, 402, 403, 404, 409, 413, 422, 429, 500, 502, 503, 504, 200. Схема ответа и SSE: OpenAPI3.1.