{ "openapi": "3.1.0", "info": { "title": "Clomio Gateway API", "version": "2026-06-30", "description": "Basic public contract for common Clomio OpenAI-compatible, Anthropic-compatible, Gemini-compatible, and Grok-compatible endpoints. Dynamic model availability, pricing, and group permissions are controlled by the Clomio console." }, "servers": [ { "url": "https://api.clomio.ai", "description": "Default Clomio gateway" } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" }, "GoogleApiKey": { "type": "apiKey", "in": "header", "name": "x-goog-api-key" } }, "parameters": { "Authorization": { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "Bearer sk-..." }, "ContentType": { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "application/json" ] } } } }, "paths": { "/v1/responses": { "post": { "summary": "Create a Responses API response", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "input": { "description": "Text or structured Responses input." }, "stream": { "type": "boolean" }, "previous_response_id": { "type": "string", "description": "Must be a resp_* id when present." }, "max_output_tokens": { "type": "integer" }, "tools": { "type": "array" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } }, "get": { "summary": "Responses WebSocket upgrade entry for Codex-compatible clients", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "responses": { "101": { "description": "WebSocket upgrade accepted" }, "426": { "description": "普通 HTTP GET 会返回 WebSocket upgrade required" }, "404": { "description": "Unsupported group or route" } } } }, "/v1/chat/completions": { "post": { "summary": "Create a Chat Completions response", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "messages" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "messages": { "type": "array" }, "stream": { "type": "boolean" }, "max_tokens": { "type": "integer" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/messages": { "post": { "summary": "Create an Anthropic-compatible Messages response", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" }, { "name": "anthropic-version", "in": "header", "required": false, "schema": { "type": "string" }, "example": "2023-06-01" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "max_tokens", "messages" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "max_tokens": { "type": "integer" }, "messages": { "type": "array" }, "stream": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/messages/count_tokens": { "post": { "summary": "Estimate Anthropic-compatible message tokens", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/models": { "get": { "summary": "List models visible to the current key group", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/embeddings": { "post": { "summary": "Create embeddings", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "input" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "input": { "description": "String or array input." } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/alpha/search": { "post": { "summary": "Run the OpenAI/Codex alpha search endpoint", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/generations": { "post": { "summary": "Generate images with OpenAI/Grok-capable groups", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "prompt": { "type": "string" }, "size": { "type": "string" }, "response_format": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/edits": { "post": { "summary": "Edit an image with OpenAI/Grok-capable groups", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "image", "prompt" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "image": { "type": "string", "format": "binary" }, "prompt": { "type": "string" } } } }, "application/json": { "schema": { "type": "object", "required": [ "prompt" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "images": { "type": "array" }, "prompt": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches": { "get": { "summary": "List image batch jobs", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } }, "post": { "summary": "Submit an image batch job", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/videos/generations": { "post": { "summary": "Create a Grok video generation task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "prompt": { "type": "string" }, "duration": { "type": "integer" }, "aspect_ratio": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/videos": { "get": { "summary": "List or query Grok video resources", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } }, "post": { "summary": "Create a Grok video through the compatibility entry", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/videos/edits": { "post": { "summary": "Edit a Grok video", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "prompt": { "type": "string" }, "video": { "type": "object" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/videos/extensions": { "post": { "summary": "Extend a Grok video", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "model", "prompt" ], "properties": { "model": { "type": "string", "description": "Model id visible to the current Clomio key group." }, "prompt": { "type": "string" }, "video": { "type": "object" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/videos/{id}": { "get": { "summary": "Poll a Grok video generation task", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/web_search": { "post": { "summary": "Run Grok Web Search", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "query" ], "properties": { "query": { "type": "string" }, "max_results": { "type": "integer" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/tts": { "post": { "summary": "Synthesize speech with Grok Voice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "text", "voice_id" ], "properties": { "text": { "type": "string" }, "voice_id": { "type": "string" }, "language": { "type": "string" } } } } } }, "responses": { "200": { "description": "Audio bytes", "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/stt": { "post": { "summary": "Transcribe audio with Grok Voice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary" }, "model": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/realtime": { "get": { "summary": "Upgrade to Grok Voice Realtime WebSocket", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "model", "in": "query", "required": false, "schema": { "type": "string", "default": "grok-voice-latest" } } ], "responses": { "101": { "description": "WebSocket upgrade accepted" }, "400": { "description": "Invalid WebSocket request" }, "401": { "description": "Authentication failed" }, "503": { "description": "No available Grok Voice account" } } } }, "/v1/custom-voices": { "post": { "summary": "Create a custom Grok Voice", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "name": { "type": "string" }, "language": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/usage": { "get": { "summary": "Query usage records for the current key", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "name": "start_date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/sub2api/billing": { "get": { "summary": "Get billing information for the current API key", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1beta/models": { "get": { "summary": "List Gemini-native compatible models", "security": [ { "GoogleApiKey": [] } ], "parameters": [ { "name": "x-goog-api-key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1beta/models/{model}": { "get": { "summary": "Get Gemini model metadata", "security": [ { "GoogleApiKey": [] } ], "parameters": [ { "name": "x-goog-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1beta/models/{model}:generateContent": { "post": { "summary": "Generate Gemini content", "security": [ { "GoogleApiKey": [] } ], "parameters": [ { "name": "x-goog-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array" }, "systemInstruction": { "type": "object" }, "generationConfig": { "type": "object" }, "tools": { "type": "array" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1beta/models/{model}:streamGenerateContent": { "post": { "summary": "Stream Gemini content", "security": [ { "GoogleApiKey": [] } ], "parameters": [ { "name": "x-goog-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alt", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sse" ] } }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array" }, "generationConfig": { "type": "object" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1beta/models/{model}:countTokens": { "post": { "summary": "Estimate Gemini input tokens", "security": [ { "GoogleApiKey": [] } ], "parameters": [ { "name": "x-goog-api-key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "model", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ContentType" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array" } } } } } }, "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/models": { "get": { "summary": "List image batch models", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/{id}": { "get": { "summary": "Get an image batch", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } }, "delete": { "summary": "Delete an image batch record", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/{id}/items": { "get": { "summary": "List image batch items", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/{id}/items/{custom_id}/content": { "get": { "summary": "Download an image batch item", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "custom_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/{id}/download": { "get": { "summary": "Download an image batch archive", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/{id}/cancel": { "post": { "summary": "Cancel an image batch", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/images/batches/{id}/outputs": { "delete": { "summary": "Delete image batch outputs", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } }, "/v1/videos/{id}/content": { "get": { "summary": "Download a completed Grok video", "security": [ { "BearerAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } }, "500": { "description": "Gateway or upstream error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string", "nullable": true } } } } } } } } } } } } }