{ "openapi": "3.1.0", "info": { "title": "Voxvey API", "version": "0.1.0", "summary": "Unified API for AI, search, media generation, and agent tools.", "description": "Voxvey provides a single API for AI capabilities including language models, image generation, video generation, audio services, search, and agent tooling. Build with one integration while accessing supported providers and services through a consistent developer experience." }, "servers": [ { "url": "https://api.voxvey.com", "description": "Production" }, { "url": "http://beta.api.voxvey.com", "description": "Beta API" } ], "tags": [ { "name": "Platform", "description": "Service health, metadata, and platform information." }, { "name": "Models", "description": "Discover available AI models and capabilities." }, { "name": "Account", "description": "Account information, usage, and billing." }, { "name": "Chat", "description": "Conversational AI and text generation." }, { "name": "Responses", "description": "Unified response generation API." }, { "name": "Embeddings", "description": "Text and multimodal vector embeddings." }, { "name": "Images", "description": "Image generation and editing." }, { "name": "Video", "description": "Video generation, editing, and job management." }, { "name": "Audio", "description": "Speech generation, transcription, and translation." }, { "name": "Realtime", "description": "Low-latency realtime AI sessions." }, { "name": "Search", "description": "Web search and retrieval services." }, { "name": "Tools", "description": "Agent tools and MCP integrations." } ], "security": [ { "BearerAuth": [] } ], "paths": { "/openapi.json": { "get": { "tags": [ "Platform" ], "summary": "Return this OpenAPI schema", "description": "Returns the hand-authored OpenAPI schema for the gateway. This endpoint is public.", "operationId": "getOpenApiSchema", "security": [], "responses": { "200": { "description": "OpenAPI document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAPIObject" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/health": { "get": { "tags": [ "Platform" ], "summary": "Health check", "description": "Returns a simple service health payload. This endpoint is public and does not require authentication.", "operationId": "getHealth", "security": [], "responses": { "200": { "description": "Service is healthy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/models": { "get": { "tags": [ "Models" ], "summary": "List available models", "description": "Lists provider-prefixed model IDs accepted by the gateway. The response merges routed provider models when those upstream listings are available.", "operationId": "listModels", "responses": { "200": { "description": "Provider-prefixed model list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelList" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/user/info": { "get": { "tags": [ "Account" ], "summary": "Get user wallet summary", "description": "Returns the authenticated user's effective max budget and spend information. Some service callers may receive a service-bypass marker instead of wallet balance.", "operationId": "getUserInfo", "responses": { "200": { "description": "User budget information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInfoResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/chat/completions": { "post": { "tags": [ "LLM" ], "summary": "Create a chat completion", "description": "OpenAI-compatible chat completions route. `model` must include a provider prefix such as `openai/`, `gemini/`, `xai/`, `perplexity/`, `anthropic/`, `deepseek/`, or `byte/`. For provider-native, the gateway forwards to provider-native `/chat/completions` and strips the `byte/` prefix upstream.", "operationId": "createChatCompletion", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionRequest" }, "examples": { "byteplus": { "summary": "provider-native Seed chat", "value": { "model": "byte/seed-2-0-lite-260428", "messages": [ { "role": "user", "content": "Write a short launch note." } ], "stream": false } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/messages": { "post": { "tags": [ "LLM" ], "summary": "Create a Claude message", "description": "Anthropic-compatible Messages API route. `anthropic/` and `claude/` models are forwarded through native Claude provider routing and preserve native Claude response and streaming event shapes. Other chat-capable text models such as `openai/*`, `gemini/*`, `xai/*`, `deepseek/*`, and `perplexity/*` are translated through Voxvey chat routing and returned in Claude Messages shape.", "operationId": "createMessage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaudeMessagesRequest" }, "examples": { "claude": { "summary": "Claude message", "value": { "model": "anthropic/claude-sonnet-4-5", "max_tokens": 1024, "system": [ { "type": "text", "text": "Be concise." } ], "messages": [ { "role": "user", "content": "Hello, Claude" } ] } }, "openai": { "summary": "OpenAI via chat fallback", "value": { "model": "openai/gpt-4o-mini", "max_tokens": 256, "system": "Be concise.", "messages": [ { "role": "user", "content": "Hello" } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/responses": { "post": { "tags": [ "LLM" ], "summary": "Create a response", "description": "OpenAI-compatible Responses API route for providers that support response-style input. Chat-only text providers fall back through Voxvey chat routing and are translated back into Responses shape. provider-native forwards to provider-native `/responses` and may use provider-native response fields such as `input`, `instructions`, `tools`, `thinking`, and `include`.", "operationId": "createResponse", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsesRequest" }, "examples": { "byteplus": { "summary": "provider-native Seed response", "value": { "model": "byte/seed-2-0-mini-260428", "input": "Summarize this meeting transcript in three bullets.", "stream": false } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/embeddings": { "post": { "tags": [ "LLM" ], "summary": "Create text embeddings", "description": "OpenAI-compatible text embeddings route. Use provider-prefixed embedding models exposed by `/v1/models`.", "operationId": "createEmbedding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/images/generations": { "post": { "tags": [ "LLM" ], "summary": "Generate images", "description": "Native image generation route. `openai/gpt-image-1` forwards to OpenAI `/images/generations`; `xai/grok-imagine-image*` forwards to xAI `/images/generations`; `byte/seedream-*` forwards to provider-native `/images/generations`; Gemini image models use native Gemini `generateContent`.", "operationId": "createImageGeneration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageGenerationRequest" }, "examples": { "byteplus": { "summary": "provider-native Seedream image", "value": { "model": "byte/seedream-5-0-260128", "prompt": "A clean product photo of a matte ceramic mug on a bright table", "size": "2K", "response_format": "url", "watermark": false } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/images/edits": { "post": { "tags": [ "Chat" ], "summary": "Edit an image", "description": "Native image edit route. xAI image edit requests can be sent as JSON to `/images/edits`; OpenAI image edits can be sent as multipart form data. The gateway strips provider prefixes upstream.", "operationId": "editImage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageEditRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImageEditRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/videos": { "get": { "tags": [ "Video" ], "summary": "List videos", "description": "Proxies video listing to OpenAI by default, to xAI when `provider=xai` is supplied, or to provider-native tasks when `provider=byte` is supplied.", "operationId": "listVideos", "parameters": [ { "name": "provider", "in": "query", "required": false, "description": "Optional upstream provider override for status routes.", "schema": { "type": "string", "enum": [ "openai", "xai" ] } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Video" ], "summary": "Create a video", "description": "Creates an async video job. OpenAI Sora models such as `openai/sora-2` are forwarded to `/videos`; xAI Grok Imagine and provider-native Seedance models may also use this route and are mapped to their provider-specific generation endpoints.", "operationId": "createVideo", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" }, "examples": { "sora": { "summary": "OpenAI Sora", "value": { "model": "openai/sora-2", "prompt": "A cinematic product reveal", "size": "1280x720", "seconds": "8" } }, "grokImagine": { "summary": "xAI Grok Imagine", "value": { "model": "xai/grok-imagine-video", "prompt": "A crystal rocket launching from Mars", "duration": 10 } }, "seedance": { "summary": "provider-native Seedance", "value": { "model": "byte/dreamina-seedance-2-0-260128", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/videos/generations": { "post": { "tags": [ "Video" ], "summary": "Generate a video", "description": "Creates an async video generation job. `xai/grok-imagine-video` is forwarded to xAI `/videos/generations`; `byte/dreamina-seedance-*` and `byte/seedance-*` models are forwarded to provider-native `/contents/generations/tasks`; `openai/sora-*` models are forwarded to OpenAI `/videos`.", "operationId": "createVideoGeneration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" }, "examples": { "sora": { "summary": "OpenAI Sora", "value": { "model": "openai/sora-2", "prompt": "A cinematic product reveal", "size": "1280x720", "seconds": "8" } }, "grokImagine": { "summary": "xAI Grok Imagine", "value": { "model": "xai/grok-imagine-video", "prompt": "A crystal rocket launching from Mars", "duration": 10 } }, "seedance": { "summary": "provider-native Seedance", "value": { "model": "byte/dreamina-seedance-2-0-260128", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/videos/edits": { "post": { "tags": [ "Video" ], "summary": "Edit a video", "description": "Forwards video edit requests to providers with native edit support, such as OpenAI `/videos/edits` and xAI `/videos/edits`.", "operationId": "editVideo", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" }, "examples": { "sora": { "summary": "OpenAI Sora", "value": { "model": "openai/sora-2", "prompt": "A cinematic product reveal", "size": "1280x720", "seconds": "8" } }, "grokImagine": { "summary": "xAI Grok Imagine", "value": { "model": "xai/grok-imagine-video", "prompt": "A crystal rocket launching from Mars", "duration": 10 } }, "seedance": { "summary": "provider-native Seedance", "value": { "model": "byte/dreamina-seedance-2-0-260128", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/videos/extensions": { "post": { "tags": [ "Video" ], "summary": "Extend a video", "description": "Forwards video extension requests to providers with native extension support, such as OpenAI `/videos/extensions`.", "operationId": "extendVideo", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" }, "examples": { "sora": { "summary": "OpenAI Sora", "value": { "model": "openai/sora-2", "prompt": "A cinematic product reveal", "size": "1280x720", "seconds": "8" } }, "grokImagine": { "summary": "xAI Grok Imagine", "value": { "model": "xai/grok-imagine-video", "prompt": "A crystal rocket launching from Mars", "duration": 10 } }, "seedance": { "summary": "provider-native Seedance", "value": { "model": "byte/dreamina-seedance-2-0-260128", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VideoGenerationRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/videos/{video_id}": { "get": { "tags": [ "Video" ], "summary": "Poll a video job", "description": "Retrieves async video job status. `video_*` IDs default to OpenAI, `cgt-*` task IDs default to provider-native, and other IDs default to xAI unless `provider` is supplied.", "operationId": "getVideo", "parameters": [ { "name": "video_id", "in": "path", "required": true, "description": "Video job or request ID.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": false, "description": "Optional upstream provider override for status routes.", "schema": { "type": "string", "enum": [ "openai", "xai" ] } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Video" ], "summary": "Delete a video", "description": "Deletes or cancels a video resource when supported by the upstream provider.", "operationId": "deleteVideo", "parameters": [ { "name": "video_id", "in": "path", "required": true, "description": "Video job or request ID.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": false, "description": "Optional upstream provider override for status routes.", "schema": { "type": "string", "enum": [ "openai", "xai" ] } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/videos/{video_id}/content": { "get": { "tags": [ "Video" ], "summary": "Download video content", "description": "Downloads OpenAI Sora video content or variants. xAI and provider-native return output URLs from their status endpoints instead.", "operationId": "getVideoContent", "parameters": [ { "name": "video_id", "in": "path", "required": true, "description": "OpenAI video ID.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": false, "description": "Optional upstream provider override for status routes.", "schema": { "type": "string", "enum": [ "openai", "xai" ] } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "video/mp4": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/audio/speech": { "post": { "tags": [ "Audio" ], "summary": "Create speech audio", "description": "Text-to-speech route. JSON requests are forwarded to the selected provider's speech endpoint.", "operationId": "createSpeech", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeechRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "audio/mpeg": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/audio/transcriptions": { "post": { "tags": [ "Audio" ], "summary": "Transcribe audio", "description": "Multipart audio transcription route. The gateway logs file metadata only and forwards the file to the selected provider.", "operationId": "createTranscription", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioUploadRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/audio/translations": { "post": { "tags": [ "Audio" ], "summary": "Translate audio to English", "description": "Multipart audio translation route for supported OpenAI-compatible translation models.", "operationId": "createTranslation", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioUploadRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/realtime/client_secrets": { "post": { "tags": [ "Realtime" ], "summary": "Create a realtime client secret", "description": "Creates a short-lived Voxvey-managed secret for `/v1/realtime` WebSocket sessions. Use provider-prefixed realtime models such as `xai/grok-voice-latest` or `openai/gpt-realtime-2`. The returned secret is scoped to the authenticated user and the requested session.", "operationId": "createRealtimeClientSecret", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeClientSecretRequest" }, "examples": { "xaiVoice": { "summary": "xAI voice session", "value": { "expires_after": { "seconds": 300 }, "session": { "model": "xai/grok-voice-latest", "voice": "eve", "modalities": [ "audio", "text" ] } } }, "openaiRealtime": { "summary": "OpenAI realtime session", "value": { "expires_after": { "seconds": 300 }, "session": { "model": "openai/gpt-realtime-2", "voice": "alloy", "modalities": [ "audio", "text" ] } } } } } } }, "responses": { "200": { "description": "Realtime client secret", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeClientSecretResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/files": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List files", "description": "Lists files uploaded to provider-native Files API. Query parameters are forwarded unchanged.", "operationId": "listprovider-nativeFiles", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Upload a file", "description": "Uploads a file to provider-native Files API. Use this for reusable multimodal inputs for `/v1/responses`. The gateway preserves multipart file bytes, replaces client auth with the configured upstream credential, and charges the native proxy credit amount.", "operationId": "uploadprovider-nativeFile", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/provider-nativeFileUploadRequest" } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/files/{file_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Retrieve file metadata", "description": "Retrieves metadata for a previously uploaded provider-native file.", "operationId": "retrieveprovider-nativeFile", "parameters": [ { "name": "file_id", "in": "path", "required": true, "description": "provider-native file ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Delete a file", "description": "Deletes a previously uploaded provider-native file.", "operationId": "deleteprovider-nativeFile", "parameters": [ { "name": "file_id", "in": "path", "required": true, "description": "provider-native file ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/contents/generations/tasks": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List content generation tasks", "description": "Lists content generation tasks when supported by the upstream provider-native API. Query parameters are forwarded unchanged.", "operationId": "listprovider-nativeContentGenerationTasks", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create a video or content generation task", "description": "Creates a native provider-native content generation task, commonly used for video generation models such as `byte/dreamina-seedance-2-0-260128`. JSON requests may use bare provider-native model IDs or `byte/*`; the gateway strips `byte/` before forwarding upstream. Successful task creation charges `media task credits`.", "operationId": "createprovider-nativeContentGenerationTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/dreamina-seedance-2-0-260128", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/contents/generations/tasks/{task_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Poll a content generation task", "description": "Retrieves task status and outputs for a provider-native content generation task.", "operationId": "getprovider-nativeContentGenerationTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native content generation task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Cancel or delete a content generation task", "description": "Forwards DELETE to the native task endpoint when supported upstream.", "operationId": "deleteprovider-nativeContentGenerationTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native content generation task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/content/generations/tasks": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List content generation tasks", "description": "Alias for `/v1/byte/contents/generations/tasks` used by some provider-native SDKs or docs.", "operationId": "listprovider-nativecontentGenerationsTasks", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create a content generation task", "description": "Alias for `/v1/byte/contents/generations/tasks` used by some provider-native SDKs or docs.", "operationId": "createprovider-nativecontentGenerationsTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/content/generation/tasks": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List content generation tasks", "description": "Alias for `/v1/byte/contents/generations/tasks` used by some provider-native SDKs or docs.", "operationId": "listprovider-nativecontentGenerationTasks", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create a content generation task", "description": "Alias for `/v1/byte/contents/generations/tasks` used by some provider-native SDKs or docs.", "operationId": "createprovider-nativecontentGenerationTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/embeddings/multimodal": { "post": { "tags": [ "Provider-Native Media" ], "summary": "Create multimodal embeddings", "description": "Forwards to provider-native multimodal embeddings for image, video, and text vectorization. Use models such as `byte/skylark-embedding-vision-251215`. Successful calls charge `media task credits`.", "operationId": "createprovider-nativeMultimodalEmbedding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/skylark-embedding-vision-251215", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/context": { "post": { "tags": [ "Provider-Native Media" ], "summary": "Create context state", "description": "Forwards JSON to provider-native context creation helpers for supported context-cache workflows.", "operationId": "createprovider-nativeContext", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/context/cache": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List context caches", "description": "Lists native provider-native context cache resources.", "operationId": "listprovider-nativecontextCache", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create context cache", "description": "Creates a native provider-native context cache resource.", "operationId": "createprovider-nativecontextCache", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/context/cache/{cache_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Retrieve context cache", "description": "Retrieves a native provider-native context cache resource.", "operationId": "getprovider-nativecontextCacheItem", "parameters": [ { "name": "cache_id", "in": "path", "required": true, "description": "provider-native context cache ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Update context cache", "description": "Forwards JSON to a native context cache item endpoint.", "operationId": "updateprovider-nativecontextCacheItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Delete context cache", "description": "Deletes a native provider-native context cache resource.", "operationId": "deleteprovider-nativecontextCacheItem", "parameters": [ { "name": "cache_id", "in": "path", "required": true, "description": "provider-native context cache ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/context/caches": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List context caches", "description": "Lists native provider-native context cache resources.", "operationId": "listprovider-nativecontextCaches", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create context cache", "description": "Creates a native provider-native context cache resource.", "operationId": "createprovider-nativecontextCaches", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/context/caches/{cache_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Retrieve context cache", "description": "Retrieves a native provider-native context cache resource.", "operationId": "getprovider-nativecontextCachesItem", "parameters": [ { "name": "cache_id", "in": "path", "required": true, "description": "provider-native context cache ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Update context cache", "description": "Forwards JSON to a native context cache item endpoint.", "operationId": "updateprovider-nativecontextCachesItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/seed-2-0-lite-260428", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Delete context cache", "description": "Deletes a native provider-native context cache resource.", "operationId": "deleteprovider-nativecontextCachesItem", "parameters": [ { "name": "cache_id", "in": "path", "required": true, "description": "provider-native context cache ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/hyper3d/tasks": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List 3D tasks", "description": "Create or list native Hyper3D task requests for provider-native 3D generation models.", "operationId": "listprovider-nativehyper3dTasks", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create a 3D task", "description": "Create or list native Hyper3D task requests for provider-native 3D generation models.", "operationId": "createprovider-nativehyper3dTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/Hyper3d-Rodin-Gen2", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/hyper3d/tasks/{task_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Poll a 3D task", "description": "Retrieves status and outputs for a native provider-native 3D generation task.", "operationId": "getprovider-nativehyper3dTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native 3D task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Cancel or delete a 3D task", "description": "Forwards DELETE to the native task endpoint when supported upstream.", "operationId": "deleteprovider-nativehyper3dTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native 3D task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/hitem3d/tasks": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List 3D tasks", "description": "Create or list native Hitem3D task requests for provider-native 3D generation models.", "operationId": "listprovider-nativehitem3dTasks", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create a 3D task", "description": "Create or list native Hitem3D task requests for provider-native 3D generation models.", "operationId": "createprovider-nativehitem3dTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/Hitem3d-2.0", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/hitem3d/tasks/{task_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Poll a 3D task", "description": "Retrieves status and outputs for a native provider-native 3D generation task.", "operationId": "getprovider-nativehitem3dTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native 3D task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Cancel or delete a 3D task", "description": "Forwards DELETE to the native task endpoint when supported upstream.", "operationId": "deleteprovider-nativehitem3dTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native 3D task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/3d/tasks": { "get": { "tags": [ "Provider-Native Media" ], "summary": "List 3D tasks", "description": "Create or list generic native 3D task requests for provider-native 3D generation models.", "operationId": "listprovider-nativethreeDTasks", "parameters": [], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Provider-Native Media" ], "summary": "Create a 3D task", "description": "Create or list generic native 3D task requests for provider-native 3D generation models.", "operationId": "createprovider-nativethreeDTask", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider-nativeNativeJsonRequest" }, "examples": { "json": { "summary": "Native provider-native JSON", "value": { "model": "byte/Hyper3d-Rodin-Gen2", "content": [ { "type": "text", "text": "Create a short cinematic clip." } ] } } } } } }, "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/byte/3d/tasks/{task_id}": { "get": { "tags": [ "Provider-Native Media" ], "summary": "Poll a 3D task", "description": "Retrieves status and outputs for a native provider-native 3D generation task.", "operationId": "getprovider-nativethreeDTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native 3D task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "delete": { "tags": [ "Provider-Native Media" ], "summary": "Cancel or delete a 3D task", "description": "Forwards DELETE to the native task endpoint when supported upstream.", "operationId": "deleteprovider-nativethreeDTask", "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "provider-native 3D task ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v2/{search_path}": { "get": { "tags": [ "Search" ], "summary": "Proxy Search GET request", "description": "Proxies Search-compatible v2 API calls to the configured search backend. The path and query string after `/v2/` are forwarded unchanged. Successful requests charge 5 credits unless the caller is exempt from gateway billing.", "operationId": "searchGetProxy", "parameters": [ { "name": "search_path", "in": "path", "required": true, "description": "Forwarded path segment. Nested paths are represented by the route after the prefix.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } }, "post": { "tags": [ "Search" ], "summary": "Proxy Search POST request", "description": "Proxies Search-compatible v2 API calls to the configured search backend. The path and query string after `/v2/` are forwarded unchanged. Successful requests charge 5 credits unless the caller is exempt from gateway billing.", "operationId": "searchPostProxy", "parameters": [ { "name": "search_path", "in": "path", "required": true, "description": "Forwarded path segment. Nested paths are represented by the route after the prefix.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } } } } }, "put": { "tags": [ "Search" ], "summary": "Proxy Search PUT request", "description": "Proxies Search-compatible v2 API calls to the configured search backend. The path and query string after `/v2/` are forwarded unchanged. Successful requests charge 5 credits unless the caller is exempt from gateway billing.", "operationId": "searchPutProxy", "parameters": [ { "name": "search_path", "in": "path", "required": true, "description": "Forwarded path segment. Nested paths are represented by the route after the prefix.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } } } } }, "patch": { "tags": [ "Search" ], "summary": "Proxy Search PATCH request", "description": "Proxies Search-compatible v2 API calls to the configured search backend. The path and query string after `/v2/` are forwarded unchanged. Successful requests charge 5 credits unless the caller is exempt from gateway billing.", "operationId": "searchPatchProxy", "parameters": [ { "name": "search_path", "in": "path", "required": true, "description": "Forwarded path segment. Nested paths are represented by the route after the prefix.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } } } } }, "delete": { "tags": [ "Search" ], "summary": "Proxy Search DELETE request", "description": "Proxies Search-compatible v2 API calls to the configured search backend. The path and query string after `/v2/` are forwarded unchanged. Successful requests charge 5 credits unless the caller is exempt from gateway billing.", "operationId": "searchDeleteProxy", "parameters": [ { "name": "search_path", "in": "path", "required": true, "description": "Forwarded path segment. Nested paths are represented by the route after the prefix.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful upstream response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "201": { "description": "Successful upstream creation response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "$ref": "#/components/responses/UpstreamError" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "404": { "description": "Unsupported gateway route or upstream resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "413": { "description": "Request body exceeds the gateway body limit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } }, "/v1/mcp": { "post": { "tags": [ "Tools" ], "summary": "Call the MCP server", "description": "Streamable HTTP JSON-RPC endpoint for supported MCP tools. `tools/list` returns available tools. `tools/call` executes a tool and charges 5 credits only when the tool succeeds.", "operationId": "postMcp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcRequest" } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationError" }, "502": { "$ref": "#/components/responses/UpstreamError" } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Use a Voxvey bearer token." } }, "schemas": { "OpenAPIObject": { "type": "object", "additionalProperties": true }, "HealthResponse": { "type": "object", "properties": { "status": { "type": "string", "examples": [ "ok" ] } }, "required": [ "status" ] }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": [ "string", "null" ] } }, "required": [ "message" ] } }, "required": [ "error" ] }, "ModelList": { "type": "object", "properties": { "object": { "type": "string", "examples": [ "list" ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Model" } } }, "required": [ "object", "data" ] }, "Model": { "type": "object", "properties": { "id": { "type": "string", "examples": [ "byte/seed-2-0-lite-260428" ] }, "object": { "type": "string", "examples": [ "model" ] }, "created": { "type": "integer" }, "owned_by": { "type": "string", "examples": [ "byte" ] } }, "required": [ "id", "object", "owned_by" ] }, "UserInfoResponse": { "type": "object", "properties": { "user_info": { "type": "object", "properties": { "user_id": { "type": "string" }, "max_budget": { "type": "number" }, "spend": { "type": "number" } }, "required": [ "user_id", "max_budget", "spend" ] } }, "required": [ "user_info" ] }, "ChatCompletionRequest": { "type": "object", "required": [ "model", "messages" ], "properties": { "model": { "type": "string", "examples": [ "byte/seed-2-0-lite-260428" ] }, "messages": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "stream": { "type": "boolean" } }, "additionalProperties": true }, "ClaudeMessagesRequest": { "type": "object", "required": [ "model", "messages", "max_tokens" ], "properties": { "model": { "type": "string", "examples": [ "anthropic/claude-sonnet-4-5", "claude/claude-haiku-4-5" ] }, "messages": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "max_tokens": { "type": "integer", "minimum": 0, "examples": [ 1024 ] }, "system": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "object", "additionalProperties": true } } ] }, "stream": { "type": "boolean" } }, "additionalProperties": true }, "ResponsesRequest": { "type": "object", "required": [ "model", "input" ], "properties": { "model": { "type": "string", "examples": [ "byte/seed-2-0-mini-260428" ] }, "input": {}, "instructions": { "type": "string" }, "stream": { "type": "boolean" } }, "additionalProperties": true }, "EmbeddingRequest": { "type": "object", "required": [ "model", "input" ], "properties": { "model": { "type": "string" }, "input": {} }, "additionalProperties": true }, "ImageGenerationRequest": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "examples": [ "openai/gpt-image-1", "xai/grok-imagine-image", "byte/seedream-5-0-260128", "gemini/gemini-2.5-flash-image" ] }, "prompt": { "type": "string" }, "size": { "type": "string", "examples": [ "1024x1024", "2K" ] }, "response_format": { "type": "string", "examples": [ "url", "b64_json" ] } }, "additionalProperties": true }, "ImageEditRequest": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "examples": [ "xai/grok-imagine-image-quality", "openai/gpt-image-1" ] }, "prompt": { "type": "string" }, "image_url": { "type": "string" }, "image": { "type": "string", "format": "binary" }, "size": { "type": "string" }, "response_format": { "type": "string", "examples": [ "url", "b64_json" ] } }, "additionalProperties": true }, "VideoGenerationRequest": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "examples": [ "openai/sora-2", "xai/grok-imagine-video", "byte/dreamina-seedance-2-0-260128" ] }, "prompt": { "type": "string" }, "size": { "type": "string", "examples": [ "1280x720", "1920x1080" ] }, "seconds": { "type": "string", "examples": [ "8", "16", "20" ] }, "duration": { "type": "integer", "examples": [ 10, 12 ] }, "image": { "type": "object", "additionalProperties": true }, "image_url": { "type": "string" }, "content": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": true }, "SpeechRequest": { "type": "object", "required": [ "model", "input", "voice" ], "properties": { "model": { "type": "string", "examples": [ "openai/tts-1" ] }, "input": { "type": "string" }, "voice": { "type": "string" }, "response_format": { "type": "string" } }, "additionalProperties": true }, "AudioUploadRequest": { "type": "object", "required": [ "model", "file" ], "properties": { "model": { "type": "string", "examples": [ "openai/whisper-1" ] }, "file": { "type": "string", "format": "binary" }, "response_format": { "type": "string" }, "language": { "type": "string" }, "prompt": { "type": "string" } }, "additionalProperties": true }, "RealtimeClientSecretRequest": { "type": "object", "properties": { "expires_after": { "type": "object", "properties": { "seconds": { "type": "integer", "minimum": 1, "maximum": 3600, "default": 600 } }, "additionalProperties": true }, "session": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Initial realtime session configuration. `session.model` may be provider-prefixed." }, "model": { "type": "string", "examples": [ "xai/grok-voice-latest", "openai/gpt-realtime-2" ] } }, "additionalProperties": true }, "RealtimeClientSecretResponse": { "type": "object", "properties": { "object": { "type": "string", "examples": [ "realtime.client_secret" ] }, "value": { "type": "string" }, "expires_at": { "type": "integer" }, "model": { "type": "string", "examples": [ "xai/grok-voice-latest" ] }, "session": { "type": "object", "additionalProperties": true } }, "required": [ "object", "value", "expires_at", "model", "session" ] }, "BytePlusFileUploadRequest": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" }, "purpose": { "type": "string", "examples": [ "responses" ] }, "expire_at": { "type": "integer", "description": "Optional Unix timestamp for file expiry when supported upstream." }, "preprocess_configs": { "type": "string", "description": "JSON-encoded preprocess config when sent as multipart form data." } }, "additionalProperties": true }, "BytePlusNativeJsonRequest": { "type": "object", "properties": { "model": { "type": "string", "examples": [ "byte/seed-2-0-lite-260428" ] } }, "additionalProperties": true }, "ProviderResponse": { "type": "object", "additionalProperties": true }, "JsonRpcRequest": { "type": "object", "required": [ "jsonrpc", "id", "method" ], "properties": { "jsonrpc": { "type": "string", "examples": [ "2.0" ] }, "id": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "method": { "type": "string", "examples": [ "tools/list", "tools/call" ] }, "params": { "type": "object", "additionalProperties": true } }, "additionalProperties": true }, "JsonRpcResponse": { "type": "object", "additionalProperties": true } }, "responses": { "Unauthorized": { "description": "Missing or invalid Voxvey bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "InsufficientCredits": { "description": "Wallet balance is too low for the requested reserve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "ValidationError": { "description": "Invalid route, request body, or provider-prefixed model.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "UpstreamError": { "description": "The upstream provider returned an error. The original upstream body is passed through when possible." } } }, "x-byteplus-models": [ "byte/seed-2-0-lite-260428", "byte/seed-2-0-mini-260428", "byte/seed-2-0-pro-260328", "byte/seed-2-0-lite-260228", "byte/seed-2-0-lite-260215", "byte/seed-2-0-mini-260215", "byte/seed-2-0-code-preview-260328", "byte/seed-1-8-251228", "byte/glm-4-7-251222", "byte/deepseek-v4-pro-260425", "byte/deepseek-v4-flash-260425", "byte/deepseek-v3-2-251201", "byte/gpt-oss-120b-250805", "byte/seed-1-6-250915", "byte/seed-1-6-250615", "byte/seed-1-6-flash-250715", "byte/seed-1-6-flash-250615", "byte/seedream-5-0-260128", "byte/seedream-5-0-lite-260128", "byte/seedream-4-5-251128", "byte/seedream-4-0-250828", "byte/dreamina-seedance-2-0-260128", "byte/dreamina-seedance-2-0-fast-260128", "byte/seedance-1-5-pro-251215", "byte/seedance-1-0-pro-250528", "byte/seedance-1-0-pro-fast-251015", "byte/Hyper3d-Rodin-Gen2", "byte/Hitem3d-2.0", "byte/skylark-embedding-vision-251215", "byte/skylark-embedding-vision-250615" ], "x-credit-notes": { "nativeBytePlusProxyCredits": "Native proxy credit reserve", "bytePlusTaskCredits": "Media task credit reserve", "costMultiplier": "V2_COST_MULTIPLIER, default 6x provider cost for usage-metered routes" } }