{ "info": { "title": "sference API", "version": "0.0.1" }, "openapi": "3.1.0", "servers": [ { "url": "/" } ], "paths": { "/v1/health": { "get": { "summary": "Health", "operationId": "V1HealthHealth", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } } } }, "deprecated": false }, "head": { "summary": "HealthHead", "operationId": "V1HealthHealthHead", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {} } }, "deprecated": false } }, "/v1/health/ready": { "get": { "summary": "Ready", "operationId": "V1HealthReadyReady", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } } } }, "deprecated": false }, "head": { "summary": "ReadyHead", "operationId": "V1HealthReadyReadyHead", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {} } }, "deprecated": false } }, "/control/v1/auth/api-keys": { "get": { "summary": "ListApiKeys", "operationId": "ControlV1AuthApiKeysListApiKeys", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyListResponse" } } } } }, "deprecated": false }, "post": { "summary": "CreateApiKey", "operationId": "ControlV1AuthApiKeysCreateApiKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/forgot-password": { "post": { "summary": "ForgotPassword", "operationId": "ControlV1AuthForgotPasswordForgotPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/link-oauth": { "post": { "summary": "LinkOauth", "operationId": "ControlV1AuthLinkOauthLinkOauth", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthCompleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkOAuthResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/linked-accounts": { "get": { "summary": "LinkedAccounts", "operationId": "ControlV1AuthLinkedAccountsLinkedAccounts", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccountsResponse" } } } } }, "deprecated": false } }, "/control/v1/auth/login": { "post": { "summary": "Login", "operationId": "ControlV1AuthLoginLogin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/me": { "get": { "summary": "Me", "operationId": "ControlV1AuthMeMe", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "deprecated": false } }, "/control/v1/auth/oauth/complete": { "post": { "summary": "OauthComplete", "operationId": "ControlV1AuthOauthCompleteOauthComplete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthCompleteRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/reset-password": { "post": { "summary": "ResetPassword", "operationId": "ControlV1AuthResetPasswordResetPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/api-keys/{key_id}": { "delete": { "summary": "RevokeApiKey", "operationId": "ControlV1AuthApiKeysKeyIdRevokeApiKey", "parameters": [ { "name": "key_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "204": { "description": "Request fulfilled, nothing follows", "headers": {} }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/signup": { "post": { "summary": "Signup", "operationId": "ControlV1AuthSignupSignup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/linked-accounts/{provider}": { "delete": { "summary": "UnlinkOauth", "operationId": "ControlV1AuthLinkedAccountsProviderUnlinkOauth", "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true, "deprecated": false } ], "responses": { "204": { "description": "Request fulfilled, nothing follows", "headers": {} }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/auth/verify-email": { "post": { "summary": "VerifyEmail", "operationId": "ControlV1AuthVerifyEmailVerifyEmail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/auth/me": { "get": { "summary": "Me", "operationId": "V1AuthMeMe", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "deprecated": false } }, "/v1/batches/{batch_id}/cancel": { "post": { "summary": "CancelBatch", "operationId": "V1BatchesBatchIdCancelCancelBatch", "parameters": [ { "name": "batch_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/batches": { "get": { "summary": "ListBatches", "operationId": "V1BatchesListBatches", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchListResponse" } } } } }, "deprecated": false }, "post": { "summary": "CreateBatch", "operationId": "V1BatchesCreateBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/batches/{batch_id}": { "get": { "summary": "GetBatch", "operationId": "V1BatchesBatchIdGetBatch", "parameters": [ { "name": "batch_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/batches/{batch_id}/results": { "get": { "summary": "GetResults", "operationId": "V1BatchesBatchIdResultsGetResults", "parameters": [ { "name": "batch_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchResultsResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/batches/{batch_id}/results.jsonl": { "get": { "summary": "GetResultsJsonl", "operationId": "V1BatchesBatchIdResultsJsonlGetResultsJsonl", "parameters": [ { "name": "batch_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/billing/invoices": { "post": { "summary": "CreateInvoice", "operationId": "ControlV1BillingInvoicesCreateInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreateResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/billing/topups": { "post": { "summary": "CreateTopup", "operationId": "ControlV1BillingTopupsCreateTopup", "parameters": [ { "name": "nonce", "in": "query", "schema": { "type": "string", "description": "Client-generated nonce to stabilize idempotency." }, "description": "Client-generated nonce to stabilize idempotency.", "required": true, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopupCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopupCreateResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/billing/summary": { "get": { "summary": "GetSummary", "operationId": "ControlV1BillingSummaryGetSummary", "parameters": [ { "name": "days", "in": "query", "schema": { "type": "integer", "maximum": 365.0, "minimum": 1.0, "default": 30 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSummaryResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/billing/transactions": { "get": { "summary": "GetTransactions", "operationId": "ControlV1BillingTransactionsGetTransactions", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "default": 25 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "starting_after", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerListResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/teams/me/members": { "post": { "summary": "AddMember", "operationId": "ControlV1TeamsMeMembersAddMember", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAddMemberRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberItem" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/teams/me": { "get": { "summary": "GetMe", "operationId": "ControlV1TeamsMeGetMe", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMeResponse" } } } } }, "deprecated": false }, "patch": { "summary": "UpdateMe", "operationId": "ControlV1TeamsMeUpdateMe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMeResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/teams/me/members/{user_id}": { "delete": { "summary": "RemoveMember", "operationId": "ControlV1TeamsMeMembersUserIdRemoveMember", "parameters": [ { "name": "user_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "204": { "description": "Request fulfilled, nothing follows", "headers": {} }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false }, "patch": { "summary": "UpdateMemberRole", "operationId": "ControlV1TeamsMeMembersUserIdUpdateMemberRole", "parameters": [ { "name": "user_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberRoleUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberItem" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/activity/{request_id}": { "get": { "summary": "GetActivityDetail", "operationId": "ControlV1ActivityRequestIdGetActivityDetail", "parameters": [ { "name": "request_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityItemDetail" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/activity": { "get": { "summary": "ListActivity", "operationId": "ControlV1ActivityListActivity", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1.0, "default": 1 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "page_size", "in": "query", "schema": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "default": 25 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "type", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "status", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "model", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "created_after", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "created_before", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "api_key_id", "in": "query", "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Filter activity to one API key" }, "description": "Filter activity to one API key", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "user_id", "in": "query", "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Team admins: filter activity to one member" }, "description": "Team admins: filter activity to one member", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityListResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/activity/models": { "get": { "summary": "ListModels", "operationId": "ControlV1ActivityModelsListModels", "parameters": [ { "name": "user_id", "in": "query", "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Team admins: filter models to one member" }, "description": "Team admins: filter models to one member", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/models/custom": { "post": { "summary": "CreateCustomModel", "operationId": "ControlV1ModelsCustomCreateCustomModel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomModelCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogModelResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false }, "delete": { "summary": "DeleteCustomModel", "operationId": "ControlV1ModelsCustomDeleteCustomModel", "parameters": [ { "name": "model_id", "in": "query", "schema": { "type": "string", "description": "Custom model id (e.g. org/name)" }, "description": "Custom model id (e.g. org/name)", "required": true, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "204": { "description": "Request fulfilled, nothing follows", "headers": {} }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/models/catalog": { "get": { "summary": "GetCatalog", "operationId": "ControlV1ModelsCatalogGetCatalog", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogListResponse" } } } } }, "deprecated": false } }, "/control/v1/models/request-deployment": { "post": { "summary": "RequestModelDeployment", "operationId": "ControlV1ModelsRequestDeploymentRequestModelDeployment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDeploymentRequestBody" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDeploymentRequestResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/models/search": { "get": { "summary": "SearchModels", "operationId": "ControlV1ModelsSearchSearchModels", "parameters": [ { "name": "q", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by model id, display name, or provider" }, "description": "Filter by model id, display name, or provider", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "modality", "in": "query", "schema": { "type": "string", "default": "text_generation" }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "status", "in": "query", "schema": { "type": "string", "description": "One of: \"available\", \"coming_soon\", \"deprecated\", \"all\"", "default": "all" }, "description": "One of: \"available\", \"coming_soon\", \"deprecated\", \"all\"", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelSearchResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/deployments": { "get": { "summary": "ListDeployments", "operationId": "ControlV1DeploymentsListDeployments", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentListResponse" } } } } }, "deprecated": false }, "post": { "summary": "CreateDeployment", "operationId": "ControlV1DeploymentsCreateDeployment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/deployments/{deployment_id}": { "delete": { "summary": "DeleteDeployment", "operationId": "ControlV1DeploymentsDeploymentIdDeleteDeployment", "parameters": [ { "name": "deployment_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "204": { "description": "Request fulfilled, nothing follows", "headers": {} }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/responses/{response_id}": { "get": { "summary": "GetResponse", "operationId": "V1ResponsesResponseIdGetResponse", "parameters": [ { "name": "response_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseItem" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false }, "delete": { "summary": "CancelResponse", "operationId": "V1ResponsesResponseIdCancelResponse", "parameters": [ { "name": "response_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseItem" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/responses": { "get": { "summary": "ListResponses", "operationId": "V1ResponsesListResponses", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 100 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "stream_id", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseList" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false }, "post": { "summary": "CreateResponse", "operationId": "V1ResponsesCreateResponse", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ResponseItem" }, {} ] } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/responses/events": { "get": { "summary": "ListResponseEvents", "operationId": "V1ResponsesEventsListResponseEvents", "parameters": [ { "name": "stream_id", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "starting_after", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "ending_before", "in": "query", "schema": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "wait_ms", "in": "query", "schema": { "type": "integer", "default": 0 }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamEventListResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/chat/completions": { "post": { "summary": "CreateChatCompletion", "operationId": "V1ChatCompletionsCreateChatCompletion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, {} ] } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/embeddings": { "post": { "summary": "CreateEmbedding", "operationId": "V1EmbeddingsCreateEmbedding", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmbeddingRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "additionalProperties": {}, "type": "object" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/messages": { "post": { "summary": "CreateMessage", "operationId": "V1MessagesCreateMessage", "parameters": [ { "name": "beta", "in": "query", "schema": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnthropicMessagesCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, {} ] } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/models": { "get": { "summary": "ListModels", "operationId": "V1ModelsListModels", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/V1ModelListResponse" }, { "$ref": "#/components/schemas/AnthropicModelListResponse" } ] } } } } }, "deprecated": false } }, "/v1/streams": { "get": { "summary": "ListStreams", "operationId": "V1StreamsListStreams", "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamListResponse" } } } } }, "deprecated": false }, "post": { "summary": "CreateStream", "operationId": "V1StreamsCreateStream", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamDetailResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/v1/streams/{stream_id}": { "get": { "summary": "GetStream", "operationId": "V1StreamsStreamIdGetStream", "parameters": [ { "name": "stream_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamDetailResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false }, "patch": { "summary": "PatchStream", "operationId": "V1StreamsStreamIdPatchStream", "parameters": [ { "name": "stream_id", "in": "path", "schema": { "type": "string", "format": "uuid" }, "required": true, "deprecated": false } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamDetailResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/usage/daily": { "get": { "summary": "GetDaily", "operationId": "ControlV1UsageDailyGetDaily", "parameters": [ { "name": "days", "in": "query", "schema": { "type": "integer", "maximum": 365.0, "minimum": 1.0, "description": "Number of days to look back", "default": 30 }, "description": "Number of days to look back", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "user_id", "in": "query", "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Team admins: filter usage to one member" }, "description": "Team admins: filter usage to one member", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageDailyResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/control/v1/usage/summary": { "get": { "summary": "GetSummary", "operationId": "ControlV1UsageSummaryGetSummary", "parameters": [ { "name": "days", "in": "query", "schema": { "type": "integer", "maximum": 365.0, "minimum": 1.0, "description": "Number of days to look back", "default": 30 }, "description": "Number of days to look back", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false }, { "name": "user_id", "in": "query", "schema": { "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Team admins: filter usage to one member" }, "description": "Team admins: filter usage to one member", "required": false, "deprecated": false, "allowEmptyValue": false, "allowReserved": false } ], "responses": { "200": { "description": "Request fulfilled, document follows", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummaryResponse" } } } }, "400": { "description": "Bad request syntax or unsupported method", "content": { "application/json": { "schema": { "properties": { "status_code": { "type": "integer" }, "detail": { "type": "string" }, "extra": { "additionalProperties": {}, "type": [ "null", "object", "array" ] } }, "type": "object", "required": [ "detail", "status_code" ], "description": "Validation Exception", "examples": [ { "status_code": 400, "detail": "Bad Request", "extra": {} } ] } } } } }, "deprecated": false } }, "/public/v1/webhooks/stripe": { "post": { "summary": "StripeWebhook", "operationId": "PublicV1WebhooksStripeStripeWebhook", "responses": { "201": { "description": "Document created, URL follows", "headers": {}, "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } } } }, "deprecated": false } } }, "components": { "schemas": { "ActivityItem": { "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed", "cancelled" ] }, "model": { "type": "string" }, "custom_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "standalone", "batch", "stream" ] }, "batch_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "stream_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "prompt_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "completion_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "total_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "cached_prompt_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "cost_micros": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "error": { "oneOf": [ { "type": "object" }, { "type": "null" } ] }, "api_key_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key_name": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "api_key_prefix": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "created_at", "id", "model", "status", "type" ], "title": "ActivityItem" }, "ActivityItemDetail": { "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed", "cancelled" ] }, "model": { "type": "string" }, "custom_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "standalone", "batch", "stream" ] }, "batch_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "stream_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "completed_at": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "prompt_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "completion_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "total_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "cached_prompt_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "cost_micros": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "body_json": { "type": "object" }, "result_json": { "oneOf": [ { "type": "object" }, { "type": "null" } ] }, "error_json": { "oneOf": [ { "type": "object" }, { "type": "null" } ] } }, "type": "object", "required": [ "body_json", "created_at", "id", "model", "status", "type" ], "title": "ActivityItemDetail" }, "ActivityListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ActivityItem" }, "type": "array" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object", "required": [ "items", "page", "page_size", "total" ], "title": "ActivityListResponse" }, "AnthropicMessage": { "properties": { "role": { "type": "string", "enum": [ "user", "assistant", "system" ] }, "content": { "oneOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/AnthropicTextBlock" }, "type": "array" }, { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" } ] } }, "type": "object", "required": [ "content", "role" ], "title": "AnthropicMessage" }, "AnthropicMessagesCreateRequest": { "properties": { "model": { "type": "string" }, "max_tokens": { "type": "integer" }, "messages": { "items": { "$ref": "#/components/schemas/AnthropicMessage" }, "type": "array" }, "system": { "oneOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/AnthropicTextBlock" }, "type": "array" }, { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "stop_sequences": { "oneOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "stream": { "type": "boolean", "default": false }, "temperature": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "top_p": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "top_k": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "tools": { "oneOf": [ { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "tool_choice": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "string" }, { "type": "null" } ] }, "thinking": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "null" } ] }, "enable_thinking": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "type": "object", "required": [ "max_tokens", "messages", "model" ], "title": "AnthropicMessagesCreateRequest" }, "AnthropicModelItemResponse": { "properties": { "id": { "type": "string" }, "type": { "type": "string", "const": "model", "default": "model" }, "display_name": { "type": "string" }, "created_at": { "type": "string" }, "max_input_tokens": { "type": "integer" }, "max_tokens": { "type": "integer" }, "capabilities": { "$ref": "#/components/schemas/ModelCapabilities" } }, "type": "object", "required": [ "created_at", "display_name", "id", "max_input_tokens", "max_tokens" ], "title": "AnthropicModelItemResponse" }, "AnthropicModelListResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AnthropicModelItemResponse" }, "type": "array" }, "first_id": { "type": "string" }, "has_more": { "type": "boolean", "default": false }, "last_id": { "type": "string" } }, "type": "object", "required": [ "data", "first_id", "last_id" ], "title": "AnthropicModelListResponse" }, "AnthropicTextBlock": { "properties": { "type": { "type": "string", "const": "text" }, "text": { "type": "string" } }, "type": "object", "required": [ "text", "type" ], "title": "AnthropicTextBlock" }, "ApiKeyCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 1 } }, "type": "object", "required": [ "name" ], "title": "ApiKeyCreateRequest" }, "ApiKeyCreateResponse": { "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "plaintext": { "type": "string" }, "prefix": { "type": "string" }, "created_at": { "type": "string" } }, "type": "object", "required": [ "created_at", "id", "name", "plaintext", "prefix" ], "title": "ApiKeyCreateResponse" }, "ApiKeyItemResponse": { "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "created_at": { "type": "string" }, "revoked_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "created_at", "id", "name", "prefix" ], "title": "ApiKeyItemResponse" }, "ApiKeyListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ApiKeyItemResponse" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "ApiKeyListResponse" }, "BatchCreateRequest": { "properties": { "window": { "type": "string", "const": "24h", "description": "Completion window for every row in the batch (`\"24h\"` is the only supported value).", "default": "24h" }, "requests": { "items": { "$ref": "#/components/schemas/InferenceRequest" }, "type": "array", "minItems": 1, "description": "One or more inference rows sharing the same `body.model`. Each `body` is normalized to chat-completions shape at create (Responses `input` \u2192 `messages`), validated, then enqueued. Invalid rows return HTTP 400 with `requests[i]` and optional `custom_id`." } }, "type": "object", "required": [ "requests" ], "title": "BatchCreateRequest" }, "BatchListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BatchResponse" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "BatchListResponse" }, "BatchResponse": { "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed", "cancelled" ] }, "window": { "type": "string", "const": "24h" }, "request_count": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "completed_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "total_prompt_tokens": { "type": "integer", "default": 0 }, "total_completion_tokens": { "type": "integer", "default": 0 }, "total_tokens": { "type": "integer", "default": 0 }, "total_cost_micros": { "type": "integer", "default": 0 } }, "type": "object", "required": [ "created_at", "id", "request_count", "status", "updated_at", "window" ], "title": "BatchResponse" }, "BatchResultsResponse": { "properties": { "batch_id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed", "cancelled" ] }, "output_url": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "completed_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "results": { "oneOf": [ { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, { "type": "null" } ], "description": "Per-request outcomes when batch is completed or failed." } }, "type": "object", "required": [ "batch_id", "status" ], "title": "BatchResultsResponse" }, "BillingModelSummary": { "properties": { "model": { "type": "string" }, "service_tier": { "type": "string", "default": "default" }, "prompt_tokens": { "type": "integer" }, "completion_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "cached_prompt_tokens": { "type": "integer", "default": 0 }, "total_requests": { "type": "integer" }, "cost_micros": { "type": "integer" }, "pricing": { "oneOf": [ { "$ref": "#/components/schemas/PricingInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "completion_tokens", "cost_micros", "model", "prompt_tokens", "total_requests", "total_tokens" ], "title": "BillingModelSummary" }, "BillingSummary": { "properties": { "days": { "type": "integer" }, "total_prompt_tokens": { "type": "integer" }, "total_completion_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "total_cached_prompt_tokens": { "type": "integer", "default": 0 }, "total_requests": { "type": "integer" }, "estimated_cost_micros": { "type": "integer" }, "credit_balance_micros": { "type": "integer" } }, "type": "object", "required": [ "credit_balance_micros", "days", "estimated_cost_micros", "total_completion_tokens", "total_prompt_tokens", "total_requests", "total_tokens" ], "title": "BillingSummary" }, "BillingSummaryResponse": { "properties": { "summary": { "$ref": "#/components/schemas/BillingSummary" }, "by_model": { "items": { "$ref": "#/components/schemas/BillingModelSummary" }, "type": "array" } }, "type": "object", "required": [ "by_model", "summary" ], "title": "BillingSummaryResponse" }, "CapabilityFlag": { "properties": { "supported": { "type": "boolean", "default": false } }, "type": "object", "required": [], "title": "CapabilityFlag" }, "CatalogListResponse": { "properties": { "models": { "items": { "$ref": "#/components/schemas/CatalogModelResponse" }, "type": "array" } }, "type": "object", "required": [ "models" ], "title": "CatalogListResponse" }, "CatalogModelResponse": { "properties": { "id": { "type": "string" }, "display_name": { "type": "string" }, "provider": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "platform_status": { "type": "string", "enum": [ "available", "coming_soon", "deprecated" ] }, "modality": { "type": "string" }, "context_tokens": { "type": "integer" }, "released": { "type": "string" }, "deprecated": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "input_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "output_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "cached_input_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "tpm_limit": { "type": "string", "default": "unlimited" }, "rpm_limit": { "type": "string", "default": "unlimited" }, "requests_per_hour": { "type": "string", "default": "\u2014" }, "deployed_on_platform": { "type": "boolean" }, "capabilities": { "$ref": "#/components/schemas/ModelCapabilities" }, "ownership": { "type": "string", "enum": [ "platform", "custom" ], "default": "platform" }, "deploy_status": { "type": [ "null", "string" ], "enum": [ "pending_deploy", "deploying", "available", "rejected", "failed", null ] }, "architecture": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "has_hf_token": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "status_reason": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "context_tokens", "deployed_on_platform", "display_name", "id", "modality", "platform_status", "released" ], "title": "CatalogModelResponse" }, "ChatCompletionCreateRequest": { "properties": { "model": { "type": "string" }, "messages": { "items": { "$ref": "#/components/schemas/ChatMessage" }, "type": "array" }, "temperature": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "top_p": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "presence_penalty": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "maximum": 2.0, "minimum": -2.0 }, "frequency_penalty": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "maximum": 2.0, "minimum": -2.0 }, "max_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "max_completion_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "top_k": { "oneOf": [ { "type": "integer" }, { "type": "null" } ], "minimum": -1 }, "min_p": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "maximum": 1.0 }, "repetition_penalty": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "maximum": 2.0 }, "stop": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "seed": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "stream": { "type": "boolean", "default": false }, "stream_options": { "oneOf": [ { "$ref": "#/components/schemas/StreamOptions" }, { "type": "null" } ] }, "tools": { "oneOf": [ { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "tool_choice": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "string" }, { "type": "null" } ] }, "response_format": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "null" } ] }, "reasoning_effort": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "enable_thinking": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "prompt_cache_key": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable identifier for a sequence of requests that share a long prefix (a chat session, an agent loop). Requests with the same key are routed to the same worker while it stays warm, so the shared prefix is served from its prompt cache. Without it, placement is inferred from the message text." }, "service_tier": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Processing tier for the request. `\"flex\"` selects flex processing (beta) on flex-enabled accounts: discounted tokens in exchange for lower scheduling priority and best-effort completion \u2014 the request may queue significantly longer than default-tier requests, so raise your client timeout accordingly. A flex request that cannot complete in time fails with 408 (OpenAI SDKs retry it automatically). All other accepted values (`auto`, `default`, `scale`, `priority`) are served at the default tier. Responses echo the tier actually served in `service_tier`." } }, "type": "object", "required": [ "messages", "model" ], "title": "ChatCompletionCreateRequest" }, "ChatMessage": { "properties": { "role": { "type": "string" }, "content": { "oneOf": [ { "type": "string" }, { "items": {}, "type": "array" }, { "type": "null" } ] }, "tool_calls": { "oneOf": [ { "items": {}, "type": "array" }, { "type": "null" } ] }, "tool_call_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "reasoning_content": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "role" ], "title": "ChatMessage" }, "CreateEmbeddingRequest": { "properties": { "model": { "type": "string" }, "input": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "items": { "type": "integer" }, "type": "array" }, { "items": { "items": { "type": "integer" }, "type": "array" }, "type": "array" } ] }, "encoding_format": { "type": "string", "enum": [ "float", "base64" ], "default": "float" }, "dimensions": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "user": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "input", "model" ], "title": "CreateEmbeddingRequest" }, "CustomModelCreateRequest": { "properties": { "model_id": { "type": "string", "maxLength": 512, "minLength": 1 }, "display_name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 512 }, "modality": { "type": "string", "enum": [ "text_generation", "text_embedding" ], "default": "text_generation" }, "architecture": { "type": "string", "enum": [ "qwen", "llama", "kimi", "glm", "deepseek", "minimax", "gemma", "gpt_oss", "custom" ] }, "architecture_detail": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 1024 }, "artifact_type": { "type": "string", "enum": [ "full", "lora" ], "default": "full" }, "base_model_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 512 }, "hf_repo": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 512 }, "hf_revision": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 256 }, "private_repo": { "type": "boolean", "default": false }, "hf_token": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 2048 }, "notes": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 4000 } }, "type": "object", "required": [ "architecture", "model_id" ], "title": "CustomModelCreateRequest" }, "DailyUsage": { "properties": { "date": { "type": "string" }, "model": { "type": "string" }, "prompt_tokens": { "type": "integer" }, "completion_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "cached_prompt_tokens": { "type": "integer", "default": 0 }, "request_count": { "type": "integer" }, "cost_micros": { "type": "integer", "default": 0 } }, "type": "object", "required": [ "completion_tokens", "date", "model", "prompt_tokens", "request_count", "total_tokens" ], "title": "DailyUsage" }, "DeploymentCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1 }, "model_source": { "type": "string", "enum": [ "platform", "custom" ] }, "model_id": { "type": "string", "maxLength": 512, "minLength": 1 }, "region": { "type": "string", "enum": [ "emea", "global" ], "default": "emea" }, "performance": { "type": "string", "enum": [ "cost_saving", "standard", "turbo" ], "default": "standard" }, "min_replicas": { "type": "integer", "maximum": 1000.0, "minimum": 0.0, "default": 0 }, "max_replicas": { "type": "integer", "maximum": 1000.0, "minimum": 0.0, "default": 1 }, "notes": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 4000 } }, "type": "object", "required": [ "model_id", "model_source", "name" ], "title": "DeploymentCreateRequest" }, "DeploymentListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DeploymentResponse" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "DeploymentListResponse" }, "DeploymentResponse": { "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "model_source": { "type": "string", "enum": [ "platform", "custom" ] }, "model_id": { "type": "string" }, "region": { "type": "string" }, "performance": { "type": "string", "enum": [ "cost_saving", "standard", "turbo" ] }, "min_replicas": { "type": "integer" }, "max_replicas": { "type": "integer" }, "notes": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending_deploy", "deploying", "available", "rejected", "failed" ] }, "status_reason": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "activated_at": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "created_at", "id", "max_replicas", "min_replicas", "model_id", "model_source", "name", "performance", "region", "status", "updated_at" ], "title": "DeploymentResponse" }, "ForgotPasswordRequest": { "properties": { "email": { "type": "string", "format": "email" }, "captcha_token": { "type": "string", "default": "" } }, "type": "object", "required": [ "email" ], "title": "ForgotPasswordRequest" }, "ForgotPasswordResponse": { "properties": { "message": { "type": "string", "default": "If that email exists, a reset link was sent." } }, "type": "object", "required": [], "title": "ForgotPasswordResponse" }, "InferenceRequest": { "properties": { "custom_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "User-provided identifier for correlation." }, "body": { "additionalProperties": {}, "type": "object", "description": "OpenAI-style request body. Must include `model`. Accepts chat completions shape (`messages`) or Responses shape (`input`); Responses fields are normalized to chat format at create, then validated before enqueue." } }, "type": "object", "required": [ "body" ], "title": "InferenceRequest" }, "InvoiceCreateRequest": { "properties": { "period_start": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "period_end": { "oneOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "InvoiceCreateRequest" }, "InvoiceCreateResponse": { "properties": { "stripe_invoice_id": { "type": "string" }, "hosted_invoice_url": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_cents": { "type": "integer" }, "currency": { "type": "string" }, "period_start": { "type": "string", "format": "date-time" }, "period_end": { "type": "string", "format": "date-time" }, "status": { "type": "string" } }, "type": "object", "required": [ "amount_cents", "currency", "period_end", "period_start", "status", "stripe_invoice_id" ], "title": "InvoiceCreateResponse" }, "LedgerEntryItem": { "properties": { "id": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "amount_micros": { "type": "integer" }, "balance_after_micros": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "description": { "type": "string" }, "external_provider": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "external_payment_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "amount_micros", "created_at", "description", "id", "type" ], "title": "LedgerEntryItem" }, "LedgerListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LedgerEntryItem" }, "type": "array" }, "next_starting_after": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "items" ], "title": "LedgerListResponse" }, "LinkOAuthResponse": { "properties": { "message": { "type": "string", "default": "Linked successfully." } }, "type": "object", "required": [], "title": "LinkOAuthResponse" }, "LinkedAccountItem": { "properties": { "provider": { "type": "string" }, "created_at": { "type": "string" } }, "type": "object", "required": [ "created_at", "provider" ], "title": "LinkedAccountItem" }, "LinkedAccountsResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LinkedAccountItem" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "LinkedAccountsResponse" }, "LoginRequest": { "properties": { "username": { "type": "string" }, "password": { "type": "string", "maxLength": 128 }, "captcha_token": { "type": "string", "default": "" } }, "type": "object", "required": [ "password", "username" ], "title": "LoginRequest" }, "LoginResponse": { "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string", "default": "bearer" }, "user": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object", "required": [ "access_token", "user" ], "title": "LoginResponse" }, "ModelCapabilities": { "properties": { "image_input": { "$ref": "#/components/schemas/CapabilityFlag" }, "pdf_input": { "$ref": "#/components/schemas/CapabilityFlag" }, "thinking": { "$ref": "#/components/schemas/ThinkingCapability" }, "tools": { "$ref": "#/components/schemas/CapabilityFlag" }, "dimensions": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "ModelCapabilities" }, "ModelDeploymentRequestBody": { "properties": { "model_id": { "type": "string", "maxLength": 512, "minLength": 1 }, "display_name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 512 } }, "type": "object", "required": [ "model_id" ], "title": "ModelDeploymentRequestBody" }, "ModelDeploymentRequestResponse": { "properties": { "ok": { "type": "boolean", "const": true, "default": true } }, "type": "object", "required": [], "title": "ModelDeploymentRequestResponse" }, "ModelSearchItem": { "properties": { "id": { "type": "string" }, "display_name": { "type": "string" }, "provider": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "modality": { "type": "string", "default": "text_generation" }, "context_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "released": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "input_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "output_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "cached_input_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "tpm_limit": { "type": "string", "default": "unlimited" }, "rpm_limit": { "type": "string", "default": "unlimited" }, "requests_per_hour": { "type": "string", "default": "\u2014" }, "catalog_status": { "type": [ "null", "string" ], "enum": [ "available", "coming_soon", "deprecated", null ] }, "deployed_on_platform": { "type": "boolean" }, "source": { "type": "string", "enum": [ "catalog", "huggingface" ] } }, "type": "object", "required": [ "deployed_on_platform", "display_name", "id", "source" ], "title": "ModelSearchItem" }, "ModelSearchResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelSearchItem" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "ModelSearchResponse" }, "ModelUsageSummary": { "properties": { "model": { "type": "string" }, "service_tier": { "type": "string", "default": "default" }, "total_prompt_tokens": { "type": "integer" }, "total_completion_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "total_cached_prompt_tokens": { "type": "integer", "default": 0 }, "total_requests": { "type": "integer" }, "total_cost_micros": { "type": "integer", "default": 0 } }, "type": "object", "required": [ "model", "total_completion_tokens", "total_prompt_tokens", "total_requests", "total_tokens" ], "title": "ModelUsageSummary" }, "OAuthCompleteRequest": { "properties": { "provider": { "type": "string", "enum": [ "google", "github" ] }, "id_token": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "access_token": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "invite_token": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "provider" ], "title": "OAuthCompleteRequest" }, "PricingInfo": { "properties": { "model": { "type": "string" }, "prompt_token_price_micros": { "type": "integer" }, "completion_token_price_micros": { "type": "integer" }, "effective_from": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "completion_token_price_micros", "effective_from", "model", "prompt_token_price_micros" ], "title": "PricingInfo" }, "ReasoningConfig": { "properties": { "effort": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "summary": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "ReasoningConfig" }, "ResetPasswordRequest": { "properties": { "token": { "type": "string" }, "password": { "type": "string", "maxLength": 128, "minLength": 8 } }, "type": "object", "required": [ "password", "token" ], "title": "ResetPasswordRequest" }, "ResetPasswordResponse": { "properties": { "message": { "type": "string", "default": "Password has been reset." } }, "type": "object", "required": [], "title": "ResetPasswordResponse" }, "ResponseCreateRequest": { "properties": { "model": { "type": "string", "description": "Model identifier, e.g. \"zai-org/GLM-5\"" }, "input": { "oneOf": [ { "type": "string" }, { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" } ], "description": "Input for the completion. Either a plain string (shorthand for a single user message) or an array of OpenAI Responses input items." }, "instructions": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Developer instructions (system prompt)." }, "tools": { "oneOf": [ { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, { "type": "null" } ] }, "tool_choice": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "string" }, { "type": "null" } ] }, "max_output_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "temperature": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "maximum": 2.0 }, "top_p": { "oneOf": [ { "type": "number" }, { "type": "null" } ], "maximum": 1.0 }, "include_reasoning": { "type": "boolean", "default": true }, "enable_thinking": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] }, "reasoning": { "oneOf": [ { "$ref": "#/components/schemas/ReasoningConfig" }, { "type": "null" } ] }, "include": { "oneOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Ignored. Every value OpenAI defines here (web search, code interpreter, computer use, file search, logprobs, encrypted reasoning) depends on a feature this API does not implement, so the requested extra data is never present in the response regardless. Silently ignored rather than rejected: upstream routers such as requesty.ai count a 400 as a failed request against our reliability, while an ignored `include` degrades gracefully \u2014 the caller simply gets none of the extra data they would not have received anyway." }, "background": { "type": "boolean", "default": false }, "stream": { "type": "boolean", "default": false }, "text": { "oneOf": [ { "$ref": "#/components/schemas/ResponseTextConfig" }, { "type": "null" } ] }, "prompt_cache_key": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable identifier for a sequence of requests that share a long prefix (a chat session, an agent loop). Requests with the same key are routed to the same worker while it stays warm, so the shared prefix is served from its prompt cache. Without it, placement is inferred from the input text." }, "service_tier": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Processing tier for the request. `\"flex\"` selects flex processing (beta) on flex-enabled accounts: discounted tokens in exchange for lower scheduling priority and best-effort completion \u2014 the request may queue significantly longer than default-tier requests, so raise your client timeout accordingly, or use `background: true` and poll. All other accepted values (`auto`, `default`, `scale`, `priority`) are served at the default tier. Responses echo the tier actually served in `service_tier`." }, "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } }, "type": "object", "required": [ "input", "model" ], "title": "ResponseCreateRequest" }, "ResponseError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "required": [ "code", "message" ], "title": "ResponseError" }, "ResponseFunctionToolCall": { "properties": { "type": { "type": "string", "const": "function_call", "default": "function_call" }, "id": { "type": "string" }, "call_id": { "type": "string" }, "name": { "type": "string" }, "arguments": { "type": "string", "default": "{}" }, "status": { "type": "string", "enum": [ "completed", "in_progress", "incomplete" ], "default": "completed" } }, "type": "object", "required": [ "call_id", "id", "name" ], "title": "ResponseFunctionToolCall" }, "ResponseIncompleteDetails": { "properties": { "reason": { "type": "string", "enum": [ "max_output_tokens", "content_filter" ] } }, "type": "object", "required": [ "reason" ], "title": "ResponseIncompleteDetails" }, "ResponseInputTokensDetails": { "properties": { "cached_tokens": { "type": "integer", "default": 0 } }, "type": "object", "required": [], "title": "ResponseInputTokensDetails" }, "ResponseItem": { "properties": { "id": { "type": "string", "description": "UUID of the inference request." }, "object": { "type": "string", "const": "response", "default": "response" }, "created_at": { "type": "integer", "description": "Unix timestamp (seconds)." }, "model": { "type": "string" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "failed", "cancelled", "incomplete" ] }, "incomplete_details": { "oneOf": [ { "$ref": "#/components/schemas/ResponseIncompleteDetails" }, { "type": "null" } ] }, "output": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/ResponseOutputMessage" }, { "$ref": "#/components/schemas/ResponseOutputReasoning" }, { "$ref": "#/components/schemas/ResponseFunctionToolCall" } ] }, "type": "array" }, { "type": "null" } ] }, "error": { "oneOf": [ { "$ref": "#/components/schemas/ResponseError" }, { "type": "null" } ] }, "usage": { "oneOf": [ { "$ref": "#/components/schemas/ResponseUsage" }, { "type": "null" } ] }, "service_tier": { "type": "string", "enum": [ "default", "flex" ], "description": "Tier the request was served at.", "default": "default" } }, "type": "object", "required": [ "created_at", "id", "model", "status" ], "title": "ResponseItem" }, "ResponseList": { "properties": { "object": { "type": "string", "const": "list", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/ResponseListItem" }, "type": "array" }, "has_more": { "type": "boolean", "default": false } }, "type": "object", "required": [ "data" ], "title": "ResponseList" }, "ResponseListItem": { "properties": { "id": { "type": "string" }, "object": { "type": "string", "const": "response", "default": "response" }, "created_at": { "type": "integer" }, "model": { "type": "string" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "failed", "cancelled", "incomplete" ] } }, "type": "object", "required": [ "created_at", "id", "model", "status" ], "title": "ResponseListItem" }, "ResponseMetadata": { "properties": { "completion_window": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "stream_id": { "oneOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "custom_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "ResponseMetadata", "description": "Extra metadata including \"completion_window\" (\"24h\" is the only supported value; requires background=true) and optional \"stream_id\" for grouping." }, "ResponseOutputMessage": { "properties": { "type": { "type": "string", "const": "message", "default": "message" }, "id": { "type": "string" }, "role": { "type": "string", "const": "assistant", "default": "assistant" }, "status": { "type": "string", "enum": [ "completed", "in_progress", "incomplete" ], "default": "completed" }, "content": { "items": { "$ref": "#/components/schemas/ResponseOutputText" }, "type": "array" } }, "type": "object", "required": [ "content", "id" ], "title": "ResponseOutputMessage" }, "ResponseOutputReasoning": { "properties": { "type": { "type": "string", "const": "reasoning", "default": "reasoning" }, "id": { "type": "string" }, "summary": { "items": { "$ref": "#/components/schemas/ResponseReasoningSummaryPart" }, "type": "array" } }, "type": "object", "required": [ "id" ], "title": "ResponseOutputReasoning" }, "ResponseOutputText": { "properties": { "type": { "type": "string", "const": "output_text", "default": "output_text" }, "text": { "type": "string" }, "annotations": { "items": {}, "type": "array" } }, "type": "object", "required": [ "text" ], "title": "ResponseOutputText" }, "ResponseOutputTokensDetails": { "properties": { "reasoning_tokens": { "type": "integer", "default": 0 } }, "type": "object", "required": [], "title": "ResponseOutputTokensDetails" }, "ResponseReasoningSummaryPart": { "properties": { "type": { "type": "string", "const": "summary_text", "default": "summary_text" }, "text": { "type": "string" } }, "type": "object", "required": [ "text" ], "title": "ResponseReasoningSummaryPart" }, "ResponseTextConfig": { "properties": { "format": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "ResponseTextConfig" }, "ResponseUsage": { "properties": { "input_tokens": { "type": "integer" }, "output_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "input_tokens_details": { "$ref": "#/components/schemas/ResponseInputTokensDetails" }, "output_tokens_details": { "$ref": "#/components/schemas/ResponseOutputTokensDetails" } }, "type": "object", "required": [ "input_tokens", "output_tokens", "total_tokens" ], "title": "ResponseUsage" }, "SignupRequest": { "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "maxLength": 128, "minLength": 8 }, "captcha_token": { "type": "string", "default": "" }, "invite_token": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "phone_number": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "maxLength": 32 } }, "type": "object", "required": [ "email", "password" ], "title": "SignupRequest" }, "SignupResponse": { "properties": { "message": { "type": "string" }, "verification_token": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "type": [ "null", "string" ], "enum": [ "waitlist", "invited", null ] }, "next_step": { "type": "string", "enum": [ "verify_email", "login" ], "default": "verify_email" } }, "type": "object", "required": [ "message" ], "title": "SignupResponse" }, "StreamCreateRequest": { "properties": { "name": { "type": "string", "minLength": 1 }, "window": { "type": "string", "const": "24h", "default": "24h" } }, "type": "object", "required": [ "name" ], "title": "StreamCreateRequest" }, "StreamDetailResponse": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "window": { "type": "string", "const": "24h" }, "status": { "type": "string", "enum": [ "open", "cancelled", "archived" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "cancelled_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "archived_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "total_items": { "type": "integer", "default": 0 }, "pending_items": { "type": "integer", "default": 0 }, "running_items": { "type": "integer", "default": 0 }, "completed_items": { "type": "integer", "default": 0 }, "failed_items": { "type": "integer", "default": 0 }, "cancelled_items": { "type": "integer", "default": 0 }, "completion_ratio": { "type": "number", "default": 0.0 }, "total_prompt_tokens": { "type": "integer", "default": 0 }, "total_completion_tokens": { "type": "integer", "default": 0 }, "total_tokens": { "type": "integer", "default": 0 }, "total_cost_micros": { "type": "integer", "default": 0 }, "last_completion_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "latest_completion_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "created_at", "id", "name", "status", "updated_at", "window" ], "title": "StreamDetailResponse" }, "StreamEventListResponse": { "properties": { "object": { "type": "string", "const": "list", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/StreamInferenceCompletionEvent" }, "type": "array" }, "has_more": { "type": "boolean" } }, "type": "object", "required": [ "data", "has_more" ], "title": "StreamEventListResponse" }, "StreamInferenceCompletionEvent": { "properties": { "completion_id": { "type": "string" }, "response_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "custom_id": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "result": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "null" } ] }, "error": { "oneOf": [ { "additionalProperties": {}, "type": "object" }, { "type": "null" } ] }, "prompt_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "completion_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "total_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "cost_micros": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "completed_at": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "completion_id", "status" ], "title": "StreamInferenceCompletionEvent" }, "StreamListItemResponse": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "window": { "type": "string", "const": "24h" }, "status": { "type": "string", "enum": [ "open", "cancelled", "archived" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object", "required": [ "created_at", "id", "name", "status", "updated_at", "window" ], "title": "StreamListItemResponse" }, "StreamListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/StreamListItemResponse" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "StreamListResponse" }, "StreamOptions": { "properties": { "include_usage": { "type": "boolean", "default": false } }, "type": "object", "required": [], "title": "StreamOptions" }, "StreamPatchRequest": { "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "minLength": 1 }, "status": { "type": [ "null", "string" ], "enum": [ "archived", "cancelled", null ] } }, "type": "object", "required": [], "title": "StreamPatchRequest" }, "TeamAddMemberRequest": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3 } }, "type": "object", "required": [ "email" ], "title": "TeamAddMemberRequest" }, "TeamMeResponse": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email_domain": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string" }, "zero_data_retention_enabled": { "type": "boolean", "default": false }, "members": { "oneOf": [ { "items": { "$ref": "#/components/schemas/TeamMemberItem" }, "type": "array" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "role" ], "title": "TeamMeResponse" }, "TeamMemberItem": { "properties": { "user_id": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object", "required": [ "created_at", "email", "is_active", "role", "user_id" ], "title": "TeamMemberItem" }, "TeamMemberRoleUpdateRequest": { "properties": { "role": { "type": "string", "enum": [ "admin", "member" ], "description": "New team role for the member" } }, "type": "object", "required": [ "role" ], "title": "TeamMemberRoleUpdateRequest" }, "TeamUpdateRequest": { "properties": { "zero_data_retention_enabled": { "oneOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "TeamUpdateRequest" }, "ThinkingCapability": { "properties": { "supported": { "type": "boolean", "default": false }, "types": { "$ref": "#/components/schemas/ThinkingCapabilityTypes" } }, "type": "object", "required": [], "title": "ThinkingCapability" }, "ThinkingCapabilityTypes": { "properties": { "enabled": { "$ref": "#/components/schemas/CapabilityFlag" }, "adaptive": { "$ref": "#/components/schemas/CapabilityFlag" } }, "type": "object", "required": [], "title": "ThinkingCapabilityTypes" }, "TopupCreateRequest": { "properties": { "amount_usd": { "type": "string" } }, "type": "object", "required": [ "amount_usd" ], "title": "TopupCreateRequest" }, "TopupCreateResponse": { "properties": { "stripe_session_id": { "type": "string" }, "checkout_url": { "type": "string" } }, "type": "object", "required": [ "checkout_url", "stripe_session_id" ], "title": "TopupCreateResponse" }, "UsageDailyResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/DailyUsage" }, "type": "array" } }, "type": "object", "required": [ "items" ], "title": "UsageDailyResponse" }, "UsageSummary": { "properties": { "total_prompt_tokens": { "type": "integer" }, "total_completion_tokens": { "type": "integer" }, "total_tokens": { "type": "integer" }, "total_cached_prompt_tokens": { "type": "integer", "default": 0 }, "total_requests": { "type": "integer" }, "total_cost_micros": { "type": "integer", "default": 0 } }, "type": "object", "required": [ "total_completion_tokens", "total_prompt_tokens", "total_requests", "total_tokens" ], "title": "UsageSummary" }, "UsageSummaryResponse": { "properties": { "summary": { "$ref": "#/components/schemas/UsageSummary" }, "by_model": { "items": { "$ref": "#/components/schemas/ModelUsageSummary" }, "type": "array" } }, "type": "object", "required": [ "by_model", "summary" ], "title": "UsageSummaryResponse" }, "UserResponse": { "properties": { "username": { "type": "string" }, "role": { "type": "string" } }, "type": "object", "required": [ "role", "username" ], "title": "UserResponse" }, "V1ModelItemResponse": { "properties": { "id": { "type": "string" }, "object": { "type": "string", "const": "model", "default": "model" }, "created": { "type": "integer" }, "owned_by": { "type": "string", "default": "sference" }, "display_name": { "type": "string" }, "modality": { "type": "string", "enum": [ "text_generation", "text_embedding" ], "default": "text_generation" }, "capabilities": { "$ref": "#/components/schemas/ModelCapabilities" }, "context_tokens": { "oneOf": [ { "type": "integer" }, { "type": "null" } ] }, "provider": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "pricing": { "oneOf": [ { "$ref": "#/components/schemas/V1ModelPricing" }, { "type": "null" } ] }, "released": { "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object", "required": [ "created", "display_name", "id" ], "title": "V1ModelItemResponse" }, "V1ModelListResponse": { "properties": { "object": { "type": "string", "const": "list", "default": "list" }, "data": { "items": { "$ref": "#/components/schemas/V1ModelItemResponse" }, "type": "array" } }, "type": "object", "required": [ "data" ], "title": "V1ModelListResponse" }, "V1ModelPricing": { "properties": { "input_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "output_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] }, "cached_input_per_million_usd": { "oneOf": [ { "type": "number" }, { "type": "null" } ] } }, "type": "object", "required": [], "title": "V1ModelPricing" }, "VerifyEmailRequest": { "properties": { "token": { "type": "string" } }, "type": "object", "required": [ "token" ], "title": "VerifyEmailRequest" } } } }