{ "components": { "schemas": { "AnthropicCompatModel": { "properties": { "created_at": { "type": "string" }, "display_name": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id", "display_name", "created_at" ], "type": "object" }, "AnthropicCompatModelsListResponse": { "properties": { "data": { "items": { "properties": { "created_at": { "type": "string" }, "display_name": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id", "display_name", "created_at" ], "type": "object" }, "type": "array" }, "first_id": { "type": "string" }, "has_more": { "type": "boolean" }, "last_id": { "type": "string" } }, "required": [ "data", "has_more", "first_id", "last_id" ], "type": "object" }, "Benchmark": { "properties": { "aa_slug": { "type": "string" }, "as_of": { "type": "string" }, "coding_index": { "type": "number" }, "evaluations": { "properties": { "aime": { "type": "number" }, "aime_25": { "type": "number" }, "gpqa": { "type": "number" }, "hle": { "type": "number" }, "ifbench": { "type": "number" }, "lcr": { "type": "number" }, "livecodebench": { "type": "number" }, "math_500": { "type": "number" }, "mmlu_pro": { "type": "number" }, "scicode": { "type": "number" }, "tau2": { "type": "number" }, "terminalbench_hard": { "type": "number" } }, "type": "object" }, "intelligence_index": { "type": "number" }, "math_index": { "type": "number" }, "source": { "type": "string" } }, "required": [ "source", "as_of" ], "type": "object" }, "BenchmarkEvaluations": { "properties": { "aime": { "type": "number" }, "aime_25": { "type": "number" }, "gpqa": { "type": "number" }, "hle": { "type": "number" }, "ifbench": { "type": "number" }, "lcr": { "type": "number" }, "livecodebench": { "type": "number" }, "math_500": { "type": "number" }, "mmlu_pro": { "type": "number" }, "scicode": { "type": "number" }, "tau2": { "type": "number" }, "terminalbench_hard": { "type": "number" } }, "type": "object" }, "CallRequest": { "properties": { "guard": { "properties": { "input": { "items": { "properties": { "action": { "type": "string" }, "applies_to": { "type": "string" }, "check": { "type": "string" }, "custom_patterns": { "items": { "type": "string" }, "type": "array" }, "engine": { "type": "string" }, "kind": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "patterns": { "items": { "properties": { "name": { "type": "string" }, "regex": { "type": "string" } }, "required": [ "regex" ], "type": "object" }, "type": "array" }, "presets": { "items": { "type": "string" }, "type": "array" }, "prompt": { "type": "string" }, "replacement": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope": { "properties": { "functions": { "items": { "type": "string" }, "type": "array" }, "kind": { "type": "string" } }, "required": [ "kind" ], "type": "object" }, "scope_type": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "output": { "items": { "properties": { "action": { "type": "string" }, "applies_to": { "type": "string" }, "check": { "type": "string" }, "custom_patterns": { "items": { "type": "string" }, "type": "array" }, "engine": { "type": "string" }, "kind": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "patterns": { "items": { "properties": { "name": { "type": "string" }, "regex": { "type": "string" } }, "required": [ "regex" ], "type": "object" }, "type": "array" }, "presets": { "items": { "type": "string" }, "type": "array" }, "prompt": { "type": "string" }, "replacement": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope": { "properties": { "functions": { "items": { "type": "string" }, "type": "array" }, "kind": { "type": "string" } }, "required": [ "kind" ], "type": "object" }, "scope_type": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "input": { "description": "Any value" }, "input_schema": { "description": "JSON Schema for the input. Optional; defaults to string when omitted.", "type": "object" }, "instructions": { "type": "string" }, "model": { "oneOf": [ { "description": "Model identifier (e.g. \"openai/gpt-4o\")", "type": "string" }, { "properties": { "extra_headers": { "description": "Extra HTTP headers to send with requests to this model", "type": "object" }, "name": { "description": "Model identifier (e.g. \"openai/gpt-4o\")", "type": "string" }, "options": { "description": "Per-model parameters (temperature, max_tokens, reasoning_effort, etc.)", "type": "object" } }, "required": [ "name" ], "type": "object" }, { "description": "Fallback chain — models tried in order on retriable errors", "items": { "oneOf": [ { "type": "string" }, { "properties": { "extra_headers": { "description": "Extra HTTP headers to send with requests to this model", "type": "object" }, "name": { "description": "Model identifier (e.g. \"openai/gpt-4o\")", "type": "string" }, "options": { "description": "Per-model parameters (temperature, max_tokens, reasoning_effort, etc.)", "type": "object" } }, "required": [ "name" ], "type": "object" } ] }, "type": "array" } ] }, "name": { "type": "string" }, "output_schema": { "description": "JSON Schema for the output. Optional; defaults to string when omitted.", "type": "object" }, "parent_span_id": { "type": "string" }, "reasoning_effort": { "description": "Reasoning effort for reasoning-capable models. One of \"low\"", "type": "string" }, "reasoning_summary": { "description": "Opt into thought summary streaming. \"auto\"", "type": "string" }, "route": { "properties": { "prefer": { "type": "string" } }, "type": "object" }, "stream": { "type": "boolean" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" } }, "required": [ "name", "input" ], "type": "object" }, "CanonicalWebSearchTool": { "properties": { "allowed_domains": { "description": "Restrict results to these domains (e.g. \"go.dev\" or \"pkg.go.dev\").", "items": { "type": "string" }, "type": "array" }, "country": { "description": "Two-letter ISO-3166 alpha-2 country code (e.g. \"se\" or \"us\") biasing results to that region. Case-insensitive.", "type": "string" }, "engine": { "description": "Search engine. auto (default) prefers the model's native server tool when available and falls back to Opper's engine. native requires native (400 if the routed model has no native web_search on this endpoint). opper always uses Opper's engine and lets Opper pick the backend. jina and exa pin a specific backend within Opper's engine.", "enum": [ "auto", "native", "opper", "jina", "exa" ], "type": "string" }, "excluded_domains": { "description": "Exclude results from these domains (e.g. \"reddit.com\").", "items": { "type": "string" }, "type": "array" }, "freshness": { "description": "Narrow results by recency. d (24h) | w (7d) | m (30d) | y (1y). Empty (default) applies no time filter.", "enum": [ "d", "w", "m", "y" ], "type": "string" }, "max_results": { "description": "Results per individual search. 0 uses the engine default (typically 5).", "type": "integer" }, "max_total_results": { "description": "Cumulative result cap across every search the model runs in this request. 0 disables the cap.", "type": "integer" }, "max_uses": { "description": "Maximum number of searches the model may run in this request. 0 uses the runtime default.", "type": "integer" }, "search_context_size": { "description": "Per-result snippet length in characters. very_low ≈ 1000; low ≈ 5000; medium ≈ 10000 (default); high ≈ 30000; full returns the full extracted page content (capped ~50000).", "enum": [ "very_low", "low", "medium", "high", "full" ], "type": "string" }, "type": { "description": "Tool discriminator. Must be the literal string \"opper:web_search\".", "enum": [ "opper:web_search" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "ChatAnnotation": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "ChatChoice": { "properties": { "finish_reason": { "type": "string" }, "index": { "type": "integer" }, "message": { "properties": { "annotations": { "items": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "content": { "type": "string" }, "reasoning_content": { "type": "string" }, "role": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "id": { "type": "string" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "function" ], "type": "object" }, "type": "array" } }, "required": [ "role", "content" ], "type": "object" } }, "required": [ "index", "message", "finish_reason" ], "type": "object" }, "ChatFunctionCall": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "ChatMessage": { "properties": { "annotations": { "items": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "content": { "type": "string" }, "reasoning_content": { "type": "string" }, "role": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "id": { "type": "string" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "function" ], "type": "object" }, "type": "array" } }, "required": [ "role", "content" ], "type": "object" }, "ChatRequest": { "properties": { "cache_control": { "description": "Opt in to automatic prompt caching for Anthropic-family models: {\"type\":\"ephemeral\"} (optionally \"ttl\":\"1h\"). Places one moving cache breakpoint on the largest cacheable prefix. Also settable per content part for precise placement. Caching is off unless set; no-op on providers with automatic server-side caching (OpenAI", "type": "object" }, "custom_model_credentials": { "properties": { "api_key": { "type": "string" }, "base_url": { "type": "string" }, "extra": { "type": "object" }, "identifier": { "type": "string" }, "url": { "type": "string" } }, "required": [ "identifier", "api_key" ], "type": "object" }, "max_completion_tokens": { "type": "integer" }, "max_tokens": { "type": "integer" }, "messages": { "items": { "properties": { "content": { "description": "Any value" }, "name": { "type": "string" }, "role": { "type": "string" }, "tool_call_id": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "id": { "type": "string" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "function" ], "type": "object" }, "type": "array" } }, "required": [ "role", "content" ], "type": "object" }, "type": "array" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "output_schema": { "type": "object" }, "reasoning_effort": { "type": "string" }, "response_format": { "type": "object" }, "stop": { "items": { "type": "string" }, "type": "array" }, "stream": { "type": "boolean" }, "stream_options": { "properties": { "include_usage": { "type": "boolean" } }, "type": "object" }, "temperature": { "type": "number" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "aspect_ratio": { "type": "string" }, "function": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "model": { "type": "string" }, "quality": { "type": "string" }, "size": { "type": "string" }, "style": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" } }, "required": [ "messages" ], "type": "object" }, "ChatRequestMessage": { "properties": { "content": { "description": "Any value" }, "name": { "type": "string" }, "role": { "type": "string" }, "tool_call_id": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "id": { "type": "string" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "function" ], "type": "object" }, "type": "array" } }, "required": [ "role", "content" ], "type": "object" }, "ChatRequestTool": { "properties": { "aspect_ratio": { "type": "string" }, "function": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "model": { "type": "string" }, "quality": { "type": "string" }, "size": { "type": "string" }, "style": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "ChatRequestToolFunction": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "ChatResponse": { "properties": { "choices": { "items": { "properties": { "finish_reason": { "type": "string" }, "index": { "type": "integer" }, "message": { "properties": { "annotations": { "items": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "content": { "type": "string" }, "reasoning_content": { "type": "string" }, "role": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "id": { "type": "string" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "function" ], "type": "object" }, "type": "array" } }, "required": [ "role", "content" ], "type": "object" } }, "required": [ "index", "message", "finish_reason" ], "type": "object" }, "type": "array" }, "cost": { "type": "number" }, "created": { "type": "integer" }, "id": { "type": "string" }, "meta": { "properties": { "guards": { "items": { "properties": { "code": { "type": "string" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "phase": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope_type": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "flagged" ], "type": "object" }, "type": "array" }, "trace_uuid": { "type": "string" } }, "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "usage": { "properties": { "completion_tokens": { "type": "integer" }, "completion_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "prompt_tokens": { "type": "integer" }, "prompt_tokens_details": { "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cached_tokens": { "type": "integer" } }, "type": "object" }, "server_tool_use": { "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "type": "object" } }, "required": [ "id", "object", "created", "model", "choices", "usage" ], "type": "object" }, "ChatStreamChoice": { "properties": { "delta": { "properties": { "annotations": { "items": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "content": { "type": "string" }, "reasoning_content": { "type": "string" }, "role": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "index": { "type": "integer" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "index" ], "type": "object" }, "type": "array" } }, "type": "object" }, "finish_reason": { "type": "string" }, "index": { "type": "integer" } }, "required": [ "index", "delta", "finish_reason" ], "type": "object" }, "ChatStreamChunk": { "properties": { "choices": { "items": { "properties": { "delta": { "properties": { "annotations": { "items": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "content": { "type": "string" }, "reasoning_content": { "type": "string" }, "role": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "index": { "type": "integer" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "index" ], "type": "object" }, "type": "array" } }, "type": "object" }, "finish_reason": { "type": "string" }, "index": { "type": "integer" } }, "required": [ "index", "delta", "finish_reason" ], "type": "object" }, "type": "array" }, "cost": { "type": "number" }, "created": { "type": "integer" }, "id": { "type": "string" }, "meta": { "properties": { "guards": { "items": { "properties": { "code": { "type": "string" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "phase": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope_type": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "flagged" ], "type": "object" }, "type": "array" }, "trace_uuid": { "type": "string" } }, "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "time_to_first_token_ms": { "type": "integer" }, "usage": { "properties": { "completion_tokens": { "type": "integer" }, "completion_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "prompt_tokens": { "type": "integer" }, "prompt_tokens_details": { "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cached_tokens": { "type": "integer" } }, "type": "object" }, "server_tool_use": { "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "type": "object" } }, "required": [ "id", "object", "created", "model", "choices" ], "type": "object" }, "ChatStreamDelta": { "properties": { "annotations": { "items": { "properties": { "type": { "type": "string" }, "url_citation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "content": { "type": "string" }, "reasoning_content": { "type": "string" }, "role": { "type": "string" }, "tool_calls": { "items": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "index": { "type": "integer" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "index" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ChatToolCall": { "properties": { "function": { "properties": { "arguments": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "arguments" ], "type": "object" }, "id": { "type": "string" }, "thought_signature": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "type", "function" ], "type": "object" }, "ChatURLCitation": { "properties": { "content": { "type": "string" }, "end_index": { "type": "integer" }, "start_index": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" }, "ChatUsage": { "properties": { "completion_tokens": { "type": "integer" }, "completion_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "prompt_tokens": { "type": "integer" }, "prompt_tokens_details": { "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cached_tokens": { "type": "integer" } }, "type": "object" }, "server_tool_use": { "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens", "total_tokens" ], "type": "object" }, "CountTokensResponse": { "properties": { "cachedContentTokenCount": { "type": "integer" }, "totalTokens": { "type": "integer" } }, "required": [ "totalTokens" ], "type": "object" }, "CreateManagementAPIKeyRequest": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "CreateManagementAPIKeyResponse": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" } }, "required": [ "id", "name", "prefix", "key" ], "type": "object" }, "CreateManagementProjectRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "CreateSpanRequest": { "properties": { "end_time": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "input": { "type": "string" }, "meta": { "type": "object" }, "metadata": { "type": "object" }, "name": { "type": "string" }, "output": { "type": "string" }, "parent_id": { "type": "string" }, "start_time": { "format": "date-time", "type": "string" }, "tags": { "type": "object" }, "trace_id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "CreateSpanResponse": { "properties": { "data": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "trace_id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "trace_id", "name" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "CreateVoiceRequest": { "properties": { "audio": { "type": "string" }, "gender": { "type": "string" }, "languages": { "items": { "type": "string" }, "type": "array" }, "model": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "model", "audio" ], "type": "object" }, "EmbeddingsDataItem": { "properties": { "embedding": { "items": { "type": "number" }, "type": "array" }, "index": { "type": "integer" }, "object": { "type": "string" } }, "required": [ "object", "index", "embedding" ], "type": "object" }, "EmbeddingsRequest": { "properties": { "dimensions": { "type": "integer" }, "encoding_format": { "type": "string" }, "input": { "description": "Any value" }, "model": { "type": "string" }, "user": { "type": "string" } }, "required": [ "input", "model" ], "type": "object" }, "EmbeddingsResponse": { "properties": { "data": { "items": { "properties": { "embedding": { "items": { "type": "number" }, "type": "array" }, "index": { "type": "integer" }, "object": { "type": "string" } }, "required": [ "object", "index", "embedding" ], "type": "object" }, "type": "array" }, "model": { "type": "string" }, "object": { "type": "string" }, "usage": { "properties": { "prompt_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" } }, "required": [ "prompt_tokens", "total_tokens" ], "type": "object" } }, "required": [ "object", "data", "model", "usage" ], "type": "object" }, "EmbeddingsUsageInfo": { "properties": { "prompt_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" } }, "required": [ "prompt_tokens", "total_tokens" ], "type": "object" }, "ErrorDetail": { "properties": { "code": { "type": "string" }, "details": { "description": "Any value" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "ErrorResponse": { "properties": { "error": { "properties": { "code": { "type": "string" }, "details": { "description": "Any value" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "type": "object" } }, "required": [ "error" ], "type": "object" }, "FunctionDetails": { "properties": { "generated_at": { "format": "date-time", "type": "string" }, "hit_count": { "type": "integer" }, "input_schema": { "type": "object" }, "name": { "type": "string" }, "output_schema": { "type": "object" }, "schema_hash": { "type": "string" }, "source": { "type": "string" } }, "required": [ "name", "schema_hash", "generated_at", "hit_count", "source", "input_schema", "output_schema" ], "type": "object" }, "FunctionInfo": { "properties": { "generated_at": { "format": "date-time", "type": "string" }, "has_script": { "type": "boolean" }, "hit_count": { "type": "integer" }, "name": { "type": "string" }, "schema_hash": { "type": "string" } }, "required": [ "name", "schema_hash", "generated_at", "hit_count", "has_script" ], "type": "object" }, "FunctionRevision": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "input_schema": { "type": "object" }, "output_schema": { "type": "object" }, "revision_id": { "type": "integer" }, "schema_hash": { "type": "string" }, "source": { "type": "string" } }, "required": [ "revision_id", "source", "schema_hash", "created_at", "input_schema", "output_schema" ], "type": "object" }, "GenerateContentCandidate": { "properties": { "content": { "properties": { "parts": { "items": { "properties": { "codeExecutionResult": { "type": "object" }, "executableCode": { "type": "object" }, "functionCall": { "type": "object" }, "inlineData": { "type": "object" }, "text": { "type": "string" }, "thought": { "type": "boolean" }, "thoughtSignature": { "type": "string" } }, "type": "object" }, "type": "array" }, "role": { "type": "string" } }, "required": [ "parts" ], "type": "object" }, "finishReason": { "type": "string" }, "groundingMetadata": { "type": "object" }, "index": { "type": "integer" }, "urlContextMetadata": { "type": "object" } }, "required": [ "content", "index" ], "type": "object" }, "GenerateContentContent": { "properties": { "parts": { "items": { "properties": { "codeExecutionResult": { "type": "object" }, "executableCode": { "type": "object" }, "functionCall": { "type": "object" }, "inlineData": { "type": "object" }, "text": { "type": "string" }, "thought": { "type": "boolean" }, "thoughtSignature": { "type": "string" } }, "type": "object" }, "type": "array" }, "role": { "type": "string" } }, "required": [ "parts" ], "type": "object" }, "GenerateContentPart": { "properties": { "codeExecutionResult": { "type": "object" }, "executableCode": { "type": "object" }, "functionCall": { "type": "object" }, "inlineData": { "type": "object" }, "text": { "type": "string" }, "thought": { "type": "boolean" }, "thoughtSignature": { "type": "string" } }, "type": "object" }, "GenerateContentResponse": { "properties": { "candidates": { "items": { "properties": { "content": { "properties": { "parts": { "items": { "properties": { "codeExecutionResult": { "type": "object" }, "executableCode": { "type": "object" }, "functionCall": { "type": "object" }, "inlineData": { "type": "object" }, "text": { "type": "string" }, "thought": { "type": "boolean" }, "thoughtSignature": { "type": "string" } }, "type": "object" }, "type": "array" }, "role": { "type": "string" } }, "required": [ "parts" ], "type": "object" }, "finishReason": { "type": "string" }, "groundingMetadata": { "type": "object" }, "index": { "type": "integer" }, "urlContextMetadata": { "type": "object" } }, "required": [ "content", "index" ], "type": "object" }, "type": "array" }, "modelVersion": { "type": "string" }, "responseId": { "type": "string" }, "usageMetadata": { "properties": { "cachedContentTokenCount": { "type": "integer" }, "candidatesTokenCount": { "type": "integer" }, "opper": { "type": "object" }, "promptTokenCount": { "type": "integer" }, "thoughtsTokenCount": { "type": "integer" }, "totalTokenCount": { "type": "integer" } }, "type": "object" } }, "required": [ "candidates" ], "type": "object" }, "GenerateContentUsageMetadata": { "properties": { "cachedContentTokenCount": { "type": "integer" }, "candidatesTokenCount": { "type": "integer" }, "opper": { "type": "object" }, "promptTokenCount": { "type": "integer" }, "thoughtsTokenCount": { "type": "integer" }, "totalTokenCount": { "type": "integer" } }, "type": "object" }, "GenerationConfig": { "properties": { "max_output_tokens": { "type": "integer" }, "response_mime_type": { "type": "string" }, "response_schema": { "type": "object" }, "seed": { "type": "integer" }, "stop_sequences": { "items": { "type": "string" }, "type": "array" }, "temperature": { "type": "number" }, "thinking_config": { "properties": { "include_thoughts": { "type": "boolean" }, "thinking_budget": { "type": "integer" }, "thinking_level": { "type": "string" } }, "type": "object" }, "thinking_level": { "type": "string" }, "thinking_summaries": { "type": "string" }, "tool_choice": { "description": "Any value" }, "top_k": { "type": "integer" }, "top_p": { "type": "number" } }, "type": "object" }, "GetSpanResponse": { "properties": { "data": { "properties": { "data": { "properties": { "cost": { "type": "number" }, "evaluations": { "items": { "properties": { "cost": { "type": "number" }, "created_at": { "type": "string" }, "duration_ms": { "type": "integer" }, "evaluator_type": { "type": "string" }, "explanation": { "type": "string" }, "flagged": { "type": "boolean" }, "generation_id": { "type": "string" }, "id": { "type": "string" }, "model": { "type": "string" }, "rule_id": { "type": "string" }, "score": { "type": "number" } }, "required": [ "id", "generation_id", "flagged", "created_at" ], "type": "object" }, "type": "array" }, "function": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "generation_id": { "type": "string" }, "instructions": { "type": "string" }, "model": { "type": "string" }, "observations": { "type": "string" }, "score": { "type": "integer" }, "scorer_context": { "type": "object" }, "tags": { "type": "object" }, "total_tokens": { "type": "integer" } }, "type": "object" }, "end_time": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "input": { "description": "Any value" }, "meta": { "type": "object" }, "metadata": { "type": "object" }, "metrics": { "items": { "properties": { "comment": { "type": "string" }, "created_at": { "type": "string" }, "dimension": { "type": "string" }, "id": { "type": "string" }, "value": { "type": "number" } }, "required": [ "id", "dimension", "value", "created_at" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "output": { "description": "Any value" }, "parent_id": { "type": "string" }, "score": { "type": "integer" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "tags": { "type": "object" }, "trace_id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "trace_id", "name" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "GetTraceResponse": { "properties": { "data": { "properties": { "checks_cost": { "type": "number" }, "completion_tokens": { "type": "integer" }, "duration_ms": { "type": "integer" }, "end_time": { "format": "date-time", "type": "string" }, "evaluation_cost": { "type": "number" }, "events": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "data": { "type": "object" }, "id": { "type": "string" }, "kind": { "type": "string" }, "source": { "type": "string" }, "span_id": { "type": "string" }, "span_uuid": { "type": "string" } }, "required": [ "id", "span_id", "kind", "source", "data" ], "type": "object" }, "type": "array" }, "id": { "type": "string" }, "input": { "type": "string" }, "model_cost": { "type": "number" }, "name": { "type": "string" }, "output": { "type": "string" }, "prompt_tokens": { "type": "integer" }, "span_count": { "type": "integer" }, "spans": { "items": { "properties": { "data": { "properties": { "cost": { "type": "number" }, "evaluations": { "items": { "properties": { "cost": { "type": "number" }, "created_at": { "type": "string" }, "duration_ms": { "type": "integer" }, "evaluator_type": { "type": "string" }, "explanation": { "type": "string" }, "flagged": { "type": "boolean" }, "generation_id": { "type": "string" }, "id": { "type": "string" }, "model": { "type": "string" }, "rule_id": { "type": "string" }, "score": { "type": "number" } }, "required": [ "id", "generation_id", "flagged", "created_at" ], "type": "object" }, "type": "array" }, "function": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "generation_id": { "type": "string" }, "instructions": { "type": "string" }, "model": { "type": "string" }, "observations": { "type": "string" }, "score": { "type": "integer" }, "scorer_context": { "type": "object" }, "tags": { "type": "object" }, "total_tokens": { "type": "integer" } }, "type": "object" }, "end_time": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "id": { "type": "string" }, "input": { "description": "Any value" }, "meta": { "type": "object" }, "metadata": { "type": "object" }, "metrics": { "items": { "properties": { "comment": { "type": "string" }, "created_at": { "type": "string" }, "dimension": { "type": "string" }, "id": { "type": "string" }, "value": { "type": "number" } }, "required": [ "id", "dimension", "value", "created_at" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "output": { "description": "Any value" }, "parent_id": { "type": "string" }, "score": { "type": "integer" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "tags": { "type": "object" }, "trace_id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "trace_id", "name" ], "type": "object" }, "type": "array" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "total_tokens": { "type": "integer" } }, "required": [ "id", "span_count", "spans" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "GuardInfo": { "properties": { "code": { "type": "string" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "phase": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope_type": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "flagged" ], "type": "object" }, "GuardrailConfig": { "properties": { "action": { "type": "string" }, "applies_to": { "type": "string" }, "check": { "type": "string" }, "custom_patterns": { "items": { "type": "string" }, "type": "array" }, "engine": { "type": "string" }, "kind": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "patterns": { "items": { "properties": { "name": { "type": "string" }, "regex": { "type": "string" } }, "required": [ "regex" ], "type": "object" }, "type": "array" }, "presets": { "items": { "type": "string" }, "type": "array" }, "prompt": { "type": "string" }, "replacement": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope": { "properties": { "functions": { "items": { "type": "string" }, "type": "array" }, "kind": { "type": "string" } }, "required": [ "kind" ], "type": "object" }, "scope_type": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "ImageJobResponse": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" } }, "required": [ "id", "status_url" ], "type": "object" }, "ImageRequest": { "properties": { "aspect_ratio": { "type": "string" }, "async": { "description": "Run generation on the background worker and return a job to poll (202) instead of waiting inline (200). Use for slow models. Single-image only.", "type": "boolean" }, "image": { "type": "string" }, "mask": { "type": "string" }, "model": { "type": "string" }, "n": { "type": "integer" }, "parameters": { "type": "object" }, "prompt": { "type": "string" }, "quality": { "type": "string" }, "reference_images": { "items": { "type": "string" }, "type": "array" }, "resolution": { "description": "Output-resolution tier for models that declare one (e.g. xAI 1k/2k). Separate axis from quality.", "type": "string" }, "response_format": { "type": "string" }, "size": { "type": "string" }, "store": { "description": "Persist each generated image to /v3/files and return a reusable file_id per image. Defaults to true; set false to skip.", "type": "boolean" } }, "required": [ "model", "prompt" ], "type": "object" }, "ImageResponse": { "properties": { "created": { "type": "integer" }, "data": { "items": { "properties": { "b64_json": { "type": "string" }, "file_id": { "type": "string" }, "mime_type": { "type": "string" }, "revised_prompt": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "type": "string" }, "model": { "type": "string" }, "usage": { "properties": { "cost": { "type": "number" }, "images": { "type": "integer" } }, "required": [ "cost", "images" ], "type": "object" } }, "required": [ "id", "model", "created", "data", "usage" ], "type": "object" }, "InteractionsError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "InteractionsFunction": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "InteractionsRequest": { "properties": { "agent": { "type": "string" }, "background": { "type": "boolean" }, "cache_control": { "description": "Opt in to automatic prompt caching for Anthropic-family models routed through this Gemini-shape endpoint: {\"type\":\"ephemeral\"} (optionally \"ttl\":\"1h\"). Places one moving cache breakpoint on the largest cacheable prefix. Caching is off unless set; no-op on Gemini and other providers with automatic server-side caching. Cache writes cost 1.25x input and reads 0.1x", "type": "object" }, "contents": { "description": "Any value" }, "custom_model_credentials": { "properties": { "api_key": { "type": "string" }, "base_url": { "type": "string" }, "extra": { "type": "object" }, "identifier": { "type": "string" }, "url": { "type": "string" } }, "required": [ "identifier", "api_key" ], "type": "object" }, "generation_config": { "properties": { "max_output_tokens": { "type": "integer" }, "response_mime_type": { "type": "string" }, "response_schema": { "type": "object" }, "seed": { "type": "integer" }, "stop_sequences": { "items": { "type": "string" }, "type": "array" }, "temperature": { "type": "number" }, "thinking_config": { "properties": { "include_thoughts": { "type": "boolean" }, "thinking_budget": { "type": "integer" }, "thinking_level": { "type": "string" } }, "type": "object" }, "thinking_level": { "type": "string" }, "thinking_summaries": { "type": "string" }, "tool_choice": { "description": "Any value" }, "top_k": { "type": "integer" }, "top_p": { "type": "number" } }, "type": "object" }, "input": { "description": "Any value" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "previous_interaction_id": { "type": "string" }, "response_format": { "type": "object" }, "response_mime_type": { "type": "string" }, "safety_settings": { "items": { "properties": { "category": { "type": "string" }, "threshold": { "type": "string" } }, "type": "object" }, "type": "array" }, "store": { "type": "boolean" }, "stream": { "type": "boolean" }, "system_instruction": { "properties": { "Text": { "type": "string" } }, "required": [ "Text" ], "type": "object" }, "tool_config": { "properties": { "function_calling_config": { "properties": { "allowed_function_names": { "items": { "type": "string" }, "type": "array" }, "mode": { "type": "string" } }, "type": "object" } }, "type": "object" }, "tools": { "items": { "properties": { "codeExecution": { "description": "Any value" }, "code_execution": { "description": "Any value" }, "description": { "type": "string" }, "function_declarations": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "googleSearch": { "description": "Any value" }, "googleSearchRetrieval": { "description": "Any value" }, "google_search": { "description": "Any value" }, "google_search_retrieval": { "description": "Any value" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "type": { "type": "string" }, "urlContext": { "description": "Any value" }, "url_context": { "description": "Any value" } }, "type": "object" }, "type": "array" } }, "required": [ "input", "contents" ], "type": "object" }, "InteractionsResponse": { "properties": { "agent": { "type": "string" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "id": { "type": "string" }, "model": { "type": "string" }, "previous_interaction_id": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "steps": { "items": { "properties": { "arguments": { "type": "object" }, "content": { "items": { "properties": { "data": { "type": "string" }, "role": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "type": "string" }, "name": { "type": "string" }, "signature": { "type": "string" }, "summary": { "properties": { "data": { "type": "string" }, "role": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "usage": { "properties": { "total_cached_tokens": { "type": "integer" }, "total_input_tokens": { "type": "integer" }, "total_output_tokens": { "type": "integer" }, "total_thought_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" } }, "type": "object" } }, "required": [ "status" ], "type": "object" }, "InteractionsStep": { "properties": { "arguments": { "type": "object" }, "content": { "items": { "properties": { "data": { "type": "string" }, "role": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "type": "array" }, "id": { "type": "string" }, "name": { "type": "string" }, "signature": { "type": "string" }, "summary": { "properties": { "data": { "type": "string" }, "role": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "InteractionsTool": { "properties": { "codeExecution": { "description": "Any value" }, "code_execution": { "description": "Any value" }, "description": { "type": "string" }, "function_declarations": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "googleSearch": { "description": "Any value" }, "googleSearchRetrieval": { "description": "Any value" }, "google_search": { "description": "Any value" }, "google_search_retrieval": { "description": "Any value" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "type": { "type": "string" }, "urlContext": { "description": "Any value" }, "url_context": { "description": "Any value" } }, "type": "object" }, "InteractionsUsage": { "properties": { "total_cached_tokens": { "type": "integer" }, "total_input_tokens": { "type": "integer" }, "total_output_tokens": { "type": "integer" }, "total_thought_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" } }, "type": "object" }, "ListTracesItem": { "properties": { "duration_ms": { "type": "integer" }, "end_time": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "span_count": { "type": "integer" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "span_count" ], "type": "object" }, "ManagementAPIKey": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "prefix": { "type": "string" } }, "required": [ "id", "name", "prefix" ], "type": "object" }, "ManagementProject": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" } }, "required": [ "uuid", "name", "description" ], "type": "object" }, "MessagesMessage": { "properties": { "content": { "description": "Any value" }, "role": { "type": "string" } }, "required": [ "role", "content" ], "type": "object" }, "MessagesRequest": { "properties": { "cache_control": { "description": "Opt in to top-level automatic prompt caching: {\"type\":\"ephemeral\"} (optionally \"ttl\":\"1h\"). Places one moving breakpoint on the largest cacheable prefix. Explicit per-block cache_control on system/message/tool content takes precedence. Caching is off unless set. Cache writes cost 1.25x input and reads 0.1x", "type": "object" }, "max_tokens": { "type": "integer" }, "messages": { "items": { "properties": { "content": { "description": "Any value" }, "role": { "type": "string" } }, "required": [ "role", "content" ], "type": "object" }, "type": "array" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "output_config": { "description": "Output configuration. A format of {\"type\":\"json_schema\" + \"schema\":{...}} constrains the response to that JSON Schema. An effort of low|medium|high sets adaptive-thinking effort. Sending a format here and a top-level output_format is a 400.", "type": "object" }, "output_format": { "description": "Structured output; superseded by output_config.format. Accepts either the Messages API shape ({\"type\":\"json_schema\" + \"schema\":{...}}) or the OpenAI-style envelope ({\"type\":\"json_schema\" + \"json_schema\":{\"name\":... + \"schema\":{...}}}).", "type": "object" }, "stop_sequences": { "items": { "type": "string" }, "type": "array" }, "stream": { "type": "boolean" }, "system": { "description": "Any value" }, "temperature": { "type": "number" }, "thinking": { "description": "Any value" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "cache_control": { "type": "object" }, "description": { "type": "string" }, "input_schema": { "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "top_k": { "type": "integer" }, "top_p": { "type": "number" } }, "required": [ "model", "messages", "max_tokens" ], "type": "object" }, "MessagesResponse": { "properties": { "content": { "items": { "description": "Any value" }, "type": "array" }, "id": { "type": "string" }, "model": { "type": "string" }, "role": { "type": "string" }, "stop_reason": { "type": "string" }, "stop_sequence": { "type": "string" }, "type": { "type": "string" }, "usage": { "properties": { "cache_creation_input_tokens": { "type": "integer" }, "cache_read_input_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "server_tool_use": { "type": "object" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" } }, "required": [ "id", "type", "role", "content", "model", "stop_reason", "stop_sequence", "usage" ], "type": "object" }, "MessagesResponseBlock": { "properties": { "id": { "type": "string" }, "input": { "description": "Any value" }, "name": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "MessagesTool": { "properties": { "cache_control": { "type": "object" }, "description": { "type": "string" }, "input_schema": { "type": "object" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "MessagesUsage": { "properties": { "cache_creation_input_tokens": { "type": "integer" }, "cache_read_input_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "server_tool_use": { "type": "object" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" }, "ModelInfo": { "properties": { "access": { "type": "string" }, "aliases": { "items": { "type": "string" }, "type": "array" }, "api_type": { "type": "string" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "context_window": { "type": "integer" }, "cost": { "type": "number" }, "country": { "type": "string" }, "description": { "type": "string" }, "family": { "type": "string" }, "featured": { "type": "boolean" }, "id": { "type": "string" }, "maker": { "type": "string" }, "maker_country": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "model": { "type": "string" }, "model_id": { "type": "string" }, "name": { "type": "string" }, "params": { "properties": { "default_max_tokens": { "type": "integer" }, "embedding": { "properties": { "dimensions": { "type": "integer" }, "max_input_tokens": { "type": "integer" }, "supports_dimensions": { "type": "boolean" } }, "required": [ "dimensions" ], "type": "object" }, "image": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "qualities": { "items": { "type": "string" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "size_constraints": { "properties": { "max_edge": { "type": "integer" }, "max_pixels": { "type": "integer" }, "max_ratio": { "type": "integer" }, "min_edge": { "type": "integer" }, "min_pixels": { "type": "integer" }, "multiple_of": { "type": "integer" } }, "type": "object" }, "sizes": { "items": { "type": "string" }, "type": "array" }, "styles": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "image_edit": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" } }, "type": "object" }, "max_tokens": { "type": "boolean" }, "realtime": { "properties": { "default_voice": { "type": "string" }, "input_audio_format": { "type": "string" }, "input_sample_rate": { "type": "integer" }, "output_audio_format": { "type": "string" }, "output_sample_rate": { "type": "integer" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "sample_rate": { "type": "integer" }, "supports_tools": { "type": "boolean" }, "supports_vad": { "type": "boolean" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "stt": { "properties": { "default_language": { "type": "string" }, "diarize": { "type": "boolean" }, "formats": { "items": { "type": "string" }, "type": "array" }, "languages": { "items": { "type": "string" }, "type": "array" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "stream": { "type": "boolean" } }, "type": "object" }, "temperature": { "properties": { "default": { "type": "number" }, "max": { "type": "number" }, "min": { "type": "number" } }, "required": [ "min", "max", "default" ], "type": "object" }, "tts": { "properties": { "default_voice": { "type": "string" }, "formats": { "items": { "type": "string" }, "type": "array" }, "max_length": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "video": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "max_duration": { "type": "integer" }, "max_fps": { "type": "integer" }, "max_frames": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "speed_modes": { "items": { "type": "string" }, "type": "array" }, "supports_seed": { "type": "boolean" } }, "type": "object" } }, "required": [ "default_max_tokens" ], "type": "object" }, "pooled": { "type": "boolean" }, "pricing": { "properties": { "audio_cached_input": { "items": { "type": "number" }, "type": "array" }, "audio_input": { "items": { "type": "number" }, "type": "array" }, "audio_input_per_minute": { "type": "number" }, "audio_output": { "items": { "type": "number" }, "type": "array" }, "audio_output_per_minute": { "type": "number" }, "billing_unit": { "type": "string" }, "cache_creation": { "items": { "type": "number" }, "type": "array" }, "cache_creation_1h": { "items": { "type": "number" }, "type": "array" }, "cached_input": { "items": { "type": "number" }, "type": "array" }, "free_reference_images": { "type": "integer" }, "google_search_price_per_prompt": { "type": "number" }, "google_search_price_per_query": { "type": "number" }, "image_cached_input": { "items": { "type": "number" }, "type": "array" }, "image_input": { "items": { "type": "number" }, "type": "array" }, "image_output": { "items": { "type": "number" }, "type": "array" }, "image_prices": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "type": "object" }, "input": { "items": { "type": "number" }, "type": "array" }, "input_surcharge_multiplier": { "type": "number" }, "input_surcharge_threshold_tokens": { "type": "integer" }, "input_transcription_per_minute": { "additionalProperties": { "type": "number" }, "type": "object" }, "openai_code_interpreter_price_per_session": { "type": "number" }, "openai_file_search_price_per_call": { "type": "number" }, "openai_web_search_price_per_call": { "type": "number" }, "output": { "items": { "type": "number" }, "type": "array" }, "output_surcharge_multiplier": { "type": "number" }, "price_first_megapixel": { "type": "number" }, "price_per_extra_reference_image": { "type": "number" }, "price_per_generation": { "type": "number" }, "price_per_m_chars": { "type": "number" }, "price_per_megapixel": { "type": "number" }, "price_per_minute": { "type": "number" }, "price_per_page": { "type": "number" }, "price_per_second": { "type": "number" }, "price_per_second_audio": { "type": "number" }, "price_per_second_by_resolution": { "additionalProperties": { "type": "number" }, "type": "object" }, "price_per_second_voice": { "type": "number" }, "price_vector_style": { "type": "number" }, "rates": { "items": { "properties": { "amount": { "type": "number" }, "dimensions": { "additionalProperties": { "type": "string" }, "type": "object" }, "unit": { "type": "string" } }, "required": [ "unit", "amount" ], "type": "object" }, "type": "array" }, "reasoning": { "items": { "type": "number" }, "type": "array" }, "reported_cost_markup": { "type": "number" }, "thresholds": { "items": { "type": "integer" }, "type": "array" }, "web_fetch_price_per_request": { "type": "number" }, "web_search_price_per_request": { "type": "number" }, "xai_x_search_price_per_call": { "type": "number" } }, "type": "object" }, "provider": { "type": "string" }, "provider_display_name": { "type": "string" }, "quality": { "type": "string" }, "region": { "type": "string" }, "retired_at": { "format": "date-time", "type": "string" }, "server_tools": { "additionalProperties": { "type": "string" }, "type": "object" }, "speed": { "type": "string" }, "successor": { "type": "string" }, "thinking": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "id", "type", "provider", "provider_display_name", "name", "model_id", "capabilities", "speed", "quality", "context_window", "description" ], "type": "object" }, "ModelListItem": { "properties": { "access": { "type": "string" }, "aliases": { "items": { "type": "string" }, "type": "array" }, "api_type": { "type": "string" }, "benchmarks": { "properties": { "aa_slug": { "type": "string" }, "as_of": { "type": "string" }, "coding_index": { "type": "number" }, "evaluations": { "properties": { "aime": { "type": "number" }, "aime_25": { "type": "number" }, "gpqa": { "type": "number" }, "hle": { "type": "number" }, "ifbench": { "type": "number" }, "lcr": { "type": "number" }, "livecodebench": { "type": "number" }, "math_500": { "type": "number" }, "mmlu_pro": { "type": "number" }, "scicode": { "type": "number" }, "tau2": { "type": "number" }, "terminalbench_hard": { "type": "number" } }, "type": "object" }, "intelligence_index": { "type": "number" }, "math_index": { "type": "number" }, "source": { "type": "string" } }, "required": [ "source", "as_of" ], "type": "object" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "compliance": { "properties": { "cache_scope": { "type": "string" }, "cache_ttl_seconds": { "type": "integer" }, "caching": { "type": "string" }, "content_storage": { "type": "string" }, "country": { "type": "string" }, "dpa_available": { "type": "boolean" }, "inference_location": { "type": "string" }, "logging": { "type": "string" }, "moderation": { "type": "string" }, "residency": { "type": "string" }, "retention_days": { "type": "integer" }, "route_id": { "type": "string" }, "storage_location": { "type": "string" }, "third_party_access": { "type": "boolean" }, "training": { "type": "string" }, "transfer_mechanism": { "type": "string" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "dpa_available", "third_party_access" ], "type": "object" }, "context_window": { "type": "integer" }, "cost": { "type": "number" }, "country": { "type": "string" }, "description": { "type": "string" }, "family": { "type": "string" }, "featured": { "type": "boolean" }, "id": { "type": "string" }, "maker": { "properties": { "country": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug" ], "type": "object" }, "max_output_tokens": { "type": "integer" }, "model": { "type": "string" }, "model_id": { "type": "string" }, "name": { "type": "string" }, "params": { "properties": { "default_max_tokens": { "type": "integer" }, "embedding": { "properties": { "dimensions": { "type": "integer" }, "max_input_tokens": { "type": "integer" }, "supports_dimensions": { "type": "boolean" } }, "required": [ "dimensions" ], "type": "object" }, "image": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "qualities": { "items": { "type": "string" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "size_constraints": { "properties": { "max_edge": { "type": "integer" }, "max_pixels": { "type": "integer" }, "max_ratio": { "type": "integer" }, "min_edge": { "type": "integer" }, "min_pixels": { "type": "integer" }, "multiple_of": { "type": "integer" } }, "type": "object" }, "sizes": { "items": { "type": "string" }, "type": "array" }, "styles": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "image_edit": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" } }, "type": "object" }, "max_tokens": { "type": "boolean" }, "realtime": { "properties": { "default_voice": { "type": "string" }, "input_audio_format": { "type": "string" }, "input_sample_rate": { "type": "integer" }, "output_audio_format": { "type": "string" }, "output_sample_rate": { "type": "integer" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "sample_rate": { "type": "integer" }, "supports_tools": { "type": "boolean" }, "supports_vad": { "type": "boolean" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "stt": { "properties": { "default_language": { "type": "string" }, "diarize": { "type": "boolean" }, "formats": { "items": { "type": "string" }, "type": "array" }, "languages": { "items": { "type": "string" }, "type": "array" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "stream": { "type": "boolean" } }, "type": "object" }, "temperature": { "properties": { "default": { "type": "number" }, "max": { "type": "number" }, "min": { "type": "number" } }, "required": [ "min", "max", "default" ], "type": "object" }, "tts": { "properties": { "default_voice": { "type": "string" }, "formats": { "items": { "type": "string" }, "type": "array" }, "max_length": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "video": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "max_duration": { "type": "integer" }, "max_fps": { "type": "integer" }, "max_frames": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "speed_modes": { "items": { "type": "string" }, "type": "array" }, "supports_seed": { "type": "boolean" } }, "type": "object" } }, "required": [ "default_max_tokens" ], "type": "object" }, "policy": { "properties": { "allowed": { "type": "boolean" }, "blocked_by": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "allowed" ], "type": "object" }, "pooled": { "type": "boolean" }, "pricing": { "properties": { "audio_cached_input": { "items": { "type": "number" }, "type": "array" }, "audio_input": { "items": { "type": "number" }, "type": "array" }, "audio_input_per_minute": { "type": "number" }, "audio_output": { "items": { "type": "number" }, "type": "array" }, "audio_output_per_minute": { "type": "number" }, "billing_unit": { "type": "string" }, "cache_creation": { "items": { "type": "number" }, "type": "array" }, "cache_creation_1h": { "items": { "type": "number" }, "type": "array" }, "cached_input": { "items": { "type": "number" }, "type": "array" }, "free_reference_images": { "type": "integer" }, "google_search_price_per_prompt": { "type": "number" }, "google_search_price_per_query": { "type": "number" }, "image_cached_input": { "items": { "type": "number" }, "type": "array" }, "image_input": { "items": { "type": "number" }, "type": "array" }, "image_output": { "items": { "type": "number" }, "type": "array" }, "image_prices": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "type": "object" }, "input": { "items": { "type": "number" }, "type": "array" }, "input_surcharge_multiplier": { "type": "number" }, "input_surcharge_threshold_tokens": { "type": "integer" }, "input_transcription_per_minute": { "additionalProperties": { "type": "number" }, "type": "object" }, "openai_code_interpreter_price_per_session": { "type": "number" }, "openai_file_search_price_per_call": { "type": "number" }, "openai_web_search_price_per_call": { "type": "number" }, "output": { "items": { "type": "number" }, "type": "array" }, "output_surcharge_multiplier": { "type": "number" }, "price_first_megapixel": { "type": "number" }, "price_per_extra_reference_image": { "type": "number" }, "price_per_generation": { "type": "number" }, "price_per_m_chars": { "type": "number" }, "price_per_megapixel": { "type": "number" }, "price_per_minute": { "type": "number" }, "price_per_page": { "type": "number" }, "price_per_second": { "type": "number" }, "price_per_second_audio": { "type": "number" }, "price_per_second_by_resolution": { "additionalProperties": { "type": "number" }, "type": "object" }, "price_per_second_voice": { "type": "number" }, "price_vector_style": { "type": "number" }, "rates": { "items": { "properties": { "amount": { "type": "number" }, "dimensions": { "additionalProperties": { "type": "string" }, "type": "object" }, "unit": { "type": "string" } }, "required": [ "unit", "amount" ], "type": "object" }, "type": "array" }, "reasoning": { "items": { "type": "number" }, "type": "array" }, "reported_cost_markup": { "type": "number" }, "thresholds": { "items": { "type": "integer" }, "type": "array" }, "web_fetch_price_per_request": { "type": "number" }, "web_search_price_per_request": { "type": "number" }, "xai_x_search_price_per_call": { "type": "number" } }, "type": "object" }, "provider": { "properties": { "display_name": { "type": "string" }, "owner_country": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "display_name" ], "type": "object" }, "quality": { "type": "string" }, "region": { "type": "string" }, "retired_at": { "format": "date-time", "type": "string" }, "route": { "properties": { "access": { "type": "string" }, "country": { "type": "string" }, "data_handling": { "properties": { "caching": { "properties": { "default": { "type": "string" }, "scope": { "type": "string" }, "storage_location": { "type": "string" }, "ttl_seconds": { "type": "integer" } }, "required": [ "default" ], "type": "object" }, "logging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "moderation": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "residency_enforced": { "type": "boolean" }, "subprocessors_read_content": { "type": "boolean" }, "training": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" } }, "required": [ "training", "logging", "moderation", "caching" ], "type": "object" }, "gdpr": { "properties": { "dpa_available": { "type": "boolean" }, "residency": { "type": "string" }, "transfer_mechanism": { "type": "string" } }, "required": [ "residency", "transfer_mechanism" ], "type": "object" }, "id": { "type": "string" }, "inference_location": { "type": "string" }, "last_verified_at": { "type": "string" }, "native_region": { "type": "string" }, "provider": { "type": "string" }, "provider_display_name": { "type": "string" }, "region": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" }, "underlying_maker": { "type": "string" }, "verification": { "properties": { "attested_at": { "type": "string" }, "opper_verified_at": { "type": "string" }, "status": { "type": "string" }, "verified_by": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "id", "provider", "provider_display_name", "region", "native_region", "country", "data_handling", "gdpr" ], "type": "object" }, "server_tools": { "additionalProperties": { "type": "string" }, "type": "object" }, "service_route": { "properties": { "adapter": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "adapter" ], "type": "object" }, "speed": { "type": "string" }, "successor": { "type": "string" }, "thinking": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "id", "type", "provider", "name", "model_id", "capabilities", "speed", "quality", "context_window", "description", "service_route" ], "type": "object" }, "ModelResolveRequest": { "properties": { "messages": { "items": { "properties": { "cache_control": { "type": "object" }, "content": { "description": "Any value" }, "name": { "type": "string" }, "role": { "type": "string" }, "tool_call_id": { "type": "string" }, "tool_calls": { "items": { "properties": { "arguments": { "type": "object" }, "id": { "type": "string" }, "name": { "type": "string" }, "thought_signature": { "type": "string" } }, "required": [ "id", "name", "arguments" ], "type": "object" }, "type": "array" } }, "required": [ "role", "content" ], "type": "object" }, "type": "array" }, "overrides": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "messages" ], "type": "object" }, "ModelResolveResponse": { "properties": { "category": { "type": "string" }, "model": { "properties": { "access": { "type": "string" }, "aliases": { "items": { "type": "string" }, "type": "array" }, "api_type": { "type": "string" }, "benchmarks": { "properties": { "aa_slug": { "type": "string" }, "as_of": { "type": "string" }, "coding_index": { "type": "number" }, "evaluations": { "properties": { "aime": { "type": "number" }, "aime_25": { "type": "number" }, "gpqa": { "type": "number" }, "hle": { "type": "number" }, "ifbench": { "type": "number" }, "lcr": { "type": "number" }, "livecodebench": { "type": "number" }, "math_500": { "type": "number" }, "mmlu_pro": { "type": "number" }, "scicode": { "type": "number" }, "tau2": { "type": "number" }, "terminalbench_hard": { "type": "number" } }, "type": "object" }, "intelligence_index": { "type": "number" }, "math_index": { "type": "number" }, "source": { "type": "string" } }, "required": [ "source", "as_of" ], "type": "object" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "compliance": { "properties": { "cache_scope": { "type": "string" }, "cache_ttl_seconds": { "type": "integer" }, "caching": { "type": "string" }, "content_storage": { "type": "string" }, "country": { "type": "string" }, "dpa_available": { "type": "boolean" }, "inference_location": { "type": "string" }, "logging": { "type": "string" }, "moderation": { "type": "string" }, "residency": { "type": "string" }, "retention_days": { "type": "integer" }, "route_id": { "type": "string" }, "storage_location": { "type": "string" }, "third_party_access": { "type": "boolean" }, "training": { "type": "string" }, "transfer_mechanism": { "type": "string" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "dpa_available", "third_party_access" ], "type": "object" }, "context_window": { "type": "integer" }, "cost": { "type": "number" }, "country": { "type": "string" }, "description": { "type": "string" }, "family": { "type": "string" }, "featured": { "type": "boolean" }, "id": { "type": "string" }, "maker": { "properties": { "country": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug" ], "type": "object" }, "maker_country": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "model": { "type": "string" }, "model_id": { "type": "string" }, "name": { "type": "string" }, "params": { "properties": { "default_max_tokens": { "type": "integer" }, "embedding": { "properties": { "dimensions": { "type": "integer" }, "max_input_tokens": { "type": "integer" }, "supports_dimensions": { "type": "boolean" } }, "required": [ "dimensions" ], "type": "object" }, "image": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "qualities": { "items": { "type": "string" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "size_constraints": { "properties": { "max_edge": { "type": "integer" }, "max_pixels": { "type": "integer" }, "max_ratio": { "type": "integer" }, "min_edge": { "type": "integer" }, "min_pixels": { "type": "integer" }, "multiple_of": { "type": "integer" } }, "type": "object" }, "sizes": { "items": { "type": "string" }, "type": "array" }, "styles": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "image_edit": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" } }, "type": "object" }, "max_tokens": { "type": "boolean" }, "realtime": { "properties": { "default_voice": { "type": "string" }, "input_audio_format": { "type": "string" }, "input_sample_rate": { "type": "integer" }, "output_audio_format": { "type": "string" }, "output_sample_rate": { "type": "integer" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "sample_rate": { "type": "integer" }, "supports_tools": { "type": "boolean" }, "supports_vad": { "type": "boolean" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "stt": { "properties": { "default_language": { "type": "string" }, "diarize": { "type": "boolean" }, "formats": { "items": { "type": "string" }, "type": "array" }, "languages": { "items": { "type": "string" }, "type": "array" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "stream": { "type": "boolean" } }, "type": "object" }, "temperature": { "properties": { "default": { "type": "number" }, "max": { "type": "number" }, "min": { "type": "number" } }, "required": [ "min", "max", "default" ], "type": "object" }, "tts": { "properties": { "default_voice": { "type": "string" }, "formats": { "items": { "type": "string" }, "type": "array" }, "max_length": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "video": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "max_duration": { "type": "integer" }, "max_fps": { "type": "integer" }, "max_frames": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "speed_modes": { "items": { "type": "string" }, "type": "array" }, "supports_seed": { "type": "boolean" } }, "type": "object" } }, "required": [ "default_max_tokens" ], "type": "object" }, "policy": { "properties": { "allowed": { "type": "boolean" }, "blocked_by": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "allowed" ], "type": "object" }, "pooled": { "type": "boolean" }, "pricing": { "properties": { "audio_cached_input": { "items": { "type": "number" }, "type": "array" }, "audio_input": { "items": { "type": "number" }, "type": "array" }, "audio_input_per_minute": { "type": "number" }, "audio_output": { "items": { "type": "number" }, "type": "array" }, "audio_output_per_minute": { "type": "number" }, "billing_unit": { "type": "string" }, "cache_creation": { "items": { "type": "number" }, "type": "array" }, "cache_creation_1h": { "items": { "type": "number" }, "type": "array" }, "cached_input": { "items": { "type": "number" }, "type": "array" }, "free_reference_images": { "type": "integer" }, "google_search_price_per_prompt": { "type": "number" }, "google_search_price_per_query": { "type": "number" }, "image_cached_input": { "items": { "type": "number" }, "type": "array" }, "image_input": { "items": { "type": "number" }, "type": "array" }, "image_output": { "items": { "type": "number" }, "type": "array" }, "image_prices": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "type": "object" }, "input": { "items": { "type": "number" }, "type": "array" }, "input_surcharge_multiplier": { "type": "number" }, "input_surcharge_threshold_tokens": { "type": "integer" }, "input_transcription_per_minute": { "additionalProperties": { "type": "number" }, "type": "object" }, "openai_code_interpreter_price_per_session": { "type": "number" }, "openai_file_search_price_per_call": { "type": "number" }, "openai_web_search_price_per_call": { "type": "number" }, "output": { "items": { "type": "number" }, "type": "array" }, "output_surcharge_multiplier": { "type": "number" }, "price_first_megapixel": { "type": "number" }, "price_per_extra_reference_image": { "type": "number" }, "price_per_generation": { "type": "number" }, "price_per_m_chars": { "type": "number" }, "price_per_megapixel": { "type": "number" }, "price_per_minute": { "type": "number" }, "price_per_page": { "type": "number" }, "price_per_second": { "type": "number" }, "price_per_second_audio": { "type": "number" }, "price_per_second_by_resolution": { "additionalProperties": { "type": "number" }, "type": "object" }, "price_per_second_voice": { "type": "number" }, "price_vector_style": { "type": "number" }, "rates": { "items": { "properties": { "amount": { "type": "number" }, "dimensions": { "additionalProperties": { "type": "string" }, "type": "object" }, "unit": { "type": "string" } }, "required": [ "unit", "amount" ], "type": "object" }, "type": "array" }, "reasoning": { "items": { "type": "number" }, "type": "array" }, "reported_cost_markup": { "type": "number" }, "thresholds": { "items": { "type": "integer" }, "type": "array" }, "web_fetch_price_per_request": { "type": "number" }, "web_search_price_per_request": { "type": "number" }, "xai_x_search_price_per_call": { "type": "number" } }, "type": "object" }, "provider": { "properties": { "display_name": { "type": "string" }, "owner_country": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "display_name" ], "type": "object" }, "provider_display_name": { "type": "string" }, "quality": { "type": "string" }, "region": { "type": "string" }, "retired_at": { "format": "date-time", "type": "string" }, "route": { "properties": { "access": { "type": "string" }, "country": { "type": "string" }, "data_handling": { "properties": { "caching": { "properties": { "default": { "type": "string" }, "scope": { "type": "string" }, "storage_location": { "type": "string" }, "ttl_seconds": { "type": "integer" } }, "required": [ "default" ], "type": "object" }, "logging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "moderation": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "residency_enforced": { "type": "boolean" }, "subprocessors_read_content": { "type": "boolean" }, "training": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" } }, "required": [ "training", "logging", "moderation", "caching" ], "type": "object" }, "gdpr": { "properties": { "dpa_available": { "type": "boolean" }, "residency": { "type": "string" }, "transfer_mechanism": { "type": "string" } }, "required": [ "residency", "transfer_mechanism" ], "type": "object" }, "id": { "type": "string" }, "inference_location": { "type": "string" }, "last_verified_at": { "type": "string" }, "native_region": { "type": "string" }, "provider": { "type": "string" }, "provider_display_name": { "type": "string" }, "region": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" }, "underlying_maker": { "type": "string" }, "verification": { "properties": { "attested_at": { "type": "string" }, "opper_verified_at": { "type": "string" }, "status": { "type": "string" }, "verified_by": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "id", "provider", "provider_display_name", "region", "native_region", "country", "data_handling", "gdpr" ], "type": "object" }, "server_tools": { "additionalProperties": { "type": "string" }, "type": "object" }, "service_route": { "properties": { "adapter": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "adapter" ], "type": "object" }, "speed": { "type": "string" }, "successor": { "type": "string" }, "thinking": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "id", "type", "provider", "provider_display_name", "name", "model_id", "capabilities", "speed", "quality", "context_window", "description", "service_route" ], "type": "object" }, "model_id": { "type": "string" }, "reasoning": { "type": "string" } }, "required": [ "model", "model_id", "category", "reasoning" ], "type": "object" }, "ModelsResponse": { "properties": { "limit": { "type": "integer" }, "models": { "items": { "properties": { "access": { "type": "string" }, "aliases": { "items": { "type": "string" }, "type": "array" }, "api_type": { "type": "string" }, "benchmarks": { "properties": { "aa_slug": { "type": "string" }, "as_of": { "type": "string" }, "coding_index": { "type": "number" }, "evaluations": { "properties": { "aime": { "type": "number" }, "aime_25": { "type": "number" }, "gpqa": { "type": "number" }, "hle": { "type": "number" }, "ifbench": { "type": "number" }, "lcr": { "type": "number" }, "livecodebench": { "type": "number" }, "math_500": { "type": "number" }, "mmlu_pro": { "type": "number" }, "scicode": { "type": "number" }, "tau2": { "type": "number" }, "terminalbench_hard": { "type": "number" } }, "type": "object" }, "intelligence_index": { "type": "number" }, "math_index": { "type": "number" }, "source": { "type": "string" } }, "required": [ "source", "as_of" ], "type": "object" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "compliance": { "properties": { "cache_scope": { "type": "string" }, "cache_ttl_seconds": { "type": "integer" }, "caching": { "type": "string" }, "content_storage": { "type": "string" }, "country": { "type": "string" }, "dpa_available": { "type": "boolean" }, "inference_location": { "type": "string" }, "logging": { "type": "string" }, "moderation": { "type": "string" }, "residency": { "type": "string" }, "retention_days": { "type": "integer" }, "route_id": { "type": "string" }, "storage_location": { "type": "string" }, "third_party_access": { "type": "boolean" }, "training": { "type": "string" }, "transfer_mechanism": { "type": "string" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "dpa_available", "third_party_access" ], "type": "object" }, "context_window": { "type": "integer" }, "cost": { "type": "number" }, "country": { "type": "string" }, "description": { "type": "string" }, "family": { "type": "string" }, "featured": { "type": "boolean" }, "id": { "type": "string" }, "maker": { "properties": { "country": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug" ], "type": "object" }, "maker_country": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "model": { "type": "string" }, "model_id": { "type": "string" }, "name": { "type": "string" }, "params": { "properties": { "default_max_tokens": { "type": "integer" }, "embedding": { "properties": { "dimensions": { "type": "integer" }, "max_input_tokens": { "type": "integer" }, "supports_dimensions": { "type": "boolean" } }, "required": [ "dimensions" ], "type": "object" }, "image": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "qualities": { "items": { "type": "string" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "size_constraints": { "properties": { "max_edge": { "type": "integer" }, "max_pixels": { "type": "integer" }, "max_ratio": { "type": "integer" }, "min_edge": { "type": "integer" }, "min_pixels": { "type": "integer" }, "multiple_of": { "type": "integer" } }, "type": "object" }, "sizes": { "items": { "type": "string" }, "type": "array" }, "styles": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "image_edit": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "default": { "type": "string" } }, "type": "object" }, "max_tokens": { "type": "boolean" }, "realtime": { "properties": { "default_voice": { "type": "string" }, "input_audio_format": { "type": "string" }, "input_sample_rate": { "type": "integer" }, "output_audio_format": { "type": "string" }, "output_sample_rate": { "type": "integer" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "sample_rate": { "type": "integer" }, "supports_tools": { "type": "boolean" }, "supports_vad": { "type": "boolean" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "reasoning": { "properties": { "default": { "type": "string" }, "max_budget": { "type": "integer" }, "mode": { "type": "string" }, "supported": { "items": { "type": "string" }, "type": "array" }, "wire": { "type": "string" } }, "required": [ "supported", "default" ], "type": "object" }, "stt": { "properties": { "default_language": { "type": "string" }, "diarize": { "type": "boolean" }, "formats": { "items": { "type": "string" }, "type": "array" }, "languages": { "items": { "type": "string" }, "type": "array" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "stream": { "type": "boolean" } }, "type": "object" }, "temperature": { "properties": { "default": { "type": "number" }, "max": { "type": "number" }, "min": { "type": "number" } }, "required": [ "min", "max", "default" ], "type": "object" }, "tts": { "properties": { "default_voice": { "type": "string" }, "formats": { "items": { "type": "string" }, "type": "array" }, "max_length": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "voices": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "video": { "properties": { "aspect_ratios": { "items": { "type": "string" }, "type": "array" }, "max_duration": { "type": "integer" }, "max_fps": { "type": "integer" }, "max_frames": { "type": "integer" }, "parameters": { "items": { "properties": { "description": { "type": "string" }, "enum": { "items": { "type": "string" }, "type": "array" }, "example": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "resolutions": { "items": { "type": "string" }, "type": "array" }, "speed_modes": { "items": { "type": "string" }, "type": "array" }, "supports_seed": { "type": "boolean" } }, "type": "object" } }, "required": [ "default_max_tokens" ], "type": "object" }, "policy": { "properties": { "allowed": { "type": "boolean" }, "blocked_by": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "allowed" ], "type": "object" }, "pooled": { "type": "boolean" }, "pricing": { "properties": { "audio_cached_input": { "items": { "type": "number" }, "type": "array" }, "audio_input": { "items": { "type": "number" }, "type": "array" }, "audio_input_per_minute": { "type": "number" }, "audio_output": { "items": { "type": "number" }, "type": "array" }, "audio_output_per_minute": { "type": "number" }, "billing_unit": { "type": "string" }, "cache_creation": { "items": { "type": "number" }, "type": "array" }, "cache_creation_1h": { "items": { "type": "number" }, "type": "array" }, "cached_input": { "items": { "type": "number" }, "type": "array" }, "free_reference_images": { "type": "integer" }, "google_search_price_per_prompt": { "type": "number" }, "google_search_price_per_query": { "type": "number" }, "image_cached_input": { "items": { "type": "number" }, "type": "array" }, "image_input": { "items": { "type": "number" }, "type": "array" }, "image_output": { "items": { "type": "number" }, "type": "array" }, "image_prices": { "additionalProperties": { "additionalProperties": { "type": "number" }, "type": "object" }, "type": "object" }, "input": { "items": { "type": "number" }, "type": "array" }, "input_surcharge_multiplier": { "type": "number" }, "input_surcharge_threshold_tokens": { "type": "integer" }, "input_transcription_per_minute": { "additionalProperties": { "type": "number" }, "type": "object" }, "openai_code_interpreter_price_per_session": { "type": "number" }, "openai_file_search_price_per_call": { "type": "number" }, "openai_web_search_price_per_call": { "type": "number" }, "output": { "items": { "type": "number" }, "type": "array" }, "output_surcharge_multiplier": { "type": "number" }, "price_first_megapixel": { "type": "number" }, "price_per_extra_reference_image": { "type": "number" }, "price_per_generation": { "type": "number" }, "price_per_m_chars": { "type": "number" }, "price_per_megapixel": { "type": "number" }, "price_per_minute": { "type": "number" }, "price_per_page": { "type": "number" }, "price_per_second": { "type": "number" }, "price_per_second_audio": { "type": "number" }, "price_per_second_by_resolution": { "additionalProperties": { "type": "number" }, "type": "object" }, "price_per_second_voice": { "type": "number" }, "price_vector_style": { "type": "number" }, "rates": { "items": { "properties": { "amount": { "type": "number" }, "dimensions": { "additionalProperties": { "type": "string" }, "type": "object" }, "unit": { "type": "string" } }, "required": [ "unit", "amount" ], "type": "object" }, "type": "array" }, "reasoning": { "items": { "type": "number" }, "type": "array" }, "reported_cost_markup": { "type": "number" }, "thresholds": { "items": { "type": "integer" }, "type": "array" }, "web_fetch_price_per_request": { "type": "number" }, "web_search_price_per_request": { "type": "number" }, "xai_x_search_price_per_call": { "type": "number" } }, "type": "object" }, "provider": { "properties": { "display_name": { "type": "string" }, "owner_country": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "display_name" ], "type": "object" }, "provider_display_name": { "type": "string" }, "quality": { "type": "string" }, "region": { "type": "string" }, "retired_at": { "format": "date-time", "type": "string" }, "route": { "properties": { "access": { "type": "string" }, "country": { "type": "string" }, "data_handling": { "properties": { "caching": { "properties": { "default": { "type": "string" }, "scope": { "type": "string" }, "storage_location": { "type": "string" }, "ttl_seconds": { "type": "integer" } }, "required": [ "default" ], "type": "object" }, "logging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "moderation": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "residency_enforced": { "type": "boolean" }, "subprocessors_read_content": { "type": "boolean" }, "training": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" } }, "required": [ "training", "logging", "moderation", "caching" ], "type": "object" }, "gdpr": { "properties": { "dpa_available": { "type": "boolean" }, "residency": { "type": "string" }, "transfer_mechanism": { "type": "string" } }, "required": [ "residency", "transfer_mechanism" ], "type": "object" }, "id": { "type": "string" }, "inference_location": { "type": "string" }, "last_verified_at": { "type": "string" }, "native_region": { "type": "string" }, "provider": { "type": "string" }, "provider_display_name": { "type": "string" }, "region": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" }, "underlying_maker": { "type": "string" }, "verification": { "properties": { "attested_at": { "type": "string" }, "opper_verified_at": { "type": "string" }, "status": { "type": "string" }, "verified_by": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "id", "provider", "provider_display_name", "region", "native_region", "country", "data_handling", "gdpr" ], "type": "object" }, "server_tools": { "additionalProperties": { "type": "string" }, "type": "object" }, "service_route": { "properties": { "adapter": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "adapter" ], "type": "object" }, "speed": { "type": "string" }, "successor": { "type": "string" }, "thinking": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "id", "type", "provider", "provider_display_name", "name", "model_id", "capabilities", "speed", "quality", "context_window", "description", "service_route" ], "type": "object" }, "type": "array" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "models", "total", "offset", "limit" ], "type": "object" }, "OCRDocument": { "properties": { "content": { "type": "string" }, "document_name": { "type": "string" }, "document_url": { "type": "string" }, "file_id": { "type": "string" }, "image_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "OCRPage": { "properties": { "blocks": { "items": { "properties": { "bottom_right_x": { "type": "integer" }, "bottom_right_y": { "type": "integer" }, "content": { "type": "string" }, "top_left_x": { "type": "integer" }, "top_left_y": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "type", "top_left_x", "top_left_y", "bottom_right_x", "bottom_right_y" ], "type": "object" }, "type": "array" }, "confidence_scores": { "type": "object" }, "dimensions": { "additionalProperties": { "type": "integer" }, "type": "object" }, "elements": { "items": { "type": "object" }, "type": "array" }, "images": { "items": { "type": "object" }, "type": "array" }, "index": { "type": "integer" }, "markdown": { "type": "string" } }, "required": [ "index", "markdown" ], "type": "object" }, "OCRRequest": { "properties": { "document": { "properties": { "content": { "type": "string" }, "document_name": { "type": "string" }, "document_url": { "type": "string" }, "file_id": { "type": "string" }, "image_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "image_limit": { "type": "integer" }, "image_min_size": { "type": "integer" }, "include_image_base64": { "type": "boolean" }, "model": { "type": "string" }, "pages": { "items": { "type": "integer" }, "type": "array" }, "parameters": { "type": "object" } }, "required": [ "model", "document" ], "type": "object" }, "OCRResponse": { "properties": { "id": { "type": "string" }, "model": { "type": "string" }, "pages": { "items": { "properties": { "blocks": { "items": { "properties": { "bottom_right_x": { "type": "integer" }, "bottom_right_y": { "type": "integer" }, "content": { "type": "string" }, "top_left_x": { "type": "integer" }, "top_left_y": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "type", "top_left_x", "top_left_y", "bottom_right_x", "bottom_right_y" ], "type": "object" }, "type": "array" }, "confidence_scores": { "type": "object" }, "dimensions": { "additionalProperties": { "type": "integer" }, "type": "object" }, "elements": { "items": { "type": "object" }, "type": "array" }, "images": { "items": { "type": "object" }, "type": "array" }, "index": { "type": "integer" }, "markdown": { "type": "string" } }, "required": [ "index", "markdown" ], "type": "object" }, "type": "array" }, "usage": { "properties": { "cost": { "type": "number" }, "pages_processed": { "type": "integer" } }, "required": [ "cost", "pages_processed" ], "type": "object" } }, "required": [ "id", "model", "pages", "usage" ], "type": "object" }, "OCRUsage": { "properties": { "cost": { "type": "number" }, "pages_processed": { "type": "integer" } }, "required": [ "cost", "pages_processed" ], "type": "object" }, "ORError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "ORInputTokensDetails": { "properties": { "cached_tokens": { "type": "integer" } }, "required": [ "cached_tokens" ], "type": "object" }, "OROutputContent": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "OROutputItem": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "OROutputTokensDetails": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "ORReasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "ORRequest": { "properties": { "cache_control": { "description": "Opt in to automatic prompt caching for Anthropic-family models: {\"type\":\"ephemeral\"} (optionally \"ttl\":\"1h\"). Places one moving cache breakpoint on the largest cacheable prefix. Caching is off unless set; no-op on providers with automatic server-side caching (OpenAI", "type": "object" }, "frequency_penalty": { "type": "number" }, "include": { "items": { "type": "string" }, "type": "array" }, "input": { "properties": { "Items": { "items": { "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "Text": { "type": "string" } }, "required": [ "Text", "Items" ], "type": "object" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "max_tool_calls": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "store": { "type": "boolean" }, "stream": { "type": "boolean" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "strict": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" } }, "type": "object" }, "ORResponse": { "properties": { "completed_at": { "type": "integer" }, "created_at": { "type": "integer" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "frequency_penalty": { "type": "number" }, "id": { "type": "string" }, "incomplete_details": { "description": "Any value" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "output": { "items": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "status": { "type": "string" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "strict": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" }, "usage": { "properties": { "cost": { "description": "Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header.", "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "required": [ "cached_tokens" ], "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" } }, "required": [ "id", "object", "created_at", "completed_at", "status", "model", "output", "error", "incomplete_details", "tool_choice" ], "type": "object" }, "ORStreamEventCompleted": { "properties": { "response": { "properties": { "completed_at": { "type": "integer" }, "created_at": { "type": "integer" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "frequency_penalty": { "type": "number" }, "id": { "type": "string" }, "incomplete_details": { "description": "Any value" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "output": { "items": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "status": { "type": "string" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "strict": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" }, "usage": { "properties": { "cost": { "description": "Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header.", "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "required": [ "cached_tokens" ], "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" } }, "required": [ "id", "object", "created_at", "completed_at", "status", "model", "output", "error", "incomplete_details", "tool_choice" ], "type": "object" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.completed" ], "type": "string" } }, "required": [ "type", "sequence_number", "response" ], "title": "response.completed", "type": "object" }, "ORStreamEventContentPartAdded": { "properties": { "content_index": { "type": "integer" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "part": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.content_part.added" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "content_index", "part" ], "title": "response.content_part.added", "type": "object" }, "ORStreamEventContentPartDone": { "properties": { "content_index": { "type": "integer" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "part": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.content_part.done" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "content_index", "part" ], "title": "response.content_part.done", "type": "object" }, "ORStreamEventError": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "error" ], "type": "string" } }, "required": [ "type", "sequence_number", "error" ], "title": "error", "type": "object" }, "ORStreamEventFunctionCallArgumentsDelta": { "properties": { "delta": { "type": "string" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.function_call_arguments.delta" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "delta" ], "title": "response.function_call_arguments.delta", "type": "object" }, "ORStreamEventFunctionCallArgumentsDone": { "properties": { "arguments": { "type": "string" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.function_call_arguments.done" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "arguments" ], "title": "response.function_call_arguments.done", "type": "object" }, "ORStreamEventOutputItemAdded": { "properties": { "item": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.output_item.added" ], "type": "string" } }, "required": [ "type", "sequence_number", "output_index", "item" ], "title": "response.output_item.added", "type": "object" }, "ORStreamEventOutputItemDone": { "properties": { "item": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.output_item.done" ], "type": "string" } }, "required": [ "type", "sequence_number", "output_index", "item" ], "title": "response.output_item.done", "type": "object" }, "ORStreamEventOutputTextDelta": { "properties": { "content_index": { "type": "integer" }, "delta": { "type": "string" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.output_text.delta" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "content_index", "delta" ], "title": "response.output_text.delta", "type": "object" }, "ORStreamEventOutputTextDone": { "properties": { "content_index": { "type": "integer" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "text": { "type": "string" }, "type": { "enum": [ "response.output_text.done" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "content_index", "text" ], "title": "response.output_text.done", "type": "object" }, "ORStreamEventReasoningSummaryDelta": { "properties": { "delta": { "type": "string" }, "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "summary_index": { "type": "integer" }, "type": { "enum": [ "response.reasoning_summary_text.delta" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "summary_index", "delta" ], "title": "response.reasoning_summary_text.delta", "type": "object" }, "ORStreamEventReasoningSummaryDone": { "properties": { "item_id": { "type": "string" }, "output_index": { "type": "integer" }, "sequence_number": { "type": "integer" }, "summary_index": { "type": "integer" }, "text": { "type": "string" }, "type": { "enum": [ "response.reasoning_summary_text.done" ], "type": "string" } }, "required": [ "type", "sequence_number", "item_id", "output_index", "summary_index", "text" ], "title": "response.reasoning_summary_text.done", "type": "object" }, "ORStreamEventResponseCreated": { "properties": { "response": { "properties": { "completed_at": { "type": "integer" }, "created_at": { "type": "integer" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "frequency_penalty": { "type": "number" }, "id": { "type": "string" }, "incomplete_details": { "description": "Any value" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "output": { "items": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "status": { "type": "string" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "strict": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" }, "usage": { "properties": { "cost": { "description": "Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header.", "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "required": [ "cached_tokens" ], "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" } }, "required": [ "id", "object", "created_at", "completed_at", "status", "model", "output", "error", "incomplete_details", "tool_choice" ], "type": "object" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.created" ], "type": "string" } }, "required": [ "type", "sequence_number", "response" ], "title": "response.created", "type": "object" }, "ORStreamEventResponseInProgress": { "properties": { "response": { "properties": { "completed_at": { "type": "integer" }, "created_at": { "type": "integer" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "frequency_penalty": { "type": "number" }, "id": { "type": "string" }, "incomplete_details": { "description": "Any value" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "output": { "items": { "properties": { "action": { "type": "string" }, "arguments": { "type": "string" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "refusal": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "cost_usd": { "type": "number" }, "encrypted_content": { "type": "string" }, "execution_ms": { "type": "integer" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "guard_type": { "type": "string" }, "id": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "status": { "type": "string" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "strict": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" }, "usage": { "properties": { "cost": { "description": "Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header.", "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "required": [ "cached_tokens" ], "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" } }, "required": [ "id", "object", "created_at", "completed_at", "status", "model", "output", "error", "incomplete_details", "tool_choice" ], "type": "object" }, "sequence_number": { "type": "integer" }, "type": { "enum": [ "response.in_progress" ], "type": "string" } }, "required": [ "type", "sequence_number", "response" ], "title": "response.in_progress", "type": "object" }, "ORSummaryText": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "ORTextConfig": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "ORTextFormat": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "ORToolDef": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "strict": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "ORUsage": { "properties": { "cost": { "description": "Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header.", "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "required": [ "cached_tokens" ], "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "required": [ "reasoning_tokens" ], "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" }, "OpenAICompatModel": { "properties": { "context_length": { "type": "integer" }, "created": { "type": "integer" }, "id": { "type": "string" }, "object": { "type": "string" }, "opper": { "properties": { "capabilities": { "items": { "type": "string" }, "type": "array" }, "country": { "type": "string" }, "description": { "type": "string" }, "gdpr_residency": { "type": "string" }, "kind": { "type": "string" }, "maker": { "type": "string" }, "maker_country": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "members": { "items": { "type": "string" }, "type": "array" }, "region": { "type": "string" }, "type": { "type": "string" }, "verification": { "type": "string" }, "version": { "type": "integer" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "kind" ], "type": "object" }, "owned_by": { "type": "string" }, "pricing": { "properties": { "completion": { "type": "string" }, "input_cache_read": { "type": "string" }, "input_cache_write": { "type": "string" }, "input_cache_write_1h": { "type": "string" }, "internal_reasoning": { "type": "string" }, "prompt": { "type": "string" }, "web_search": { "type": "string" } }, "required": [ "prompt", "completion" ], "type": "object" } }, "required": [ "id", "object", "created", "owned_by" ], "type": "object" }, "OpenAICompatModelsListResponse": { "properties": { "data": { "items": { "properties": { "context_length": { "type": "integer" }, "created": { "type": "integer" }, "id": { "type": "string" }, "object": { "type": "string" }, "opper": { "properties": { "capabilities": { "items": { "type": "string" }, "type": "array" }, "country": { "type": "string" }, "description": { "type": "string" }, "gdpr_residency": { "type": "string" }, "kind": { "type": "string" }, "maker": { "type": "string" }, "maker_country": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "members": { "items": { "type": "string" }, "type": "array" }, "region": { "type": "string" }, "type": { "type": "string" }, "verification": { "type": "string" }, "version": { "type": "integer" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "kind" ], "type": "object" }, "owned_by": { "type": "string" }, "pricing": { "properties": { "completion": { "type": "string" }, "input_cache_read": { "type": "string" }, "input_cache_write": { "type": "string" }, "input_cache_write_1h": { "type": "string" }, "internal_reasoning": { "type": "string" }, "prompt": { "type": "string" }, "web_search": { "type": "string" } }, "required": [ "prompt", "completion" ], "type": "object" } }, "required": [ "id", "object", "created", "owned_by" ], "type": "object" }, "type": "array" }, "object": { "type": "string" } }, "required": [ "object", "data" ], "type": "object" }, "PendingOperation": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "status_url", "type" ], "type": "object" }, "PendingResponse": { "properties": { "data": { "description": "Any value" }, "meta": { "properties": { "execution_ms": { "type": "integer" }, "function_name": { "type": "string" }, "pending_operations": { "items": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "status_url", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "pending" ], "type": "string" } }, "required": [ "function_name", "status", "execution_ms", "pending_operations" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "PendingResponseMeta": { "properties": { "execution_ms": { "type": "integer" }, "function_name": { "type": "string" }, "pending_operations": { "items": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "status_url", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "pending" ], "type": "string" } }, "required": [ "function_name", "status", "execution_ms", "pending_operations" ], "type": "object" }, "ProviderInfo": { "properties": { "description": { "type": "string" }, "display_name": { "type": "string" }, "logo": { "properties": { "dark": { "type": "string" }, "light": { "type": "string" } }, "type": "object" }, "model_count": { "type": "integer" }, "owner_country": { "type": "string" }, "previous_slugs": { "items": { "type": "string" }, "type": "array" }, "regions": { "items": { "type": "string" }, "type": "array" }, "service_routes": { "items": { "properties": { "access": { "type": "string" }, "country": { "type": "string" }, "data_handling": { "properties": { "caching": { "properties": { "default": { "type": "string" }, "scope": { "type": "string" }, "storage_location": { "type": "string" }, "ttl_seconds": { "type": "integer" } }, "required": [ "default" ], "type": "object" }, "logging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "moderation": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "residency_enforced": { "type": "boolean" }, "subprocessors_read_content": { "type": "boolean" }, "training": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" } }, "required": [ "training", "logging", "moderation", "caching" ], "type": "object" }, "gdpr": { "properties": { "dpa_available": { "type": "boolean" }, "residency": { "type": "string" }, "transfer_mechanism": { "type": "string" } }, "required": [ "residency", "transfer_mechanism" ], "type": "object" }, "id": { "type": "string" }, "inference_location": { "type": "string" }, "last_verified_at": { "type": "string" }, "native_region": { "type": "string" }, "provider": { "type": "string" }, "provider_display_name": { "type": "string" }, "region": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" }, "underlying_maker": { "type": "string" }, "verification": { "properties": { "attested_at": { "type": "string" }, "opper_verified_at": { "type": "string" }, "status": { "type": "string" }, "verified_by": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "zdr": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "slug": { "type": "string" }, "status": { "type": "string" }, "tagline": { "type": "string" }, "website": { "type": "string" } }, "required": [ "slug", "previous_slugs", "display_name", "status", "regions", "service_routes", "model_count" ], "type": "object" }, "PublicUnavailableModel": { "properties": { "availability": { "type": "string" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "context_window": { "type": "integer" }, "description": { "type": "string" }, "featured": { "type": "boolean" }, "maker": { "properties": { "country": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "display_name" ], "type": "object" }, "max_output_tokens": { "type": "integer" }, "model": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "model", "name", "type", "capabilities", "availability", "maker" ], "type": "object" }, "RealtimeCreateRequest": { "properties": { "instructions": { "type": "string" }, "model": { "type": "string" }, "provider": { "type": "string" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "voice": { "type": "string" } }, "required": [ "instructions" ], "type": "object" }, "RealtimeCreateResponse": { "properties": { "cached": { "type": "boolean" }, "name": { "type": "string" }, "reasoning": { "type": "string" }, "script": { "type": "string" } }, "required": [ "name", "script", "cached" ], "type": "object" }, "RealtimeSessionRequest": { "properties": { "config": { "properties": { "input_audio_format": { "type": "string" }, "input_transcription": { "type": "boolean" }, "input_transcription_model": { "type": "string" }, "instructions": { "type": "string" }, "modalities": { "items": { "type": "string" }, "type": "array" }, "model": { "type": "string" }, "output_audio_format": { "type": "string" }, "output_transcription": { "type": "boolean" }, "reasoning_effort": { "type": "string" }, "temperature": { "type": "number" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "transcription_custom_vocabulary": { "items": { "type": "string" }, "type": "array" }, "transcription_language_codes": { "items": { "type": "string" }, "type": "array" }, "transcription_mode": { "type": "string" }, "translation_echo_target_language": { "type": "boolean" }, "translation_target_language": { "type": "string" }, "turn_detection": { "properties": { "eagerness": { "type": "string" }, "prefix_padding_ms": { "type": "integer" }, "silence_duration_ms": { "type": "integer" }, "threshold": { "type": "number" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "voice": { "type": "string" } }, "type": "object" }, "locked_fields": { "items": { "type": "string" }, "type": "array" }, "ttl_seconds": { "type": "integer" } }, "type": "object" }, "RealtimeSessionResponse": { "properties": { "client_secret": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "ws_url": { "type": "string" } }, "required": [ "client_secret", "expires_at" ], "type": "object" }, "ReasoningConfig": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "ResponseMeta": { "properties": { "cost": { "type": "number" }, "execution_ms": { "type": "integer" }, "function_name": { "type": "string" }, "generation_ms": { "type": "integer" }, "guards": { "items": { "properties": { "code": { "type": "string" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "phase": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope_type": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "flagged" ], "type": "object" }, "type": "array" }, "image_gen_calls": { "type": "integer" }, "llm_calls": { "type": "integer" }, "message": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "pending_operations": { "items": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "status_url", "type" ], "type": "object" }, "type": "array" }, "script_cached": { "type": "boolean" }, "status": { "type": "string" }, "tool_calls": { "items": { "type": "object" }, "type": "array" }, "trace_uuid": { "type": "string" }, "tts_calls": { "type": "integer" }, "usage": { "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" } }, "required": [ "function_name", "script_cached", "execution_ms", "llm_calls", "tts_calls", "image_gen_calls" ], "type": "object" }, "ResponsesError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "ResponsesOutputContent": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "ResponsesOutputItem": { "properties": { "arguments": { "type": "string" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "encrypted_content": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "ResponsesRequest": { "properties": { "cache_control": { "description": "Opt in to automatic prompt caching for Anthropic-family models: {\"type\":\"ephemeral\"} (optionally \"ttl\":\"1h\"). Places one moving cache breakpoint on the largest cacheable prefix. Caching is off unless set; no-op on providers with automatic server-side caching (OpenAI", "type": "object" }, "frequency_penalty": { "type": "number" }, "include": { "items": { "type": "string" }, "type": "array" }, "input": { "properties": { "Items": { "items": { "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "Text": { "type": "string" } }, "required": [ "Text", "Items" ], "type": "object" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "store": { "type": "boolean" }, "stream": { "type": "boolean" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "require_approval": { "type": "string" }, "server_label": { "type": "string" }, "server_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" }, "user": { "type": "string" } }, "type": "object" }, "ResponsesResponse": { "properties": { "completed_at": { "type": "integer" }, "cost": { "type": "number" }, "created_at": { "type": "number" }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "frequency_penalty": { "type": "number" }, "id": { "type": "string" }, "incomplete_details": { "description": "Any value" }, "instructions": { "type": "string" }, "max_output_tokens": { "type": "integer" }, "metadata": { "type": "object" }, "model": { "type": "string" }, "object": { "type": "string" }, "output": { "items": { "properties": { "arguments": { "type": "string" }, "call_id": { "type": "string" }, "content": { "items": { "properties": { "annotations": { "items": { "description": "Any value" }, "type": "array" }, "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "encrypted_content": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "summary": { "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "text" ], "type": "object" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "output_text": { "type": "string" }, "parallel_tool_calls": { "type": "boolean" }, "presence_penalty": { "type": "number" }, "previous_response_id": { "type": "string" }, "reasoning": { "properties": { "effort": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "service_tier": { "type": "string" }, "status": { "type": "string" }, "temperature": { "type": "number" }, "text": { "properties": { "format": { "properties": { "name": { "type": "string" }, "schema": { "type": "object" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } }, "type": "object" }, "tool_choice": { "description": "Any value" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "require_approval": { "type": "string" }, "server_label": { "type": "string" }, "server_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "top_p": { "type": "number" }, "truncation": { "type": "string" }, "usage": { "properties": { "cost": { "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" }, "user": { "type": "string" } }, "required": [ "id", "object", "created_at", "model", "status", "output", "error", "incomplete_details", "tool_choice" ], "type": "object" }, "ResponsesTool": { "properties": { "description": { "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "require_approval": { "type": "string" }, "server_label": { "type": "string" }, "server_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "ResponsesUsage": { "properties": { "cost": { "type": "number" }, "input_tokens": { "type": "integer" }, "input_tokens_details": { "properties": { "cached_tokens": { "type": "integer" } }, "type": "object" }, "output_tokens": { "type": "integer" }, "output_tokens_details": { "properties": { "reasoning_tokens": { "type": "integer" } }, "type": "object" }, "total_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens", "total_tokens" ], "type": "object" }, "RevisionInfo": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "is_current": { "type": "boolean" }, "revision_id": { "type": "integer" }, "schema_hash": { "type": "string" } }, "required": [ "revision_id", "created_at", "schema_hash", "is_current" ], "type": "object" }, "RoundtableModelResult": { "properties": { "cost": { "description": "USD cost for this model call summed across retries.", "type": "number" }, "data": { "description": "Raw model output. When output_schema is supplied this is a JSON string that validated against the schema.", "type": "string" }, "duration_ms": { "description": "Wall-clock time for this model call in milliseconds including retries.", "type": "integer" }, "error": { "description": "Provider or transport error message. Empty on success.", "type": "string" }, "index": { "description": "Position of this model in the request's models array (0-based).", "type": "integer" }, "model": { "description": "Name of the model that produced this result.", "type": "string" }, "schema_error": { "description": "Why the output failed schema validation. Empty when schema_valid is true or absent.", "type": "string" }, "schema_valid": { "description": "Whether the model's output validated against the request's output_schema. Absent when no output_schema was supplied.", "type": "boolean" }, "usage": { "description": "Token counts aggregated across all retry attempts.", "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "code_interpreter_sessions": { "type": "integer" }, "extra": { "type": "object" }, "file_search_calls": { "type": "integer" }, "google_search_prompts": { "type": "integer" }, "google_search_queries": { "type": "integer" }, "image_generation_calls": { "type": "integer" }, "input_audio_tokens": { "type": "integer" }, "input_image_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_audio_tokens": { "type": "integer" }, "output_image_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "url_context_requests": { "type": "integer" }, "web_fetch_requests": { "type": "integer" }, "web_search_calls": { "type": "integer" }, "web_search_requests": { "type": "integer" }, "x_search_calls": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" } }, "required": [ "index", "model", "data", "duration_ms" ], "type": "object" }, "RoundtableModelSpec": { "properties": { "max_tokens": { "description": "Override max output tokens for this model. Falls back to the model's configured default or 8192 when unspecified.", "type": "integer" }, "name": { "description": "Model identifier (e.g. gpt-4o or anthropic/claude-sonnet-4-20250514)", "type": "string" }, "reasoning": { "description": "Reasoning effort: low/medium/high/max", "type": "string" }, "temperature": { "description": "Override temperature for this model (0.0-2.0)", "type": "number" }, "top_p": { "description": "Override top_p for this model", "type": "number" } }, "required": [ "name" ], "type": "object" }, "RoundtableRequest": { "properties": { "choices": { "description": "Literal options for multiple_choice resolution", "items": { "type": "string" }, "type": "array" }, "input": { "description": "The question or prompt sent to all models", "type": "string" }, "instructions": { "description": "System prompt shared across all model calls", "type": "string" }, "max_retries": { "description": "Per-model retry count on transient errors (default 1 / max 3)", "type": "integer" }, "models": { "description": "Models to query in parallel", "items": { "properties": { "max_tokens": { "description": "Override max output tokens for this model. Falls back to the model's configured default or 8192 when unspecified.", "type": "integer" }, "name": { "description": "Model identifier (e.g. gpt-4o or anthropic/claude-sonnet-4-20250514)", "type": "string" }, "reasoning": { "description": "Reasoning effort: low/medium/high/max", "type": "string" }, "temperature": { "description": "Override temperature for this model (0.0-2.0)", "type": "number" }, "top_p": { "description": "Override top_p for this model", "type": "number" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "output_schema": { "description": "JSON Schema for structured output — applied to all model calls and the consolidation call", "type": "object" }, "resolution": { "description": "Resolution mode: summary (default) / fast / multiple_choice", "type": "string" }, "stream": { "description": "Enable SSE streaming", "type": "boolean" }, "summary_model": { "description": "Override the model used for consolidation in summary mode", "type": "string" }, "timeout_ms": { "description": "Per-model timeout in milliseconds covering all retries (default 120000 / max 300000)", "type": "integer" } }, "required": [ "input", "models" ], "type": "object" }, "RoundtableResponse": { "properties": { "data": { "description": "Final consolidated output. Null in fast mode (no consolidation runs).", "type": "string" }, "id": { "description": "Stable identifier for this roundtable call.", "type": "string" }, "meta": { "description": "Aggregated call metadata.", "properties": { "models_used": { "description": "Names of the models queried in parallel.", "items": { "type": "string" }, "type": "array" }, "resolution": { "description": "Resolution mode that produced this response (summary / fast / multiple_choice).", "type": "string" }, "summary_model": { "description": "Model used for the consolidation call. Only set in summary mode.", "type": "string" }, "summary_usage": { "description": "Token counts for the consolidation call aggregated across retries.", "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "code_interpreter_sessions": { "type": "integer" }, "extra": { "type": "object" }, "file_search_calls": { "type": "integer" }, "google_search_prompts": { "type": "integer" }, "google_search_queries": { "type": "integer" }, "image_generation_calls": { "type": "integer" }, "input_audio_tokens": { "type": "integer" }, "input_image_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_audio_tokens": { "type": "integer" }, "output_image_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "url_context_requests": { "type": "integer" }, "web_fetch_requests": { "type": "integer" }, "web_search_calls": { "type": "integer" }, "web_search_requests": { "type": "integer" }, "x_search_calls": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" }, "total_cost": { "description": "USD cost summed across all fan-out models and the consolidation call.", "type": "number" }, "total_duration_ms": { "description": "End-to-end request duration in milliseconds.", "type": "integer" }, "trace_uuid": { "description": "UUID of the trace span for this roundtable call.", "type": "string" } }, "required": [ "resolution", "models_used", "total_cost", "total_duration_ms" ], "type": "object" }, "model_results": { "description": "Per-model fan-out results in the order they appeared in the request.", "items": { "properties": { "cost": { "description": "USD cost for this model call summed across retries.", "type": "number" }, "data": { "description": "Raw model output. When output_schema is supplied this is a JSON string that validated against the schema.", "type": "string" }, "duration_ms": { "description": "Wall-clock time for this model call in milliseconds including retries.", "type": "integer" }, "error": { "description": "Provider or transport error message. Empty on success.", "type": "string" }, "index": { "description": "Position of this model in the request's models array (0-based).", "type": "integer" }, "model": { "description": "Name of the model that produced this result.", "type": "string" }, "schema_error": { "description": "Why the output failed schema validation. Empty when schema_valid is true or absent.", "type": "string" }, "schema_valid": { "description": "Whether the model's output validated against the request's output_schema. Absent when no output_schema was supplied.", "type": "boolean" }, "usage": { "description": "Token counts aggregated across all retry attempts.", "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "code_interpreter_sessions": { "type": "integer" }, "extra": { "type": "object" }, "file_search_calls": { "type": "integer" }, "google_search_prompts": { "type": "integer" }, "google_search_queries": { "type": "integer" }, "image_generation_calls": { "type": "integer" }, "input_audio_tokens": { "type": "integer" }, "input_image_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_audio_tokens": { "type": "integer" }, "output_image_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "url_context_requests": { "type": "integer" }, "web_fetch_requests": { "type": "integer" }, "web_search_calls": { "type": "integer" }, "web_search_requests": { "type": "integer" }, "x_search_calls": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" } }, "required": [ "index", "model", "data", "duration_ms" ], "type": "object" }, "type": "array" } }, "required": [ "id", "data", "meta", "model_results" ], "type": "object" }, "RoundtableResponseMeta": { "properties": { "models_used": { "description": "Names of the models queried in parallel.", "items": { "type": "string" }, "type": "array" }, "resolution": { "description": "Resolution mode that produced this response (summary / fast / multiple_choice).", "type": "string" }, "summary_model": { "description": "Model used for the consolidation call. Only set in summary mode.", "type": "string" }, "summary_usage": { "description": "Token counts for the consolidation call aggregated across retries.", "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "code_interpreter_sessions": { "type": "integer" }, "extra": { "type": "object" }, "file_search_calls": { "type": "integer" }, "google_search_prompts": { "type": "integer" }, "google_search_queries": { "type": "integer" }, "image_generation_calls": { "type": "integer" }, "input_audio_tokens": { "type": "integer" }, "input_image_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_audio_tokens": { "type": "integer" }, "output_image_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "url_context_requests": { "type": "integer" }, "web_fetch_requests": { "type": "integer" }, "web_search_calls": { "type": "integer" }, "web_search_requests": { "type": "integer" }, "x_search_calls": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" }, "total_cost": { "description": "USD cost summed across all fan-out models and the consolidation call.", "type": "number" }, "total_duration_ms": { "description": "End-to-end request duration in milliseconds.", "type": "integer" }, "trace_uuid": { "description": "UUID of the trace span for this roundtable call.", "type": "string" } }, "required": [ "resolution", "models_used", "total_cost", "total_duration_ms" ], "type": "object" }, "RoundtableStreamChunk": { "properties": { "cost": { "description": "USD cost for the model that just completed (on model_done / resolution_done).", "type": "number" }, "data": { "description": "Full accumulated content on model_done and resolution_done events.", "type": "string" }, "delta": { "description": "Incremental text payload on model_delta and resolution_delta events.", "type": "string" }, "error": { "description": "Error message for this event.", "type": "string" }, "meta": { "description": "Aggregated response meta. Only set on the final done event.", "properties": { "models_used": { "description": "Names of the models queried in parallel.", "items": { "type": "string" }, "type": "array" }, "resolution": { "description": "Resolution mode that produced this response (summary / fast / multiple_choice).", "type": "string" }, "summary_model": { "description": "Model used for the consolidation call. Only set in summary mode.", "type": "string" }, "summary_usage": { "description": "Token counts for the consolidation call aggregated across retries.", "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "code_interpreter_sessions": { "type": "integer" }, "extra": { "type": "object" }, "file_search_calls": { "type": "integer" }, "google_search_prompts": { "type": "integer" }, "google_search_queries": { "type": "integer" }, "image_generation_calls": { "type": "integer" }, "input_audio_tokens": { "type": "integer" }, "input_image_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_audio_tokens": { "type": "integer" }, "output_image_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "url_context_requests": { "type": "integer" }, "web_fetch_requests": { "type": "integer" }, "web_search_calls": { "type": "integer" }, "web_search_requests": { "type": "integer" }, "x_search_calls": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" }, "total_cost": { "description": "USD cost summed across all fan-out models and the consolidation call.", "type": "number" }, "total_duration_ms": { "description": "End-to-end request duration in milliseconds.", "type": "integer" }, "trace_uuid": { "description": "UUID of the trace span for this roundtable call.", "type": "string" } }, "required": [ "resolution", "models_used", "total_cost", "total_duration_ms" ], "type": "object" }, "model": { "description": "Model name. Set on model_start / model_done and resolution_start.", "type": "string" }, "model_index": { "description": "Index of the fan-out model this event refers to. Present on model_* events.", "type": "integer" }, "schema_error": { "description": "Validation failure detail when schema_valid is false.", "type": "string" }, "schema_valid": { "description": "output_schema validation result on model_done and resolution_done. Absent when no output_schema was supplied.", "type": "boolean" }, "type": { "description": "Event type: model_start / model_delta / model_done / resolution_start / resolution_delta / resolution_done / done.", "type": "string" }, "usage": { "description": "Token counts for the model that just completed (on model_done / resolution_done).", "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "code_interpreter_sessions": { "type": "integer" }, "extra": { "type": "object" }, "file_search_calls": { "type": "integer" }, "google_search_prompts": { "type": "integer" }, "google_search_queries": { "type": "integer" }, "image_generation_calls": { "type": "integer" }, "input_audio_tokens": { "type": "integer" }, "input_image_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_audio_tokens": { "type": "integer" }, "output_image_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" }, "url_context_requests": { "type": "integer" }, "web_fetch_requests": { "type": "integer" }, "web_search_calls": { "type": "integer" }, "web_search_requests": { "type": "integer" }, "x_search_calls": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" } }, "required": [ "type" ], "type": "object" }, "Route": { "properties": { "access": { "type": "string" }, "country": { "type": "string" }, "data_handling": { "properties": { "caching": { "properties": { "default": { "type": "string" }, "scope": { "type": "string" }, "storage_location": { "type": "string" }, "ttl_seconds": { "type": "integer" } }, "required": [ "default" ], "type": "object" }, "logging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "moderation": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "residency_enforced": { "type": "boolean" }, "subprocessors_read_content": { "type": "boolean" }, "training": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" } }, "required": [ "training", "logging", "moderation", "caching" ], "type": "object" }, "gdpr": { "properties": { "dpa_available": { "type": "boolean" }, "residency": { "type": "string" }, "transfer_mechanism": { "type": "string" } }, "required": [ "residency", "transfer_mechanism" ], "type": "object" }, "id": { "type": "string" }, "inference_location": { "type": "string" }, "last_verified_at": { "type": "string" }, "native_region": { "type": "string" }, "provider": { "type": "string" }, "provider_display_name": { "type": "string" }, "region": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" }, "underlying_maker": { "type": "string" } }, "required": [ "id", "provider", "provider_display_name", "region", "native_region", "country", "data_handling", "gdpr" ], "type": "object" }, "RouteDataHandling": { "properties": { "caching": { "properties": { "default": { "type": "string" }, "scope": { "type": "string" }, "storage_location": { "type": "string" }, "ttl_seconds": { "type": "integer" } }, "required": [ "default" ], "type": "object" }, "logging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "moderation": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "residency_enforced": { "type": "boolean" }, "subprocessors_read_content": { "type": "boolean" }, "training": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" } }, "required": [ "training", "logging", "moderation", "caching" ], "type": "object" }, "RouteGDPR": { "properties": { "dpa_available": { "type": "boolean" }, "residency": { "type": "string" }, "transfer_mechanism": { "type": "string" } }, "required": [ "residency", "transfer_mechanism" ], "type": "object" }, "RouteLogging": { "properties": { "default": { "type": "string" }, "human_review": { "type": "string" }, "retention_days": { "type": "integer" }, "storage_location": { "type": "string" } }, "required": [ "default", "retention_days" ], "type": "object" }, "RouteTraining": { "properties": { "default": { "type": "string" } }, "required": [ "default" ], "type": "object" }, "RunRequest": { "properties": { "guard": { "properties": { "input": { "items": { "properties": { "action": { "type": "string" }, "applies_to": { "type": "string" }, "check": { "type": "string" }, "custom_patterns": { "items": { "type": "string" }, "type": "array" }, "engine": { "type": "string" }, "kind": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "patterns": { "items": { "properties": { "name": { "type": "string" }, "regex": { "type": "string" } }, "required": [ "regex" ], "type": "object" }, "type": "array" }, "presets": { "items": { "type": "string" }, "type": "array" }, "prompt": { "type": "string" }, "replacement": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope": { "properties": { "functions": { "items": { "type": "string" }, "type": "array" }, "kind": { "type": "string" } }, "required": [ "kind" ], "type": "object" }, "scope_type": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" }, "output": { "items": { "properties": { "action": { "type": "string" }, "applies_to": { "type": "string" }, "check": { "type": "string" }, "custom_patterns": { "items": { "type": "string" }, "type": "array" }, "engine": { "type": "string" }, "kind": { "type": "string" }, "model": { "type": "string" }, "name": { "type": "string" }, "patterns": { "items": { "properties": { "name": { "type": "string" }, "regex": { "type": "string" } }, "required": [ "regex" ], "type": "object" }, "type": "array" }, "presets": { "items": { "type": "string" }, "type": "array" }, "prompt": { "type": "string" }, "replacement": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope": { "properties": { "functions": { "items": { "type": "string" }, "type": "array" }, "kind": { "type": "string" } }, "required": [ "kind" ], "type": "object" }, "scope_type": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "input": { "description": "Any value" }, "input_schema": { "description": "JSON Schema for the input. Optional; defaults to string when omitted.", "type": "object" }, "instructions": { "type": "string" }, "model": { "oneOf": [ { "description": "Model identifier (e.g. \"openai/gpt-4o\")", "type": "string" }, { "properties": { "extra_headers": { "description": "Extra HTTP headers to send with requests to this model", "type": "object" }, "name": { "description": "Model identifier (e.g. \"openai/gpt-4o\")", "type": "string" }, "options": { "description": "Per-model parameters (temperature, max_tokens, reasoning_effort, etc.)", "type": "object" } }, "required": [ "name" ], "type": "object" }, { "description": "Fallback chain — models tried in order on retriable errors", "items": { "oneOf": [ { "type": "string" }, { "properties": { "extra_headers": { "description": "Extra HTTP headers to send with requests to this model", "type": "object" }, "name": { "description": "Model identifier (e.g. \"openai/gpt-4o\")", "type": "string" }, "options": { "description": "Per-model parameters (temperature, max_tokens, reasoning_effort, etc.)", "type": "object" } }, "required": [ "name" ], "type": "object" } ] }, "type": "array" } ] }, "name": { "type": "string" }, "output_schema": { "description": "JSON Schema for the output. Optional; defaults to string when omitted.", "type": "object" }, "parent_span_id": { "type": "string" }, "reasoning_effort": { "description": "Reasoning effort for reasoning-capable models. One of \"low\"", "type": "string" }, "reasoning_summary": { "description": "Opt into thought summary streaming. \"auto\"", "type": "string" }, "route": { "properties": { "prefer": { "type": "string" } }, "type": "object" }, "stream": { "type": "boolean" }, "tools": { "items": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" } }, "required": [ "input" ], "type": "object" }, "RunResponse": { "properties": { "data": { "description": "Any value" }, "meta": { "properties": { "cost": { "type": "number" }, "execution_ms": { "type": "integer" }, "function_name": { "type": "string" }, "generation_ms": { "type": "integer" }, "guards": { "items": { "properties": { "code": { "type": "string" }, "findings": { "items": { "description": "Any value" }, "type": "array" }, "flagged": { "type": "boolean" }, "phase": { "type": "string" }, "rule_id": { "type": "string" }, "rule_name": { "type": "string" }, "scope_type": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "flagged" ], "type": "object" }, "type": "array" }, "image_gen_calls": { "type": "integer" }, "llm_calls": { "type": "integer" }, "message": { "type": "string" }, "model_warnings": { "items": { "type": "string" }, "type": "array" }, "models_used": { "items": { "type": "string" }, "type": "array" }, "pending_operations": { "items": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "status_url", "type" ], "type": "object" }, "type": "array" }, "script_cached": { "type": "boolean" }, "status": { "type": "string" }, "tool_calls": { "items": { "type": "object" }, "type": "array" }, "trace_uuid": { "type": "string" }, "tts_calls": { "type": "integer" }, "usage": { "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" } }, "required": [ "function_name", "script_cached", "execution_ms", "llm_calls", "tts_calls", "image_gen_calls" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SpeechAudio": { "properties": { "b64_json": { "type": "string" }, "file_id": { "type": "string" }, "mime_type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "SpeechRequest": { "properties": { "format": { "type": "string" }, "input": { "type": "string" }, "model": { "type": "string" }, "parameters": { "type": "object" }, "speed": { "type": "number" }, "store": { "description": "Persist the generated audio to /v3/files and return a reusable file_id. Defaults to true; set false to skip.", "type": "boolean" }, "voice": { "type": "string" } }, "required": [ "model", "input" ], "type": "object" }, "SpeechResponse": { "properties": { "audio": { "properties": { "b64_json": { "type": "string" }, "file_id": { "type": "string" }, "mime_type": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "created": { "type": "integer" }, "id": { "type": "string" }, "model": { "type": "string" }, "usage": { "properties": { "characters": { "type": "integer" }, "cost": { "type": "number" } }, "required": [ "cost", "characters" ], "type": "object" } }, "required": [ "id", "model", "created", "audio", "usage" ], "type": "object" }, "SpeechUsage": { "properties": { "characters": { "type": "integer" }, "cost": { "type": "number" } }, "required": [ "cost", "characters" ], "type": "object" }, "StreamOptions": { "properties": { "include_usage": { "type": "boolean" } }, "type": "object" }, "Tool": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "object" }, "type": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "TranscriptionJobResponse": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" } }, "required": [ "id", "status_url" ], "type": "object" }, "TranscriptionRequest": { "properties": { "async": { "type": "boolean" }, "audio": { "type": "string" }, "diarize": { "type": "boolean" }, "language": { "type": "string" }, "model": { "type": "string" }, "parameters": { "type": "object" }, "prompt": { "type": "string" }, "stream": { "type": "boolean" } }, "required": [ "model", "audio" ], "type": "object" }, "TranscriptionResponse": { "properties": { "created": { "type": "integer" }, "duration": { "type": "number" }, "id": { "type": "string" }, "language": { "type": "string" }, "model": { "type": "string" }, "segments": { "items": { "properties": { "end": { "type": "number" }, "speaker": { "type": "string" }, "start": { "type": "number" }, "text": { "type": "string" } }, "required": [ "start", "end", "text" ], "type": "object" }, "type": "array" }, "text": { "type": "string" }, "usage": { "properties": { "cost": { "type": "number" }, "seconds": { "type": "number" } }, "required": [ "cost", "seconds" ], "type": "object" }, "words": { "items": { "properties": { "end": { "type": "number" }, "start": { "type": "number" }, "word": { "type": "string" } }, "required": [ "word", "start", "end" ], "type": "object" }, "type": "array" } }, "required": [ "id", "model", "created", "text", "usage" ], "type": "object" }, "TranscriptionSegment": { "properties": { "end": { "type": "number" }, "speaker": { "type": "string" }, "start": { "type": "number" }, "text": { "type": "string" } }, "required": [ "start", "end", "text" ], "type": "object" }, "TranscriptionUsage": { "properties": { "cost": { "type": "number" }, "seconds": { "type": "number" } }, "required": [ "cost", "seconds" ], "type": "object" }, "TranscriptionWord": { "properties": { "end": { "type": "number" }, "start": { "type": "number" }, "word": { "type": "string" } }, "required": [ "word", "start", "end" ], "type": "object" }, "UnavailableModelsResponse": { "properties": { "limit": { "type": "integer" }, "models": { "items": { "properties": { "availability": { "type": "string" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "context_window": { "type": "integer" }, "description": { "type": "string" }, "featured": { "type": "boolean" }, "maker": { "properties": { "country": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "display_name" ], "type": "object" }, "max_output_tokens": { "type": "integer" }, "model": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "model", "name", "type", "capabilities", "availability", "maker" ], "type": "object" }, "type": "array" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "models", "total", "offset", "limit" ], "type": "object" }, "UpdateFileRequest": { "properties": { "ttl_seconds": { "description": "Positive integer (max 3153600000", "type": "integer" } }, "required": [ "ttl_seconds" ], "type": "object" }, "UpdateFunctionRequest": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object" }, "UpdateManagementProjectRequest": { "properties": { "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "UpdateSpanRequest": { "properties": { "end_time": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "meta": { "type": "object" }, "metadata": { "type": "object" }, "output": { "type": "string" }, "tags": { "type": "object" } }, "type": "object" }, "UsageInfo": { "properties": { "cache_creation_1h_tokens": { "type": "integer" }, "cache_creation_tokens": { "type": "integer" }, "cache_read_tokens": { "type": "integer" }, "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "reasoning_tokens": { "type": "integer" } }, "required": [ "input_tokens", "output_tokens" ], "type": "object" }, "VideoRequest": { "properties": { "aspect_ratio": { "type": "string" }, "image": { "type": "string" }, "last_image": { "type": "string" }, "model": { "type": "string" }, "parameters": { "type": "object" }, "prompt": { "type": "string" }, "reference_images": { "items": { "type": "string" }, "type": "array" }, "resolution": { "type": "string" }, "seconds": { "type": "integer" }, "size": { "type": "string" }, "store": { "description": "Persist the finished video to /v3/files and return a reusable file_id on the status poll. Defaults to true; set false to skip.", "type": "boolean" }, "video": { "type": "string" } }, "required": [ "model", "prompt" ], "type": "object" }, "VideoResponse": { "properties": { "id": { "type": "string" }, "status_url": { "type": "string" } }, "required": [ "id", "status_url" ], "type": "object" }, "VoiceObject": { "properties": { "created": { "type": "integer" }, "expires_at": { "type": "integer" }, "id": { "type": "string" }, "languages": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "object": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "id", "object", "provider", "created" ], "type": "object" }, "WebFetchRequest": { "properties": { "engine": { "description": "Fetch backend. auto (default) routes to Jina.", "enum": [ "auto", "jina" ], "type": "string" }, "max_chars": { "description": "Truncate the returned content to at most this many characters. 0 means unbounded (return the full page).", "type": "integer" }, "url": { "description": "The HTTP or HTTPS URL to fetch. Required.", "type": "string" } }, "required": [ "url" ], "type": "object" }, "WebFetchResponse": { "properties": { "content": { "description": "Page content as Markdown. Truncated to max_chars if set.", "type": "string" }, "title": { "description": "Page title as extracted from the rendered HTML.", "type": "string" }, "url": { "description": "Canonical URL of the fetched page (may differ from the requested URL after redirects).", "type": "string" } }, "required": [ "url", "title", "content" ], "type": "object" }, "WebSearchRequest": { "properties": { "allowed_domains": { "description": "Restrict results to these domains (e.g. \"go.dev\" or \"pkg.go.dev\").", "items": { "type": "string" }, "type": "array" }, "country": { "description": "Two-letter ISO-3166 alpha-2 country code (e.g. \"se\" or \"us\") biasing results to that region. Case-insensitive.", "type": "string" }, "engine": { "description": "Search backend. auto (default) routes to Opper's default engine (Jina today). jina and exa pin a specific backend (when configured server-side).", "enum": [ "auto", "jina", "exa" ], "type": "string" }, "excluded_domains": { "description": "Exclude results from these domains (e.g. \"reddit.com\").", "items": { "type": "string" }, "type": "array" }, "max_results": { "description": "Maximum results per page. 0 uses the engine default (typically 5). Must be between 0 and 20.", "type": "integer" }, "max_total_results": { "description": "Cap on total results accumulated across pages. 0 disables pagination. Silently ignored on engines without paginated search.", "type": "integer" }, "query": { "description": "Search query string. Required.", "type": "string" }, "search_context_size": { "description": "Per-result snippet length in characters. very_low ≈ 1000; low ≈ 5000; medium ≈ 10000 (default); high ≈ 30000; full returns the full extracted page content (capped ~50000).", "enum": [ "very_low", "low", "medium", "high", "full" ], "type": "string" } }, "required": [ "query" ], "type": "object" }, "WebSearchResponse": { "properties": { "results": { "items": { "properties": { "published_at": { "description": "Publication date when reported by the engine. Empty when unknown.", "type": "string" }, "score": { "description": "Relevance score when reported by the engine. Omitted on engines that don't expose one (e.g. Jina).", "type": "number" }, "snippet": { "description": "Short text excerpt from the page. Length is bounded by the request's search_context_size.", "type": "string" }, "title": { "description": "Page title as reported by the search engine.", "type": "string" }, "url": { "description": "Canonical URL of the result page.", "type": "string" } }, "required": [ "title", "url", "snippet" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" }, "WebSearchResult": { "properties": { "published_at": { "description": "Publication date when reported by the engine. Empty when unknown.", "type": "string" }, "score": { "description": "Relevance score when reported by the engine. Omitted on engines that don't expose one (e.g. Jina).", "type": "number" }, "snippet": { "description": "Short text excerpt from the page. Length is bounded by the request's search_context_size.", "type": "string" }, "title": { "description": "Page title as reported by the search engine.", "type": "string" }, "url": { "description": "Canonical URL of the result page.", "type": "string" } }, "required": [ "title", "url", "snippet" ], "type": "object" }, "ZDRFacts": { "properties": { "caching": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "logging": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "moderation": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "subprocessors": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "training": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "logging", "moderation", "caching", "training", "subprocessors" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "bearerFormat": "API Key", "description": "API key authentication. Pass your API key as a Bearer token.", "scheme": "bearer", "type": "http" }, "ManagementBearer": { "bearerFormat": "Management API Key", "description": "Management API authentication. Pass an `op-mak-…` management token as a Bearer token. Runtime `op-…` API keys are rejected with 403 — they belong on the data-plane endpoints. Mint a management key from the platform UI under Settings → API keys.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Schema-driven generative API that orchestrates LLM-powered workflows.", "title": "Task API", "version": "3.0.0" }, "openapi": "3.1.0", "paths": { "/health": { "get": { "description": "Returns server health status.", "operationId": "healthCheck", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "example": "ok", "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "Health check", "tags": [ "System" ] } }, "/management/mcp": { "post": { "description": "Serves this management API to AI agents over the Model Context Protocol, revision `2026-07-28`, using the stateless Streamable HTTP binding. Every operation under `/management/v1` is exposed as an MCP tool, and a tool call is executed as the corresponding HTTP request — same authentication, same plan gate, same scope guard. `tools/list` returns only the tools the calling key's scopes permit.\n\nThere is no session: the `initialize` handshake and `Mcp-Session-Id` are not part of this revision, so each POST is self-contained and any request may land on any instance. Send a single JSON-RPC 2.0 request (batches are not accepted) with `method` set to `server/discover`, `tools/list` or `tools/call`, and carry the required per-request metadata in `params._meta`: `io.modelcontextprotocol/protocolVersion` and `io.modelcontextprotocol/clientCapabilities`.\n\nThree headers are required and must agree with the body, or the request is rejected with `400` and JSON-RPC code `-32020`: `MCP-Protocol-Version` (matching `_meta`), `Mcp-Method` (matching `method`), and — on `tools/call` — `Mcp-Name` (matching `params.name`). An unimplemented method returns `404` with code `-32601`; an unsupported protocol version returns `400` with code `-32022` and the versions this server does support. `GET` and `DELETE` return `405`: they belonged to the session-based revisions.\n\nThe path carries no version: the version that matters is the protocol's, and it travels per-request in the `MCP-Protocol-Version` header and `_meta`.\n\nAuthenticate exactly as for the rest of the management surface — an `op-mak-…` management key as a Bearer token.", "operationId": "callManagementMCP", "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "description": "Request identifier: a string or a number, never null. Echoed back on the response.", "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "jsonrpc": { "description": "JSON-RPC version. Always `2.0`.", "enum": [ "2.0" ], "type": "string" }, "method": { "description": "The RPC to invoke. Must equal the `Mcp-Method` header.", "enum": [ "server/discover", "tools/list", "tools/call" ], "type": "string" }, "params": { "description": "Method parameters. `_meta` is required on every request; `name` and `arguments` apply to `tools/call`.", "properties": { "_meta": { "description": "Per-request protocol metadata. This replaced the `initialize` handshake, which is why it is required on every request.", "properties": { "io.modelcontextprotocol/clientCapabilities": { "description": "Client capabilities relevant to this request. Send `{}` if none apply.", "type": "object" }, "io.modelcontextprotocol/clientInfo": { "description": "Optional client name and version, for display and debugging only.", "type": "object" }, "io.modelcontextprotocol/protocolVersion": { "description": "MCP revision this request uses. Must equal the `MCP-Protocol-Version` header.", "example": "2026-07-28", "type": "string" } }, "required": [ "io.modelcontextprotocol/protocolVersion", "io.modelcontextprotocol/clientCapabilities" ], "type": "object" }, "arguments": { "description": "Arguments for the tool, matching its `inputSchema` from `tools/list`.", "type": "object" }, "name": { "description": "Tool to invoke, for `tools/call`. Must equal the `Mcp-Name` header.", "type": "string" } }, "type": "object" } }, "required": [ "jsonrpc", "id", "method" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "A JSON-RPC 2.0 response carrying either `result` or `error`, never both.", "properties": { "error": { "description": "Present on failure, in place of `result`.", "properties": { "code": { "description": "`-32020` header/body mismatch, `-32022` unsupported protocol version, `-32601` method not found, `-32602` invalid params.", "type": "integer" }, "data": { "description": "Extra context. `-32022` carries the supported and requested versions here.", "type": "object" }, "message": { "type": "string" } }, "type": "object" }, "id": { "description": "The id of the request this answers." }, "jsonrpc": { "enum": [ "2.0" ], "type": "string" }, "result": { "description": "Present on success. Always carries `resultType: \"complete\"`; the remaining fields depend on the method — `tools` for `tools/list`, `content`/`structuredContent`/`isError` for `tools/call`, `supportedVersions`/`capabilities` for `server/discover`.", "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "405": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "`GET` or `DELETE` on the MCP endpoint. Protocol-level sessions and the standalone `GET` event stream were removed in revision 2026-07-28; this endpoint accepts `POST` only." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "MCP endpoint (Model Context Protocol)", "tags": [ "Management" ] } }, "/management/v1/management-keys/_self/disable": { "post": { "description": "Emergency revocation for a leaked token: disables the management API key the request authenticated with, and every token under it. Possession of the token is the authorization — no scope is required, and this works regardless of the organization's plan.", "operationId": "disableCallingManagementKey", "responses": { "204": { "description": "No content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Disable the calling management key", "tags": [ "Management" ] } }, "/management/v1/projects": { "get": { "description": "Lists every project in the calling organization. Requires the `projects:read` scope.", "operationId": "listManagementProjects", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ManagementProject" }, "type": "array" }, "meta": { "properties": { "total_count": { "description": "Total items in the collection.", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "List projects", "tags": [ "Management" ] }, "post": { "description": "Creates a project in the calling organization. Requires the `projects:write` scope.", "operationId": "createManagementProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManagementProjectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ManagementProject" }, "meta": { "description": "Empty for a single resource. Endpoint-specific context appears here rather than as a sibling of `data`.", "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "A project with this name already exists in the organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Create a project", "tags": [ "Management" ] } }, "/management/v1/projects/{uuid}": { "delete": { "description": "Soft-deletes the project and permanently deletes every runtime API key bound to it. Requires the `projects:delete` scope.", "operationId": "deleteManagementProject", "parameters": [ { "description": "Project UUID", "in": "path", "name": "uuid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "No such resource in the calling organization. A resource belonging to another organization is indistinguishable from one that does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Delete a project", "tags": [ "Management" ] }, "get": { "description": "Fetches one project by UUID. Requires the `projects:read` scope.", "operationId": "getManagementProject", "parameters": [ { "description": "Project UUID", "in": "path", "name": "uuid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ManagementProject" }, "meta": { "description": "Empty for a single resource. Endpoint-specific context appears here rather than as a sibling of `data`.", "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "No such resource in the calling organization. A resource belonging to another organization is indistinguishable from one that does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Get a project", "tags": [ "Management" ] }, "patch": { "description": "Updates a project's name and/or description. Omit a field to leave it unchanged; send `\"description\": null` to clear it. An empty body is rejected. Retention is not settable here — it is a control-plane setting, managed through `/management/v1/controls/rules`. Requires the `projects:write` scope.", "operationId": "updateManagementProject", "parameters": [ { "description": "Project UUID", "in": "path", "name": "uuid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManagementProjectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/ManagementProject" }, "meta": { "description": "Empty for a single resource. Endpoint-specific context appears here rather than as a sibling of `data`.", "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "No such resource in the calling organization. A resource belonging to another organization is indistinguishable from one that does not exist." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "A project with this name already exists in the organization." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Update a project", "tags": [ "Management" ] } }, "/management/v1/projects/{uuid}/api-keys": { "get": { "description": "Lists the runtime API keys bound to a project. Only the key prefix is returned — the full key is shown once, at creation. Requires the `apikeys:read` scope.", "operationId": "listManagementAPIKeys", "parameters": [ { "description": "Project UUID", "in": "path", "name": "uuid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ManagementAPIKey" }, "type": "array" }, "meta": { "properties": { "total_count": { "description": "Total items in the collection.", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "No such resource in the calling organization. A resource belonging to another organization is indistinguishable from one that does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "List a project's API keys", "tags": [ "Management" ] }, "post": { "description": "Mints a runtime API key for the project. The full `op-…` key is returned **once**, in this response, and is never retrievable again. Requires the `apikeys:write` scope.", "operationId": "createManagementAPIKey", "parameters": [ { "description": "Project UUID", "in": "path", "name": "uuid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManagementAPIKeyRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/CreateManagementAPIKeyResponse" }, "meta": { "description": "Empty for a single resource. Endpoint-specific context appears here rather than as a sibling of `data`.", "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "No such resource in the calling organization. A resource belonging to another organization is indistinguishable from one that does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Mint an API key", "tags": [ "Management" ] } }, "/management/v1/projects/{uuid}/api-keys/{id}": { "delete": { "description": "Permanently deletes a runtime API key. Requires the `apikeys:write` scope.", "operationId": "deleteManagementAPIKey", "parameters": [ { "description": "Project UUID", "in": "path", "name": "uuid", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Runtime API key id", "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "403": { "content": { "application/json": { "schema": { "properties": { "allowed_plans": { "description": "Present on the plan-gate refusal.", "items": { "type": "string" }, "type": "array" }, "current_plan": { "description": "Present on the plan-gate refusal.", "type": "string" }, "error": { "type": "string" }, "required_scope": { "description": "Present on the scope refusal.", "type": "string" } }, "type": "object" } } }, "description": "Either the organization's plan does not include the Management API (`current_plan` / `allowed_plans` are returned), or the token lacks the scope this endpoint requires (`required_scope` is returned). Presenting a runtime `op-…` key instead of a management `op-mak-…` token also lands here." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } }, "description": "No such resource in the calling organization. A resource belonging to another organization is indistinguishable from one that does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [ { "ManagementBearer": [] } ], "summary": "Delete an API key", "tags": [ "Management" ] } }, "/v3/artifacts/{id}/status": { "get": { "description": "Poll for async artifact generation status. Returns a presigned download URL when the generation is complete. When the job was submitted with `store: true`, the completed response also carries a `file_id` — the persisted /v3/files entry you can reuse as a typed input on later generations.", "operationId": "getArtifactStatus", "parameters": [ { "description": "Artifact generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message (only when failed)", "type": "string" }, "file_id": { "description": "Persisted /v3/files id for the output (only when completed and the job set store=true)", "type": "string" }, "id": { "type": "string" }, "mime_type": { "type": "string" }, "status": { "enum": [ "processing", "completed", "failed" ], "type": "string" }, "store_skipped": { "description": "Why a store-by-default output was not persisted (e.g. skipped-quota-exceeded); empty when stored or when store was false", "type": "string" }, "url": { "description": "Presigned download URL (only when completed)", "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get artifact generation status", "tags": [ "Artifacts" ] } }, "/v3/audio/models": { "get": { "description": "List the models usable with the `/v3/audio` endpoints — a `type=tts,stt` view of the model catalog. Same shape and query params as `/v3/models` (search, `include`, pagination), but always scoped to audio models. Narrow to one side with `type=tts` (POST /v3/audio/speech) or `type=stt` (POST /v3/audio/transcriptions). `params.tts` lists each speech model's `voices`, `default_voice`, and `max_length`; `params.stt` lists each transcription model's `languages`, `formats`, and whether it supports `diarize`.", "operationId": "listAudioModels", "parameters": [ { "description": "Narrow the audio family to `tts` or `stt`. Default: both.", "in": "query", "name": "type", "schema": { "enum": [ "tts", "stt" ], "type": "string" } }, { "description": "Comma-separated list of optional fields to attach to each item. Supported: `maker` (public), `route` (requires API key), `benchmarks` (public), `policy` (requires API key — per-item comply allowlist verdict).", "in": "query", "name": "include", "schema": { "example": "maker", "type": "string" } }, { "description": "Free-text search across model ID, name, and description.", "in": "query", "name": "q", "schema": { "type": "string" } }, { "description": "Filter by provider name (e.g. `openai`, `xai`).", "in": "query", "name": "provider", "schema": { "type": "string" } }, { "description": "Set to `true` to include retired models in results.", "in": "query", "name": "deprecated", "schema": { "type": "boolean" } }, { "description": "Field to sort by (`id`, `name`, `provider`, `cost`, `speed`, `quality`). Default `id`.", "in": "query", "name": "sort", "schema": { "default": "id", "type": "string" } }, { "description": "`asc` (default) or `desc`.", "in": "query", "name": "order", "schema": { "default": "asc", "type": "string" } }, { "description": "Pagination offset.", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Page size (max 500).", "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List audio models", "tags": [ "Models" ] } }, "/v3/audio/speech": { "post": { "description": "Convert text to spoken audio synchronously and get it back inline as base64. `model` and `input` are required; `voice`, `format` (mp3 default), and `speed` are normalized and validated against the model's declared capabilities, and everything in `parameters` is forwarded verbatim to the provider. Output is saved to /v3/files by default and returned with a reusable `file_id`; set `store: false` to opt out.", "operationId": "createSpeech", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeechRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeechResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Generate speech (TTS)", "tags": [ "Audio" ] } }, "/v3/audio/transcriptions": { "post": { "description": "Transcribe audio to text. By default runs synchronously and returns the transcript inline (200); `audio` accepts a `file_\u003cid\u003e`, an https URL, or a base64 data-URI (max 25MB decoded). Set `stream: true` to receive the transcript live as Server-Sent Events (`transcript.text.delta` chunks then a final `transcript.text.done`, terminated by `data: [DONE]`) — supported on streaming models like `mistral/voxtral-mini-2602`, a 400 otherwise. Set `async: true` to run on the background worker and get a 202 with a status URL to poll instead — use it for long recordings that can exceed the synchronous timeout; it accepts the same `audio` sources (an inline data-URI is staged server-side and deleted after transcription) and lifts the decoded-audio cap to 100MB (a `file_\u003cid\u003e` or https URL is the best way to reach that; a data-URI that large needs a ~133MB request body). `stream` and `async` are mutually exclusive. `model` and `audio` are required; `language` and `prompt` are passed through as hints; `diarize` requests speaker labels (400 on models without diarization support); everything in `parameters` is forwarded verbatim to the provider.", "operationId": "createTranscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionResponse" } } }, "description": "Successful response" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionJobResponse" } } }, "description": "Accepted – async transcription submitted (async: true). Poll the returned `status_url` (GET /v3/artifacts/{id}/status) for a presigned URL to the transcript JSON when complete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Transcribe audio (STT)", "tags": [ "Audio" ] } }, "/v3/audio/voices": { "get": { "description": "List the project's custom cloned voices, newest first. Paginated with the shared `meta`+`data` shape. Preset voices are not listed here — they're documented per model and passed to /v3/audio/speech by name.", "operationId": "listVoices", "parameters": [ { "description": "Max items (default 20, max 100)", "in": "query", "name": "limit", "schema": { "default": 20, "type": "integer" } }, { "description": "Items to skip (default 0)", "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/VoiceObject" }, "type": "array" }, "meta": { "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List custom voices", "tags": [ "Audio" ] }, "post": { "description": "Clone a custom voice from a short reference sample (a few seconds of speech). `model` selects the provider to clone on (e.g. `mistral/voxtral-mini-tts-2603`) — the returned voice works with any of that provider's TTS models; `audio` is the reference sample as a `file_\u003cid\u003e`, an https URL, or a base64 data-URI; `languages` and `gender` are optional hints. Returns an opaque `id` (`voice_…`) to pass as `voice` on POST /v3/audio/speech. The voice is scoped to your project — it is not visible to or usable by other projects — and the reference audio is not stored. Paid feature.", "operationId": "createVoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVoiceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceObject" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Create a custom voice (clone)", "tags": [ "Audio" ] } }, "/v3/audio/voices/{id}": { "delete": { "description": "Delete one of the project's custom voices. Removes it upstream at the provider too; the reference sample was never stored.", "operationId": "deleteVoice", "parameters": [ { "description": "Voice id (voice_…)", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleted": { "type": "boolean" }, "id": { "type": "string" }, "object": { "example": "voice", "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Delete a custom voice", "tags": [ "Audio" ] }, "get": { "description": "Get one of the project's custom voices by id.", "operationId": "getVoice", "parameters": [ { "description": "Voice id (voice_…)", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceObject" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get a custom voice", "tags": [ "Audio" ] } }, "/v3/compat/chat/completions": { "post": { "description": "OpenAI-compatible chat completions endpoint. Supports streaming via the stream parameter.", "operationId": "chatCompletions", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream. Each event is `data: \u003cjson\u003e` (a `chat.completion.chunk` object). The stream terminates with `data: [DONE]`. When `stream_options.include_usage` is true, the final chunk before `[DONE]` carries `usage` and an Opper `cost` extension.", "type": "string" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Chat Completions API", "tags": [ "Compatibility" ] } }, "/v3/compat/embeddings": { "post": { "description": "OpenAI-compatible embeddings endpoint.", "operationId": "createEmbeddings", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingsResponse" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Embeddings API", "tags": [ "Compatibility" ] } }, "/v3/compat/models": { "get": { "description": "OpenAI Models API compatible endpoint. Returns everything the caller can put in `model` — in OpenAI's models.list shape — so tools that point an OpenAI-compatible base URL at `/v3/compat` (gateways, n8n, LangChain, etc.) can discover the live catalogue without hardcoding model IDs.\n\nEvery entry carries `opper.kind`, which names what it is:\n\n- `model` — a concrete catalog row (LLM or embedding), e.g. `anthropic/claude-sonnet-4.5`. Pinning this id pins that provider.\n- `pool` — a bare model name that load-balances across providers, e.g. `claude-sonnet-4.5`. `opper.members` lists the catalog rows it routes over. Listed only for names that genuinely fan out (two or more routable members).\n- `dynamic_route` — one of the calling org's deployed routing graphs, addressed as `dynamic/\u003cname\u003e`. `opper.version` is the deployed version a call would execute. Org-scoped to the API key; draft-only routes are not listed. No pricing is reported — the graph picks the model per request — but `context_length` and `opper.max_output_tokens` ARE, as the smallest any reachable candidate offers: a floor is a guarantee rather than a guess, and clients that must size a context before calling would otherwise have to invent one. Omitted when any candidate cannot be resolved here (e.g. an org-scoped BYOK model).\n\nNarrow with `?type=` (comma-separated, e.g. `?type=pool,dynamic_route`); omitting it returns all three kinds, with concrete models first (their long-standing order is unchanged), then pools, then routes.\n\nEntries additionally carry OpenRouter-shaped `pricing` (USD per token) and `context_length`, plus an `opper` block holding the entry's `type` (`llm` or `embedding` — this list carries both, and `capabilities` cannot tell them apart), the model's `capabilities` (`text`, `tools`, `vision`, `pdf`, `structured_output`, … — the same vocabulary as `/v3/models`), its `max_output_tokens`, and a compliance summary (`region`, `country`, `zdr`, `gdpr_residency`, `verification`) so a client can declare what a model can do and filter on residency/ZDR criteria in one call; `zdr` is the tri-state retention facts object (`logging`, `moderation`, `caching`, `training`, `subprocessors`; `null` = not established), not a summary word — derive what you need from it; full data-handling detail lives on `/v3/models?include=route`. A pool reports a capability or compliance property only when EVERY member has it, takes the smallest `context_length` / `max_output_tokens` across members, and prices at the worst case, so a capability check, a residency filter or a pre-call cost estimate can never be flattered by one lucky member. `dynamic_route` entries carry no capabilities for the same reason they carry no pricing. The whole listing is scoped to the caller's comply allowlist: denied models, denied pool members, pools with no permitted member, and routes whose every model node is denied are all absent. Featured models first, then ID-ascending; no pagination, matching OpenAI.", "operationId": "listOpenAICompatModels", "parameters": [ { "description": "Comma-separated entry kinds to return: `model`, `pool`, `dynamic_route`. Omit for all three.", "in": "query", "name": "type", "schema": { "example": "pool,dynamic_route", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAICompatModelsListResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List models (OpenAI-compatible)", "tags": [ "Compatibility" ] } }, "/v3/compat/openresponses": { "post": { "description": "OpenResponses-compatible endpoint with multi-provider support and opper: extension items.", "operationId": "createOpenResponse", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ORRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ORResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream. Each event has an `event:` line and a `data: \u003cjson\u003e` line; the payload's `type` field discriminates the event. The stream terminates with a `response.completed` event whose payload carries the final `usage` (token counts and `cost`).", "discriminator": { "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ORStreamEventResponseCreated" }, { "$ref": "#/components/schemas/ORStreamEventResponseInProgress" }, { "$ref": "#/components/schemas/ORStreamEventOutputItemAdded" }, { "$ref": "#/components/schemas/ORStreamEventContentPartAdded" }, { "$ref": "#/components/schemas/ORStreamEventOutputTextDelta" }, { "$ref": "#/components/schemas/ORStreamEventOutputTextDone" }, { "$ref": "#/components/schemas/ORStreamEventContentPartDone" }, { "$ref": "#/components/schemas/ORStreamEventReasoningSummaryDelta" }, { "$ref": "#/components/schemas/ORStreamEventReasoningSummaryDone" }, { "$ref": "#/components/schemas/ORStreamEventFunctionCallArgumentsDelta" }, { "$ref": "#/components/schemas/ORStreamEventFunctionCallArgumentsDone" }, { "$ref": "#/components/schemas/ORStreamEventOutputItemDone" }, { "$ref": "#/components/schemas/ORStreamEventCompleted" }, { "$ref": "#/components/schemas/ORStreamEventError" } ] } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "OpenResponses API", "tags": [ "Compatibility" ] } }, "/v3/compat/responses": { "post": { "description": "OpenAI Responses API compatible endpoint. Supports streaming via the stream parameter.", "operationId": "createResponse", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsesResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream following the OpenAI Responses streaming protocol. Each event has an `event:` line and a `data: \u003cjson\u003e` line. The stream terminates with a `response.completed` event whose payload carries the final `usage` (token counts and Opper `cost` extension).", "type": "string" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Responses API", "tags": [ "Compatibility" ] } }, "/v3/compat/v1/messages": { "post": { "description": "Anthropic Messages API compatible endpoint. Supports streaming via the stream parameter.", "operationId": "createMessage", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream following the Anthropic Messages streaming protocol. The stream terminates with a `message_stop` event; the `message_delta` event preceding it carries the final `usage` and Opper `cost` extension.", "type": "string" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Messages API", "tags": [ "Compatibility" ] } }, "/v3/compat/v1/messages/count_tokens": { "post": { "description": "Anthropic Messages token-counting compatible endpoint. Returns the number of input tokens a Messages request would consume, without creating a message. Mirrors Anthropic's POST /v1/messages/count_tokens (same request body as the Messages endpoint, minus the required max_tokens). Supported for Claude models; other models return 400.", "operationId": "countMessageTokens", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "input_tokens": { "description": "The number of input tokens the request would consume.", "type": "integer" } }, "required": [ "input_tokens" ], "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Count Message tokens", "tags": [ "Compatibility" ] } }, "/v3/compat/v1/models": { "get": { "description": "Anthropic Models API compatible endpoint. Returns Opper LLM models in Anthropic's models.list shape so SDKs and tools (e.g. Claude Code's /model picker) can discover the live catalogue without hardcoding model IDs. Supports forward (after_id) and backward (before_id) cursor pagination on a deterministic featured-first, ID-ascending sort.", "operationId": "listAnthropicCompatModels", "parameters": [ { "description": "Max models to return (1-1000, default 20).", "in": "query", "name": "limit", "schema": { "default": 20, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "Forward-paginate before this model ID; unknown IDs are ignored.", "in": "query", "name": "before_id", "schema": { "type": "string" } }, { "description": "Forward-paginate after this model ID; unknown IDs are ignored.", "in": "query", "name": "after_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnthropicCompatModelsListResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List models (Anthropic-compatible)", "tags": [ "Compatibility" ] } }, "/v3/compat/v1beta/interactions": { "post": { "description": "Google Interactions API compatible endpoint. Supports streaming via the stream parameter.", "operationId": "createInteraction", "parameters": [ { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream. Each event has an `event:` line and a `data: \u003cjson\u003e` line. The stream terminates with an `interaction.complete` event whose payload carries the final `usage` and Opper `cost` extension.", "type": "string" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Interactions API", "tags": [ "Compatibility" ] } }, "/v3/compat/v1beta/models/{model}:countTokens": { "post": { "description": "Google-compatible countTokens endpoint for pre-flight context-window sizing. The request body matches `:generateContent`. NOTE: Opper has no in-process Gemini tokenizer and returns a chars/4 heuristic (±~20% on English prose) — sufficient for \"does my prompt fit?\" checks but not for exact cost projection.", "operationId": "countTokens", "parameters": [ { "description": "Model id — a bare Gemini name (e.g. `gemini-2.5-flash`, resolved against the Gemini-direct provider) or an Opper-canonical id (e.g. `vertexai/gemini-2.5-flash`).", "in": "path", "name": "model", "required": true, "schema": { "type": "string" } }, { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountTokensResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Count Tokens API", "tags": [ "Compatibility" ] } }, "/v3/compat/v1beta/models/{model}:generateContent": { "post": { "description": "Google Gemini-compatible generateContent endpoint — the drop-in surface for SDKs calling `models.generate_content()`. The request body is the Gemini `GenerateContentRequest` shape (camelCase `contents` / `systemInstruction` / `generationConfig`); the response is `candidates[].content.parts[]` + `usageMetadata`. The `{model}` path segment accepts a bare Gemini id (e.g. `gemini-2.5-flash`, defaults to the Gemini-direct provider) or an Opper-canonical id (e.g. `vertexai/gemini-2.5-flash`).", "operationId": "generateContent", "parameters": [ { "description": "Model id — a bare Gemini name (e.g. `gemini-2.5-flash`, resolved against the Gemini-direct provider) or an Opper-canonical id (e.g. `vertexai/gemini-2.5-flash`).", "in": "path", "name": "model", "required": true, "schema": { "type": "string" } }, { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateContentResponse" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Generate Content API", "tags": [ "Compatibility" ] } }, "/v3/compat/v1beta/models/{model}:streamGenerateContent": { "post": { "description": "Streaming variant of generateContent. Pass `?alt=sse` (as Google's SDKs do) to receive Server-Sent Events; each `data:` line is a partial `GenerateContentResponse`. The request body matches `:generateContent`.", "operationId": "streamGenerateContent", "parameters": [ { "description": "Model id — a bare Gemini name (e.g. `gemini-2.5-flash`, resolved against the Gemini-direct provider) or an Opper-canonical id (e.g. `vertexai/gemini-2.5-flash`).", "in": "path", "name": "model", "required": true, "schema": { "type": "string" } }, { "description": "Set to `sse` for Server-Sent Events framing (matches Google SDK behaviour).", "in": "query", "name": "alt", "schema": { "enum": [ "sse" ], "type": "string" } }, { "description": "Function name for tracing and project-level guardrail function-scope filtering.", "in": "header", "name": "X-Opper-Name", "schema": { "type": "string" } }, { "description": "Parent span ID for distributed tracing context.", "in": "header", "name": "X-Opper-Parent-Span-Id", "schema": { "format": "uuid", "type": "string" } }, { "description": "Comma-separated `key:value` usage-attribution tags (e.g. `tenant:acme,project:demo`, max 8). Recorded on the generation's billing/metrics rows; group spend by any key via GET /v2/analytics/usage?group_by=\u003ckey\u003e. Header-borne twin of the /v3/session URL prefix tags (which win per key when both are present); `opper.`-prefixed keys and `session_id` are reserved. Malformed values return 400.", "in": "header", "name": "X-Opper-Tags", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InteractionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateContentResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream (`?alt=sse`). Each event is a `data: \u003cjson\u003e` line carrying a partial `GenerateContentResponse` (incremental `candidates[].content.parts[]`); no `event:` line. The final chunk carries `finishReason` and `usageMetadata` (token counts + Opper `cost` extension under `usageMetadata.opper`).", "type": "string" } } }, "description": "Successful response", "headers": { "X-Opper-Cost": { "description": "Execution cost of the request as a floating-point number.", "schema": { "format": "double", "type": "number" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Stream Generate Content API", "tags": [ "Compatibility" ] } }, "/v3/files": { "get": { "description": "List files for the project, newest first. Paginated with the shared `meta`+`data` shape. Optionally filter by `type`, `purpose`, or a `q` substring search.", "operationId": "listFiles", "parameters": [ { "description": "Max items (default 20, max 100)", "in": "query", "name": "limit", "schema": { "default": 20, "type": "integer" } }, { "description": "Items to skip (default 0)", "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } }, { "description": "Filter by media family", "in": "query", "name": "type", "schema": { "enum": [ "image", "video", "audio" ], "type": "string" } }, { "description": "Filter by exact purpose (e.g. reference_media, generated_image)", "in": "query", "name": "purpose", "schema": { "type": "string" } }, { "description": "Case-insensitive substring match on filename or id", "in": "query", "name": "q", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "bytes": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "filename": { "type": "string" }, "id": { "description": "file_… id", "type": "string" }, "mime_type": { "type": "string" }, "object": { "example": "file", "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List files", "tags": [ "Files" ] }, "post": { "description": "Upload a file (multipart/form-data) and get back a `file_\u003cid\u003e`. The id can be passed as the `image`/`video`/`reference_images` source on POST /v3/videos. `purpose` defaults to `reference_media` (accepts common image/video types). The MIME type is detected from the bytes; size and per-org quota are enforced. Files are permanent until deleted; pass `ttl_seconds` to schedule an expiry.", "operationId": "uploadFile", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The file bytes.", "format": "binary", "type": "string" }, "filename": { "description": "Optional advisory filename (defaults to the upload's filename).", "type": "string" }, "purpose": { "default": "reference_media", "description": "Intended use; gates the accepted MIME types.", "type": "string" }, "ttl_seconds": { "description": "Optional lifetime in seconds; omit for a permanent file. Can be changed later via PATCH /v3/files/{id}.", "type": "integer" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bytes": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "filename": { "type": "string" }, "id": { "description": "file_… id", "type": "string" }, "mime_type": { "type": "string" }, "object": { "example": "file", "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Upload a file", "tags": [ "Files" ] } }, "/v3/files/usage": { "get": { "description": "Report the organization's current file-storage usage against its quota: bytes used/limit/remaining and file count used/limit/remaining. The quota is per-organization and shared by uploads and stored generated media (image/audio/video outputs). Check this before uploading to avoid a `storage_quota_exceeded` (413). A limit of `0` means that dimension is unbounded, in which case `remaining` is omitted.", "operationId": "getFilesUsage", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bytes_limit": { "description": "Per-org byte quota (0 = unbounded).", "type": "integer" }, "bytes_remaining": { "description": "bytes_limit - bytes_used, clamped at 0 (omitted when unbounded).", "type": "integer" }, "bytes_used": { "description": "Total bytes stored across the org's live files.", "type": "integer" }, "file_count": { "description": "Number of the org's live files.", "type": "integer" }, "file_count_limit": { "description": "Per-org file-count quota (0 = unbounded).", "type": "integer" }, "file_count_remaining": { "description": "file_count_limit - file_count, clamped at 0 (omitted when unbounded).", "type": "integer" }, "object": { "example": "files.usage", "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get storage usage", "tags": [ "Files" ] } }, "/v3/files/{id}": { "delete": { "description": "Delete a file (removes the stored bytes).", "operationId": "deleteFile", "parameters": [ { "description": "File ID (file_…)", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleted": { "type": "boolean" }, "id": { "type": "string" }, "object": { "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Delete a file", "tags": [ "Files" ] }, "get": { "description": "Get a file's metadata by id.", "operationId": "getFile", "parameters": [ { "description": "File ID (file_…)", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bytes": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "filename": { "type": "string" }, "id": { "description": "file_… id", "type": "string" }, "mime_type": { "type": "string" }, "object": { "example": "file", "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get file metadata", "tags": [ "Files" ] }, "patch": { "description": "Set or clear a file's expiry. `ttl_seconds` is the only mutable field: a positive integer schedules the file to expire that many seconds from now; an explicit `null` clears a previously set expiry (files are permanent by default).", "operationId": "updateFile", "parameters": [ { "description": "File ID (file_…)", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bytes": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "filename": { "type": "string" }, "id": { "description": "file_… id", "type": "string" }, "mime_type": { "type": "string" }, "object": { "example": "file", "type": "string" }, "purpose": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Update a file's expiry", "tags": [ "Files" ] } }, "/v3/files/{id}/content": { "get": { "description": "Returns a short-TTL presigned download URL for the file's bytes.", "operationId": "getFileContent", "parameters": [ { "description": "File ID (file_…)", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bytes": { "type": "integer" }, "mime_type": { "type": "string" }, "url": { "description": "Presigned download URL (valid ~1 hour)", "type": "string" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get a file download URL", "tags": [ "Files" ] } }, "/v3/generations": { "get": { "description": "List recorded HTTP request/response generations with pagination.", "operationId": "listGenerations", "parameters": [ { "description": "Semantic search query (uses hybrid dense+sparse search)", "in": "query", "name": "query", "schema": { "type": "string" } }, { "description": "Page number (default 1)", "in": "query", "name": "page", "schema": { "default": 1, "type": "integer" } }, { "description": "Items per page (default 50)", "in": "query", "name": "page_size", "schema": { "default": 50, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "type": "object" }, "type": "array" }, "meta": { "properties": { "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total": { "type": "integer" }, "total_pages": { "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List generations", "tags": [ "Generations" ] } }, "/v3/generations/{id}": { "delete": { "description": "Delete a specific recorded generation.", "operationId": "deleteGeneration", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleted": { "type": "boolean" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Delete generation", "tags": [ "Generations" ] }, "get": { "description": "Get a specific recorded generation by ID.", "operationId": "getGeneration", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Recorded generation with request and response data", "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get generation", "tags": [ "Generations" ] } }, "/v3/images": { "post": { "description": "Generate one or more images. By default runs synchronously and returns them inline (200). Set `async: true` to run a single image on the background worker and get a 202 with a status URL to poll instead — use it for slow models (e.g. gpt-image high, imagen ultra) that can exceed the synchronous timeout. `model` and `prompt` are required; `n` (max 4; async is single-image), `size`/`aspect_ratio`, `quality`, and `style` are normalized, and everything in `parameters` is forwarded verbatim to the provider. `image`/`mask`/`reference_images` accept an http(s) URL, a data-URI, or a `file_\u003cid\u003e` for edit / image-to-image. `response_format` defaults to `b64_json`. Outputs are saved to /v3/files by default and returned with a reusable `file_id`; set `store: false` to opt out.", "operationId": "createImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageResponse" } } }, "description": "Successful response" }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageJobResponse" } } }, "description": "Accepted – async generation submitted (async: true). Poll the returned `status_url` (GET /v3/artifacts/{id}/status) for a presigned download URL when complete." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Generate an image", "tags": [ "Images" ] } }, "/v3/images/models": { "get": { "description": "List the models usable with `POST /v3/images` — scoped to the `image_generation` capability. Unlike the video/audio model lists (which scope by `type`), this scopes by capability, because `/v3/images` routes on the `image_generation` capability: the result spans `type:image` models AND hybrid `type:llm` chat-image models (e.g. Nano Banana) that produce images natively. Same shape and query params as `/v3/models` (search, `include`, pagination). `params.image` lists each model's accepted `sizes` (pixel-size models) or `aspect_ratios` (aspect-ratio models) and `qualities`.", "operationId": "listImageModels", "parameters": [ { "description": "Comma-separated list of optional fields to attach to each item. Supported: `maker` (public), `route` (requires API key), `benchmarks` (public), `policy` (requires API key — per-item comply allowlist verdict).", "in": "query", "name": "include", "schema": { "example": "maker", "type": "string" } }, { "description": "Free-text search across model ID, name, and description.", "in": "query", "name": "q", "schema": { "type": "string" } }, { "description": "Filter by provider (company) slug as published in each item's `provider.slug` (e.g. `openai`, `google`, `xai`, `pruna`).", "in": "query", "name": "provider", "schema": { "type": "string" } }, { "description": "Additional capability filter (repeatable) to narrow within image models; `image_generation` is always applied. Items matching ALL listed capabilities are returned.", "in": "query", "name": "capability", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Set to `true` to include retired models in results.", "in": "query", "name": "deprecated", "schema": { "type": "boolean" } }, { "description": "Field to sort by (`id`, `name`, `provider`, `cost`, `speed`, `quality`). Default `id`.", "in": "query", "name": "sort", "schema": { "default": "id", "type": "string" } }, { "description": "`asc` (default) or `desc`.", "in": "query", "name": "order", "schema": { "default": "asc", "type": "string" } }, { "description": "Pagination offset.", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Page size (max 500).", "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List image models", "tags": [ "Models" ] } }, "/v3/me": { "get": { "description": "Identity and billing snapshot for the calling API key: organization and project names, remaining credit balance, spend so far in the current billing period, and whether spending is currently blocked (`balance_exhausted`, `project_spend_cap_hit`, or `org_spend_cap_hit`). Balance and period spend are organization-wide — the key's project only scopes the blocked check. Useful as a pre-flight \"do I have credits left?\" check before starting expensive work.", "operationId": "getMe", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "balance": { "description": "Remaining prepaid credits (organization-wide). Omitted when billing is not configured.", "properties": { "balance_cents": { "description": "Remaining balance in USD cents. May be briefly negative when usage overshoots the last top-up.", "type": "integer" }, "balance_dollars": { "description": "The same balance in USD.", "type": "number" } }, "type": "object" }, "block_reason": { "description": "Why spending is blocked; present only when `blocked` is true.", "enum": [ "balance_exhausted", "project_spend_cap_hit", "org_spend_cap_hit" ], "type": "string" }, "blocked": { "description": "True when new spend is currently rejected.", "type": "boolean" }, "object": { "example": "me", "type": "string" }, "organization": { "properties": { "name": { "type": "string" }, "plan": { "description": "Billing plan (e.g. free, gateway, control_plane, enterprise).", "type": "string" } }, "type": "object" }, "project": { "properties": { "name": { "type": "string" } }, "type": "object" }, "spend": { "description": "Organization-wide usage spend in the current billing period. Omitted when billing is not configured.", "properties": { "period_end": { "format": "date-time", "type": "string" }, "period_start": { "format": "date-time", "type": "string" }, "spent_cents": { "type": "integer" }, "spent_dollars": { "type": "number" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get caller identity and credits", "tags": [ "Account" ] } }, "/v3/models": { "get": { "description": "Endpoint to retrieve model info. Optional `include` adds extra fields per item: `maker` (underlying-weights creator, e.g. `meta` for Llama), `route` (data-handling / legal block — requires an Opper API key), `benchmarks` (public scores from artificialanalysis.ai; absent for realtime, OCR, image-gen, and other specialty models), `policy` (requires an Opper API key — annotates each item with the caller's effective comply allowlist verdict: `{\"allowed\": bool, \"blocked_by\": \"org\"|\"project\"}`; the list itself stays unfiltered). Comma-separated, e.g. `?include=maker,benchmarks`.", "operationId": "listModels", "parameters": [ { "description": "Comma-separated list of optional fields to attach to each item. Supported: `maker` (public), `route` (requires API key), `benchmarks` (public), `policy` (requires API key — per-item comply allowlist verdict).", "in": "query", "name": "include", "schema": { "example": "maker,benchmarks", "type": "string" } }, { "description": "Free-text search across model ID, name, and description.", "in": "query", "name": "q", "schema": { "type": "string" } }, { "description": "Filter by provider (company) slug as published in each item's `provider.slug` and on `/v3/providers` (e.g. `openai`, `anthropic`, `google`). Adapter keys like `vertexai` are not companies and match nothing.", "in": "query", "name": "provider", "schema": { "type": "string" } }, { "description": "Filter by model type (`llm`, `image`, `tts`, `stt`, `video`, `realtime`, `embedding`, `rerank`, `ocr`).", "in": "query", "name": "type", "schema": { "type": "string" } }, { "description": "Filter by capability (repeatable). Items matching ALL listed capabilities are returned.", "in": "query", "name": "capability", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Set to `true` to include retired models in results.", "in": "query", "name": "deprecated", "schema": { "type": "boolean" } }, { "description": "Field to sort by (`id`, `name`, `provider`, `type`, `cost`, `speed`, `quality`, `context_window`). Default `id`.", "in": "query", "name": "sort", "schema": { "default": "id", "type": "string" } }, { "description": "`asc` (default) or `desc`.", "in": "query", "name": "order", "schema": { "default": "asc", "type": "string" } }, { "description": "Pagination offset.", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Page size. A non-positive value returns all rows from offset.", "in": "query", "name": "limit", "schema": { "default": 50, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsResponse" } } }, "description": "Successful response", "headers": { "X-Opper-Model-Catalog-Version": { "description": "Database catalog version of the immutable serving-registry snapshot used for this response. Consumers combining callable and unavailable model feeds should only combine matching versions.", "schema": { "format": "int64", "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List models", "tags": [ "Models" ] } }, "/v3/models/unavailable": { "get": { "description": "List model-level catalog entries that are explicitly published but are not present in this server's live callable model registry. Catalog candidates are cached by version and checked against one immutable live-registry snapshot on every request. Rows contain only model-intrinsic metadata: no callable id, provider, service route, compliance or pricing is fabricated. The default `/v3/models` response remains the callable endpoint catalog; combine the feeds only when their `X-Opper-Model-Catalog-Version` headers match.", "operationId": "listUnavailableModels", "parameters": [ { "description": "Free-text search across model key, name, and description.", "in": "query", "name": "q", "schema": { "type": "string" } }, { "description": "Filter by model type (`llm`, `image`, `tts`, `stt`, `video`, `realtime`, `embedding`, `rerank`, `ocr`).", "in": "query", "name": "type", "schema": { "type": "string" } }, { "description": "Filter by capability (repeatable). Items matching ALL listed capabilities are returned.", "in": "query", "name": "capability", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Pagination offset.", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Page size. A non-positive value returns all rows from offset.", "in": "query", "name": "limit", "schema": { "default": 50, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnavailableModelsResponse" } } }, "description": "Successful response", "headers": { "X-Opper-Model-Catalog-Version": { "description": "Database catalog version of the immutable serving-registry snapshot used for this response. Consumers combining callable and unavailable model feeds should only combine matching versions.", "schema": { "format": "int64", "type": "integer" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List unavailable models", "tags": [ "Models" ] } }, "/v3/ocr": { "post": { "description": "Extract text from a document or image synchronously and get it back as per-page markdown. `model` and `document` are required; `document` is one of `{type:\"document_url\", document_url}`, `{type:\"image_url\", image_url}`, `{type:\"base64\", content, document_name}` (PDF or image), or `{type:\"file\", file_id}` for a `file_\u003cid\u003e` from POST /v3/files. `pages` selects 0-based page indices; `include_image_base64`/`image_limit`/`image_min_size` control embedded-image extraction; everything in `parameters` is forwarded verbatim to the provider (e.g. Docling's `ocr_engine`, `lang`, `table_mode`, `do_formula_enrichment`). Billed per page processed.", "operationId": "createOCR", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OCRRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OCRResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Extract text (OCR)", "tags": [ "OCR" ] } }, "/v3/ocr/models": { "get": { "description": "List the models usable with `POST /v3/ocr` — a `type=ocr` view of the model catalog. Same shape and query params as `/v3/models` (search, `include`, pagination). Each item's `price_per_page` describes the per-page cost.", "operationId": "listOCRModels", "parameters": [ { "description": "Comma-separated list of optional fields to attach to each item. Supported: `maker` (public), `route` (requires API key), `benchmarks` (public), `policy` (requires API key — per-item comply allowlist verdict).", "in": "query", "name": "include", "schema": { "example": "maker", "type": "string" } }, { "description": "Free-text search across model ID, name, and description.", "in": "query", "name": "q", "schema": { "type": "string" } }, { "description": "Filter by provider name (e.g. `mistral`, `docling`).", "in": "query", "name": "provider", "schema": { "type": "string" } }, { "description": "Set to `true` to include retired models in results.", "in": "query", "name": "deprecated", "schema": { "type": "boolean" } }, { "description": "Field to sort by (`id`, `name`, `provider`, `cost`). Default `id`.", "in": "query", "name": "sort", "schema": { "default": "id", "type": "string" } }, { "description": "`asc` (default) or `desc`.", "in": "query", "name": "order", "schema": { "default": "asc", "type": "string" } }, { "description": "Pagination offset.", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Page size (max 500).", "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List OCR models", "tags": [ "Models" ] } }, "/v3/openapi.json": { "get": { "description": "Returns the OpenAPI specification in JSON format.", "operationId": "getOpenAPISpecJSON", "responses": { "200": { "content": { "application/json": { "schema": { "description": "OpenAPI specification", "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "OpenAPI spec (JSON)", "tags": [ "System" ] } }, "/v3/openapi.yaml": { "get": { "description": "Returns the OpenAPI specification in YAML format.", "operationId": "getOpenAPISpecYAML", "responses": { "200": { "content": { "application/json": { "schema": { "description": "OpenAPI specification in YAML format", "type": "string" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "OpenAPI spec (YAML)", "tags": [ "System" ] } }, "/v3/providers": { "get": { "description": "The companies whose models Opper serves — the public provider directory behind opper.ai/models. A **provider** is the company; the places it runs, and the terms it runs them under, are its **service routes**, listed here as `service_routes` (objects carrying their `id`). `owner_country` is the ultimate parent's jurisdiction as an ISO 3166-1 alpha-2 code — AWS is `US` — and is **absent, not empty**, when we have not researched it: a missing key never matches a residency filter. `regions` is the set of coarse residency buckets the company's routes serve from (`EU`, `US`, `GLOBAL`, …). `model_count` is the number of distinct models it serves today, counted the way `/v3/models` counts them: one model served from three routes is one model, and a model retired in the past is not counted. A renamed provider keeps its old names in `previous_slugs` so an indexed URL can be redirected to `slug`, and a provider that stops serving is `status: retired` rather than deleted — fetch it with `?status=retired`.\n\nThe directory itself needs no key. `?include=routes` **does**: it inflates each `service_routes` entry with that route's full block — `region`, `country`, `inference_location`, `data_handling` (training, logging, moderation, caching), `zdr` (the tri-state retention facts object), `gdpr` (residency, DPA availability, transfer mechanism), `sources`, `last_verified_at` and `verification` — which is the same block `/v3/models?include=route` serves, from the same data, behind the same requirement. Without a valid API key it returns **401**, never a quietly reduced response.", "operationId": "listProviders", "parameters": [ { "description": "Comma-separated statuses to include: `live`, `announced`, `retired`, or `all`. Defaults to `live,announced` — retired providers keep their rows and URLs but are not listed by default.", "in": "query", "name": "status", "schema": { "example": "all", "type": "string" } }, { "description": "Set to `routes` to inflate every `service_routes` entry with that route's data-handling / legal block — the same block as `/v3/models?include=route`. **Requires an Opper API key** (`Authorization: Bearer`); without one the request is rejected with 401 rather than served the id-only shape. Unrecognised values are ignored.", "in": "query", "name": "include", "schema": { "example": "routes", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ProviderInfo" }, "type": "array" }, "meta": { "properties": { "total_count": { "description": "Total items in the collection.", "type": "integer" } }, "type": "object" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List providers", "tags": [ "Models" ] } }, "/v3/realtime": { "get": { "description": "Model-driven, scriptless realtime WebSocket endpoint. Open a WS connection, send a `session.start` event with `config.model` set to an Opper realtime model id (e.g. `openai/gpt-realtime-2`); the server resolves the provider from the model registry and connects upstream. Requires a project-scoped runtime API key (server-side) OR an ephemeral ticket minted via `POST /v3/realtime-sessions` (browser-side, passed as `?ticket=\u003cvalue\u003e` or `Sec-WebSocket-Protocol: opper-ticket.\u003cvalue\u003e`). Sessions are bounded by per-project concurrency, max duration, and idle timeout caps; billing flushes every 30 seconds with synchronous balance enforcement.", "operationId": "realtimeAdhocWebSocket", "responses": { "101": { "description": "Switching Protocols – WebSocket connection established" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Realtime WebSocket (ad-hoc)", "tags": [ "Functions" ] } }, "/v3/realtime-sessions": { "post": { "description": "Server-to-server endpoint that mints a short-lived, single-use ticket the browser uses to open a `/v3/realtime` WebSocket. Browsers cannot set an `Authorization` header on a WebSocket constructor, so the customer's backend authenticates with its normal API key here and returns the ticket to the browser. Fields in `config` are bound to the ticket and cannot be overridden by the browser at session.start — pre-bind `model` at minimum so a leaked ticket can't be redirected to a more expensive model. To lock a field to its zero value (e.g. force `output_transcription` off), include the field name in `locked_fields`; non-listed zero values stay open for the browser to fill in.", "operationId": "createRealtimeSession", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeSessionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeSessionResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Mint realtime ephemeral ticket", "tags": [ "Functions" ] } }, "/v3/realtime/{name}": { "get": { "description": "WebSocket endpoint for realtime voice agent communication. The client must send an HTTP Upgrade request; a successful connection returns 101 Switching Protocols. OpenAPI 3.1 does not natively support WebSocket, so this is documented descriptively.", "operationId": "realtimeWebSocket", "parameters": [ { "description": "Function name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "101": { "description": "Switching Protocols – WebSocket connection established" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Realtime WebSocket", "tags": [ "Functions" ] } }, "/v3/roundtable": { "post": { "description": "Send a query to multiple models in parallel and combine results using a configurable resolution strategy (summary, fast, multiple_choice).", "operationId": "createRoundtable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoundtableRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoundtableResponse" } }, "text/event-stream": { "schema": { "description": "Server-Sent Events stream. Each event is a JSON object prefixed with 'data: '.", "type": "string" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Roundtable", "tags": [ "Roundtable" ], "x-beta": true } }, "/v3/spans": { "post": { "description": "Create a new trace span.", "operationId": "createSpan", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpanRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpanResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Create span", "tags": [ "Spans" ] } }, "/v3/spans/{id}": { "delete": { "description": "Delete a trace span.", "operationId": "deleteSpan", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Delete span", "tags": [ "Spans" ] }, "get": { "description": "Get a trace span by ID.", "operationId": "getSpan", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSpanResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get span", "tags": [ "Spans" ] }, "patch": { "description": "Update an existing trace span.", "operationId": "updateSpan", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpanRequest" } } }, "required": true }, "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Update span", "tags": [ "Spans" ] } }, "/v3/spans/{id}/events": { "get": { "description": "List events for a span.", "operationId": "listSpanEvents", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Filter by event kind (guardrail, feedback, evaluation)", "in": "query", "name": "kind", "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List span events", "tags": [ "Spans" ] }, "post": { "description": "Record an event (guardrail, feedback, evaluation) on a span.", "operationId": "createSpanEvent", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Create span event", "tags": [ "Spans" ] } }, "/v3/tools/models/resolve": { "post": { "description": "Select the best model matching the given requirements and preference.", "operationId": "resolveModel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelResolveRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelResolveResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Resolve model", "tags": [ "Tools" ], "x-beta": true } }, "/v3/tools/web/fetch": { "post": { "description": "Fetch a URL and return its content as markdown.", "operationId": "webFetch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebFetchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebFetchResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Web fetch", "tags": [ "Tools" ], "x-beta": true } }, "/v3/tools/web/search": { "post": { "description": "Search the web and return results with title, URL, and snippet.", "operationId": "webSearch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebSearchResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Web search", "tags": [ "Tools" ], "x-beta": true } }, "/v3/traces": { "get": { "description": "List traces with pagination.", "operationId": "listTraces", "parameters": [ { "description": "Max items to return (default 100, max 100)", "in": "query", "name": "limit", "schema": { "default": 100, "type": "integer" } }, { "description": "Number of items to skip (default 0)", "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } }, { "description": "Filter by trace name (case-insensitive substring match)", "in": "query", "name": "name", "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List traces", "tags": [ "Traces" ] } }, "/v3/traces/{id}": { "delete": { "description": "Delete a trace and all its spans.", "operationId": "deleteTrace", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Delete trace", "tags": [ "Traces" ] }, "get": { "description": "Get a trace with all its spans.", "operationId": "getTrace", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTraceResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Get trace", "tags": [ "Traces" ] } }, "/v3/traces/{id}/events": { "get": { "description": "List all events across all spans in a trace.", "operationId": "listTraceEvents", "parameters": [ { "description": "Generation ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Filter by event kind (guardrail, feedback, evaluation)", "in": "query", "name": "kind", "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "List trace events", "tags": [ "Traces" ] } }, "/v3/videos": { "post": { "description": "Submit a deterministic video-generation job. Returns immediately with a generation id and a status URL to poll; the video is produced asynchronously. `model` and `prompt` are required; everything in `parameters` is forwarded verbatim to the provider. `image`/`last_image`/`video`/`reference_images` accept an http(s) URL, a data-URI, or a `file_\u003cid\u003e` (resolved per provider). Output is saved to /v3/files by default and returned with a reusable `file_id` on the status poll; set `store: false` to opt out. Poll the returned `status_url` (GET /v3/artifacts/{id}/status) for a presigned download URL when complete.", "operationId": "createVideo", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "401": { "description": "Unauthorized - missing or invalid API key" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Generate a video", "tags": [ "Videos" ] } }, "/v3/videos/models": { "get": { "description": "List the models usable with `POST /v3/videos` — a `type=video` view of the model catalog. Same shape and query params as `/v3/models` (search, `include`, pagination), but always scoped to video models. Inspect each item's `capabilities` to tell input modality apart: `video_generation` is text-to-video, `image_to_video` needs a source image, and `video_editing` is video-to-video. `params.video` lists each model's accepted `aspect_ratios`, `resolutions`, and `max_duration`.", "operationId": "listVideoModels", "parameters": [ { "description": "Comma-separated list of optional fields to attach to each item. Supported: `maker` (public), `route` (requires API key), `benchmarks` (public), `policy` (requires API key — per-item comply allowlist verdict).", "in": "query", "name": "include", "schema": { "example": "maker", "type": "string" } }, { "description": "Free-text search across model ID, name, and description.", "in": "query", "name": "q", "schema": { "type": "string" } }, { "description": "Filter by provider (company) slug as published in each item's `provider.slug` (e.g. `openai`, `google`, `pruna`).", "in": "query", "name": "provider", "schema": { "type": "string" } }, { "description": "Filter by capability (repeatable), e.g. `image_to_video`. Items matching ALL listed capabilities are returned.", "in": "query", "name": "capability", "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Set to `true` to include retired models in results.", "in": "query", "name": "deprecated", "schema": { "type": "boolean" } }, { "description": "Field to sort by (`id`, `name`, `provider`, `cost`, `speed`, `quality`). Default `id`.", "in": "query", "name": "sort", "schema": { "default": "id", "type": "string" } }, { "description": "`asc` (default) or `desc`.", "in": "query", "name": "order", "schema": { "default": "asc", "type": "string" } }, { "description": "Pagination offset.", "in": "query", "name": "offset", "schema": { "default": 0, "minimum": 0, "type": "integer" } }, { "description": "Page size (max 500).", "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 500, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelsResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "security": [], "summary": "List video models", "tags": [ "Models" ] } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "description": "Production", "url": "https://api.opper.ai" }, { "description": "Local development", "url": "http://localhost:8080" } ], "tags": [ { "description": "Schema-driven function management and execution", "name": "Functions" }, { "description": "OpenAI-compatible chat completions", "name": "Chat" }, { "description": "OpenAI Responses API compatible endpoint", "name": "Responses" }, { "description": "Google-compatible interactions endpoint", "name": "Interactions" }, { "description": "Model registry and capabilities", "name": "Models" }, { "description": "Synchronous image generation", "name": "Images" }, { "description": "Text-to-speech and speech-to-text", "name": "Audio" }, { "description": "Asynchronous video generation", "name": "Videos" }, { "description": "Reusable file storage for media inputs and generated outputs", "name": "Files" }, { "description": "Async generation status and downloads", "name": "Artifacts" }, { "description": "OpenAI-compatible embeddings", "name": "Embeddings" }, { "description": "Recorded HTTP request/response generations", "name": "Generations" }, { "description": "System health and status", "name": "System" }, { "description": "Roundtable endpoint — fan out a query to multiple LLMs and combine results", "name": "Roundtable" }, { "description": "Web search, fetch, and other utility tools", "name": "Tools" }, { "description": "Caller identity, credits, and usage", "name": "Account" }, { "description": "Programmatic project and API-key management. Authenticates with an `op-mak-…` management token; available on the control_plane and enterprise plans.", "name": "Management" } ] }