{ "openapi": "3.1.0", "info": { "title": "Open4X Managed AI", "version": "2026.09.22-managed-ai.1", "description": "Requires migration 0057 and matching releases. USD only; integer accounting, final charge rounded upward to USD 0.0001. Platform admin writes, admin/finance reads; tenant session APIs are owner scoped. Authentication to an environment does not imply real provider availability." }, "servers": [ { "url": "https://api.open4x.com" } ], "paths": { "/ops/ai/upstreams": { "get": { "summary": "List upstreams (latest 200; no credentials)", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Upstream" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "managed_get_ops_ai_upstreams" } }, "/ops/ai/upstreams/{id}": { "put": { "summary": "Create/update upstream or rotate credential", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "integer" }, "key_configured": { "type": "boolean" } }, "required": [] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpstreamWrite" } } } }, "operationId": "managed_put_ops_ai_upstreams_id" } }, "/ops/ai/upstreams/{id}/test": { "post": { "summary": "Check /models connection without inference", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reachable": { "type": "boolean" }, "authenticated": { "type": "boolean" }, "upstream_status": { "type": [ "integer", "null" ] } }, "required": [] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "operationId": "managed_post_ops_ai_upstreams_id_test" } }, "/ops/ai/models": { "get": { "summary": "List configured models (latest 200)", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Model" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "managed_get_ops_ai_models" } }, "/ops/ai/models/{alias}": { "put": { "summary": "Create/update model", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Model" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelWrite" } } } }, "operationId": "managed_put_ops_ai_models_alias" } }, "/ops/ai/models/{alias}/prices": { "post": { "summary": "Publish immutable price version", "description": "", "security": [ { "Session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Model" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceWrite" } } } }, "operationId": "managed_post_ops_ai_models_alias_prices" }, "get": { "summary": "List latest 100 price versions", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceVersion" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "operationId": "managed_get_ops_ai_models_alias_prices" } }, "/ops/ai/discounts": { "get": { "summary": "List latest 200 customer offers", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "managed_get_ops_ai_discounts" }, "put": { "summary": "Create/replace one customer-model offer", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "integer" } }, "required": [] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferWrite" } } } }, "operationId": "managed_put_ops_ai_discounts" } }, "/ops/ai/requests": { "get": { "summary": "List latest 200 managed settlements", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Request" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "managed_get_ops_ai_requests" } }, "/ops/ai/requests/{id}/release": { "post": { "summary": "Release an expired/review hold with an audit reason", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "const": "failed" }, "refunded": { "type": "number" } }, "required": [] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 240 } }, "required": [ "reason" ] } } } }, "operationId": "managed_post_ops_ai_requests_id_release" } }, "/console/services/managed-ai/models": { "get": { "summary": "Customer's effective model prices", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerModel" } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "managed_get_console_services_managed_ai_models" } }, "/console/services/managed-ai/usage": { "get": { "summary": "Customer's latest 100 managed requests", "description": "", "security": [ { "Session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "service_alias": { "type": "string" }, "model_alias": { "type": "string" }, "price_id": { "type": "string" }, "status": { "type": "string", "enum": [ "reserved", "completed", "failed", "review" ] }, "reserved_units": { "type": "integer", "description": "Units of USD 0.0001" }, "final_units": { "type": [ "integer", "null" ] }, "usage_json": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": "string" } }, "required": [] } } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "operationId": "managed_get_console_services_managed_ai_usage" } }, "/console/services": { "post": { "summary": "Create/update a managed instance (service:manage)", "description": "This schema describes the managed AI branch only. Other existing services remain supported by the primary API.", "security": [ { "Session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedService" } } } }, "operationId": "managed_post_console_services" } }, "/v1/apps/ai/{alias}/v1/chat/completions": { "post": { "summary": "Invoke an enabled managed service instance", "description": "ai:invoke required. Alias restrictions use ai-model:. Same user/key duplicates return 409, not cached output. Streaming responses use SSE with [DONE]; inspect usage records for final charge. No cross-provider fallback. Managed models may not accept every BYOK parameter.", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } }, "text/event-stream": { "schema": { "type": "string" } } }, "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "X-Open4X-Price-Version": { "schema": { "type": "string" } }, "X-OpenEdge-Estimated-Cost": { "schema": { "type": "string" } }, "X-OpenEdge-Final-Cost": { "description": "JSON only. Query settlement for SSE.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient available balance; no provider call", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "operationId": "managed_post_v1_apps_ai_alias_v1_chat_completions" } }, "/v1/apps/ai/{alias}/chat/completions": { "post": { "summary": "Invoke an enabled managed service instance", "description": "ai:invoke required. Alias restrictions use ai-model:. Same user/key duplicates return 409, not cached output. Streaming responses use SSE with [DONE]; inspect usage records for final charge. No cross-provider fallback. Managed models may not accept every BYOK parameter.", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } }, "text/event-stream": { "schema": { "type": "string" } } }, "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "X-Open4X-Price-Version": { "schema": { "type": "string" } }, "X-OpenEdge-Estimated-Cost": { "schema": { "type": "string" } }, "X-OpenEdge-Final-Cost": { "description": "JSON only. Query settlement for SSE.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient available balance; no provider call", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "operationId": "managed_post_v1_apps_ai_alias_chat_completions" } }, "/v1/apps/ai/{alias}/chat": { "post": { "summary": "Invoke an enabled managed service instance", "description": "ai:invoke required. Alias restrictions use ai-model:. Same user/key duplicates return 409, not cached output. Streaming responses use SSE with [DONE]; inspect usage records for final charge. No cross-provider fallback. Managed models may not accept every BYOK parameter.", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } }, "text/event-stream": { "schema": { "type": "string" } } }, "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "X-Open4X-Price-Version": { "schema": { "type": "string" } }, "X-OpenEdge-Estimated-Cost": { "schema": { "type": "string" } }, "X-OpenEdge-Final-Cost": { "description": "JSON only. Query settlement for SSE.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient available balance; no provider call", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "operationId": "managed_post_v1_apps_ai_alias_chat" } }, "/v1/apps/ai/{alias}/chat/stream": { "post": { "summary": "Invoke an enabled managed service instance", "description": "ai:invoke required. Alias restrictions use ai-model:. Same user/key duplicates return 409, not cached output. Streaming responses use SSE with [DONE]; inspect usage records for final charge. No cross-provider fallback. Managed models may not accept every BYOK parameter.", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } }, "text/event-stream": { "schema": { "type": "string" } } }, "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "X-Open4X-Price-Version": { "schema": { "type": "string" } }, "X-OpenEdge-Estimated-Cost": { "schema": { "type": "string" } }, "X-OpenEdge-Final-Cost": { "description": "JSON only. Query settlement for SSE.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient available balance; no provider call", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chat" } } } }, "operationId": "managed_post_v1_apps_ai_alias_chat_stream" } }, "/v1/apps/ai/{alias}/v1/embeddings": { "post": { "summary": "Invoke an enabled managed service instance", "description": "ai:invoke required. Alias restrictions use ai-model:. Same user/key duplicates return 409, not cached output. Streaming responses use SSE with [DONE]; inspect usage records for final charge. No cross-provider fallback. Managed models may not accept every BYOK parameter.", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } }, "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "X-Open4X-Price-Version": { "schema": { "type": "string" } }, "X-OpenEdge-Estimated-Cost": { "schema": { "type": "string" } }, "X-OpenEdge-Final-Cost": { "description": "JSON only. Query settlement for SSE.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient available balance; no provider call", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Embeddings" } } } }, "operationId": "managed_post_v1_apps_ai_alias_v1_embeddings" } }, "/v1/apps/ai/{alias}/embeddings": { "post": { "summary": "Invoke an enabled managed service instance", "description": "ai:invoke required. Alias restrictions use ai-model:. Same user/key duplicates return 409, not cached output. Streaming responses use SSE with [DONE]; inspect usage records for final charge. No cross-provider fallback. Managed models may not accept every BYOK parameter.", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } }, "headers": { "X-Request-ID": { "schema": { "type": "string" } }, "X-Open4X-Price-Version": { "schema": { "type": "string" } }, "X-OpenEdge-Estimated-Cost": { "schema": { "type": "string" } }, "X-OpenEdge-Final-Cost": { "description": "JSON only. Query settlement for SSE.", "schema": { "type": "string" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Insufficient available balance; no provider call", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Embeddings" } } } }, "operationId": "managed_post_v1_apps_ai_alias_embeddings" } }, "/v1/apps/ai/{alias}/v1/models": { "get": { "summary": "List the instance's public model", "description": "", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "operationId": "managed_get_v1_apps_ai_alias_v1_models" } }, "/v1/apps/ai/{alias}/models": { "get": { "summary": "List the instance's public model", "description": "", "security": [ { "ApiKey": [] }, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient role or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Stale revision, below-cost confirmation, budget cap, or duplicate key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Concurrency or API key limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Provider failure; reservation released", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Environment, billing or configuration unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$" } } ], "operationId": "managed_get_v1_apps_ai_alias_models" } } }, "components": { "securitySchemes": { "Session": { "type": "http", "scheme": "bearer", "description": "Console login JWT. Platform administrator required for /ops writes; administrator or finance for reads." }, "ApiKey": { "type": "http", "scheme": "bearer", "description": "Open4X API key with ai:invoke scope and allowed service alias." }, "ApiKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "schemas": { "Rates": { "type": "object", "properties": { "input": { "type": "number", "minimum": 0, "maximum": 1000000, "multipleOf": 0.000001 }, "output": { "type": "number", "minimum": 0, "maximum": 1000000, "multipleOf": 0.000001 }, "cached_input": { "type": "number", "minimum": 0, "maximum": 1000000, "multipleOf": 0.000001 }, "request": { "type": "number", "minimum": 0, "maximum": 1000000, "multipleOf": 0.000001 } }, "required": [ "input", "output", "cached_input", "request" ], "additionalProperties": false }, "UpstreamWrite": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0 }, "name": { "type": "string", "maxLength": 120 }, "base_url": { "type": "string", "format": "uri", "description": "Direct HTTPS inference base URL; no query, credentials, fragment or Open4X gateway loop." }, "auth_type": { "type": "string", "enum": [ "bearer", "x-api-key" ] }, "api_key": { "type": "string", "writeOnly": true, "maxLength": 4096, "description": "Required on create or URL change; omit to keep the key." }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "timeout_ms": { "type": "integer", "minimum": 1000, "maximum": 120000 }, "concurrency_limit": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": [ "version", "name", "base_url", "auth_type", "status", "timeout_ms", "concurrency_limit" ] }, "ModelWrite": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0 }, "display_name": { "type": "string" }, "upstream_id": { "type": "string" }, "upstream_model": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "chat", "chat_stream", "embeddings" ] }, "minItems": 1 }, "status": { "type": "string", "enum": [ "draft", "active", "inactive" ] }, "max_input_tokens": { "type": "integer", "minimum": 1, "maximum": 131072 }, "max_output_tokens": { "type": "integer", "minimum": 1, "maximum": 32768 } }, "required": [ "version", "display_name", "upstream_id", "upstream_model", "capabilities", "status", "max_input_tokens", "max_output_tokens" ] }, "Upstream": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0 }, "name": { "type": "string", "maxLength": 120 }, "base_url": { "type": "string", "format": "uri", "description": "Direct HTTPS inference base URL; no query, credentials, fragment or Open4X gateway loop." }, "auth_type": { "type": "string", "enum": [ "bearer", "x-api-key" ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "timeout_ms": { "type": "integer", "minimum": 1000, "maximum": 120000 }, "concurrency_limit": { "type": "integer", "minimum": 1, "maximum": 1000 }, "id": { "type": "string" }, "key_configured": { "type": "boolean" }, "updated_at": { "type": "string" } }, "required": [] }, "Model": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0 }, "display_name": { "type": "string" }, "upstream_id": { "type": "string" }, "upstream_model": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "chat", "chat_stream", "embeddings" ] }, "minItems": 1 }, "status": { "type": "string", "enum": [ "draft", "active", "inactive" ] }, "max_input_tokens": { "type": "integer", "minimum": 1, "maximum": 131072 }, "max_output_tokens": { "type": "integer", "minimum": 1, "maximum": 32768 }, "alias": { "type": "string" }, "current_price_id": { "type": [ "string", "null" ] }, "price_version": { "type": "integer" }, "rates": { "anyOf": [ { "$ref": "#/components/schemas/Rates" }, { "type": "null" } ] }, "cost_rates": { "anyOf": [ { "$ref": "#/components/schemas/Rates" }, { "type": "null" } ] } }, "required": [] }, "PriceWrite": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1, "description": "Current model revision, not price revision." }, "rates": { "$ref": "#/components/schemas/Rates" }, "cost_rates": { "$ref": "#/components/schemas/Rates" }, "allow_below_cost": { "type": "boolean", "default": false } }, "required": [ "version", "rates", "cost_rates" ] }, "OfferWrite": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0 }, "user_id": { "type": "integer", "minimum": 1 }, "model_alias": { "type": "string" }, "kind": { "type": "string", "enum": [ "discount", "contract" ] }, "multiplier_bps": { "type": "integer", "minimum": 0, "maximum": 10000, "description": "8000 = pay 80%. Ignored for contracts." }, "rates": { "$ref": "#/components/schemas/Rates" }, "starts_at": { "type": "string", "format": "date-time" }, "expires_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "allow_below_cost": { "type": "boolean", "default": false } }, "required": [ "version", "user_id", "model_alias", "kind", "starts_at", "expires_at", "status" ] }, "Offer": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "integer" }, "model_alias": { "type": "string" }, "kind": { "type": "string", "enum": [ "discount", "contract" ] }, "multiplier_bps": { "type": "integer" }, "rates_json": { "type": [ "string", "null" ] }, "version": { "type": "integer" }, "starts_at": { "type": "string" }, "expires_at": { "type": "string" }, "status": { "type": "string" } }, "required": [] }, "PriceVersion": { "type": "object", "properties": { "id": { "type": "string" }, "model_alias": { "type": "string" }, "version": { "type": "integer" }, "currency": { "const": "USD" }, "rates_json": { "type": "string" }, "cost_rates_json": { "type": "string" }, "created_by": { "type": "integer" }, "created_at": { "type": "string" } }, "required": [] }, "Request": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "integer" }, "service_alias": { "type": "string" }, "model_alias": { "type": "string" }, "upstream_id": { "type": "string" }, "price_id": { "type": "string" }, "status": { "type": "string", "enum": [ "reserved", "completed", "failed", "review" ] }, "reserved_units": { "type": "integer", "description": "Units of USD 0.0001" }, "final_units": { "type": [ "integer", "null" ] }, "usage_json": { "type": [ "string", "null" ] }, "provider_cost": { "type": [ "number", "null" ], "description": "Configured supplier-cost estimate in USD, not an invoice" }, "error_code": { "type": [ "string", "null" ] }, "lease_until": { "type": "string" }, "created_at": { "type": "string" } }, "required": [] }, "CustomerModel": { "type": "object", "properties": { "alias": { "type": "string" }, "display_name": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "chat", "chat_stream", "embeddings" ] }, "minItems": 1 }, "max_input_tokens": { "type": "integer" }, "max_output_tokens": { "type": "integer" }, "price": { "type": "object", "properties": { "price_id": { "type": "string" }, "version": { "type": "integer" }, "currency": { "const": "USD" }, "rates": { "$ref": "#/components/schemas/Rates" }, "multiplier_bps": { "type": "integer" }, "discount_id": { "type": [ "string", "null" ] }, "discount_version": { "type": [ "integer", "null" ] }, "ledger_quantum_usd": { "const": 0.0001 }, "rounding": { "const": "ceil_per_request" } }, "required": [] } }, "required": [] }, "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "ManagedService": { "type": "object", "properties": { "service_id": { "const": "ai-model" }, "alias": { "type": "string" }, "config": { "type": "object", "properties": { "mode": { "const": "managed" }, "model_alias": { "type": "string" }, "max_cost_per_request": { "type": ["number", "null"], "description": "Positive USD cap; null explicitly clears a previously saved cap.", "exclusiveMinimum": 0 } }, "required": [ "mode", "model_alias" ] } }, "required": [ "service_id", "alias", "config" ] }, "Chat": { "type": "object", "properties": { "model": { "type": "string", "description": "Configured public alias only" }, "messages": { "type": "array", "minItems": 1, "maxItems": 200, "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" } }, "required": [ "role", "content" ], "additionalProperties": false } }, "stream": { "type": "boolean" }, "stream_options": { "type": "object", "description": "Managed streaming always requests include_usage=true from the upstream.", "properties": { "include_usage": { "type": "boolean" } }, "additionalProperties": false }, "max_tokens": { "type": "integer", "minimum": 1, "maximum": 32768 }, "max_completion_tokens": { "type": "integer", "minimum": 1, "maximum": 32768 }, "temperature": { "type": "number", "minimum": 0, "maximum": 2 }, "top_p": { "type": "number", "minimum": 0, "maximum": 1 }, "max_cost": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "messages" ] }, "Embeddings": { "type": "object", "properties": { "model": { "type": "string" }, "input": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 128 } ] }, "encoding_format": { "type": "string", "enum": [ "float", "base64" ] }, "max_cost": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "input" ] } } } }