{ "openapi": "3.1.0", "info": { "title": "ADK server", "version": "0.8.1" }, "paths": { "/api/v1/user": { "get": { "tags": [ "user" ], "summary": "Get User", "operationId": "get_user_api_v1_user_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/users/me": { "get": { "tags": [ "users", "users" ], "summary": "Get Me", "description": "Get current user", "operationId": "get_me_api_v1_users_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/a2a/{provider_id}/.well-known/agent-card.json": { "get": { "tags": [ "a2a" ], "summary": "Get Agent Card", "operationId": "get_agent_card_api_v1_a2a__provider_id___well_known_agent_card_json_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Agent Card Api V1 A2A Provider Id Well Known Agent Card Json Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/a2a/{provider_id}/": { "post": { "tags": [ "a2a" ], "summary": "A2A Proxy Jsonrpc Transport", "operationId": "a2a_proxy_jsonrpc_transport_api_v1_a2a__provider_id___post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/a2a/{provider_id}": { "post": { "tags": [ "a2a" ], "summary": "A2A Proxy Jsonrpc Transport", "operationId": "a2a_proxy_jsonrpc_transport_api_v1_a2a__provider_id__post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/a2a/{provider_id}/http/{path}": { "patch": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "options": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "head": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http__path__patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/a2a/{provider_id}/http": { "patch": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "options": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "head": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "a2a" ], "summary": "A2A Proxy Http Transport", "operationId": "a2a_proxy_http_transport_api_v1_a2a__provider_id__http_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/providers": { "post": { "tags": [ "providers" ], "summary": "Create Provider", "operationId": "create_provider_api_v1_providers_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Provider" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "providers" ], "summary": "List Providers", "operationId": "list_providers_api_v1_providers_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "user_owned", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "User Owned" } }, { "name": "origin", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_ModelOutput_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/providers/preview": { "post": { "tags": [ "providers" ], "summary": "Preview Provider", "operationId": "preview_provider_api_v1_providers_preview_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Provider" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/providers/{id}": { "get": { "tags": [ "providers" ], "summary": "Get Provider", "operationId": "get_provider_api_v1_providers__id__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__2" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "providers" ], "summary": "Delete Provider", "operationId": "delete_provider_api_v1_providers__id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/providers/by-location/{location}": { "get": { "tags": [ "providers" ], "summary": "Get Provider By Location", "operationId": "get_provider_by_location_api_v1_providers_by_location__location__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "string", "title": "Location" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__3" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/model_providers": { "get": { "tags": [ "model_providers" ], "summary": "List Model Providers", "operationId": "list_model_providers_api_v1_model_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_ModelProvider_" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] }, "post": { "tags": [ "model_providers" ], "summary": "Create Model Provider", "operationId": "create_model_provider_api_v1_model_providers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModelProviderRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__4" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/model_providers/{model_provider_id}": { "get": { "tags": [ "model_providers" ], "summary": "Get Model Provider", "operationId": "get_model_provider_api_v1_model_providers__model_provider_id__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "model_provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Model Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__5" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "model_providers" ], "summary": "Delete Model Provider", "operationId": "delete_model_provider_api_v1_model_providers__model_provider_id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "model_provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Model Provider Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/model_providers/match": { "post": { "tags": [ "model_providers" ], "summary": "Match", "operationId": "match_api_v1_model_providers_match_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchModelsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_ModelWithScore_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/configurations/system": { "get": { "tags": [ "configurations" ], "summary": "Get Configuration", "operationId": "get_configuration_api_v1_configurations_system_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__6" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] }, "put": { "tags": [ "configurations" ], "summary": "Update Configuration", "operationId": "update_configuration_api_v1_configurations_system_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConfigurationRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__7" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/files": { "post": { "tags": [ "files" ], "summary": "Upload File", "operationId": "upload_file_api_v1_files_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_api_v1_files_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__8" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "files" ], "summary": "List Files", "operationId": "list_files_api_v1_files_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/FileListQuery" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_File_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/files/{file_id}": { "get": { "tags": [ "files" ], "summary": "Get File", "operationId": "get_file_api_v1_files__file_id__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__9" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "files" ], "summary": "Delete File", "operationId": "delete_file_api_v1_files__file_id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/files/{file_id}/content": { "get": { "tags": [ "files" ], "summary": "Get File Content", "operationId": "get_file_content_api_v1_files__file_id__content_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/files/{file_id}/text_content": { "get": { "tags": [ "files" ], "summary": "Get Text File Content", "operationId": "get_text_file_content_api_v1_files__file_id__text_content_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/files/{file_id}/extraction": { "post": { "tags": [ "files" ], "summary": "Create Text Extraction", "description": "Create or return text extraction for a file.\n\n- If extraction is completed, returns existing result\n- If extraction failed, retries the extraction\n- If extraction is pending/in-progress, returns current status\n- If no extraction exists, creates a new one", "operationId": "create_text_extraction_api_v1_files__file_id__extraction_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TextExtractionRequest" }, { "type": "null" } ], "title": "Request" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__10" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "files" ], "summary": "Get Text Extraction", "operationId": "get_text_extraction_api_v1_files__file_id__extraction_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__11" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "files" ], "summary": "Delete Text Extraction", "operationId": "delete_text_extraction_api_v1_files__file_id__extraction_delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/variables": { "get": { "tags": [ "variables" ], "summary": "List User Variables", "operationId": "list_user_variables_api_v1_variables_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVariablesSchema" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] }, "put": { "tags": [ "variables" ], "summary": "Update User Variables", "operationId": "update_user_variables_api_v1_variables_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariablesRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/contexts": { "post": { "tags": [ "contexts" ], "summary": "Create Context", "operationId": "create_context_api_v1_contexts_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__12" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "contexts" ], "summary": "List Context", "operationId": "list_context_api_v1_contexts_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Limit" } }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Page Token" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "title": "Order" } }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^created_at|updated_at$", "title": "Order By" } }, { "name": "include_empty", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Include Empty" } }, { "name": "provider_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_Context_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/contexts/{context_id}": { "get": { "tags": [ "contexts" ], "summary": "Get Context", "operationId": "get_context_api_v1_contexts__context_id__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__13" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "contexts" ], "summary": "Delete Context", "operationId": "delete_context_api_v1_contexts__context_id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "contexts" ], "summary": "Update Context", "operationId": "update_context_api_v1_contexts__context_id__put", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__14" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/contexts/{context_id}/metadata": { "patch": { "tags": [ "contexts" ], "summary": "Patch Context Metadata", "operationId": "patch_context_metadata_api_v1_contexts__context_id__metadata_patch", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextPatchMetadataRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__15" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/contexts/{context_id}/token": { "post": { "tags": [ "contexts" ], "summary": "Generate Context Token", "operationId": "generate_context_token_api_v1_contexts__context_id__token_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextTokenCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextTokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/contexts/{context_id}/history": { "post": { "tags": [ "contexts" ], "summary": "Add Context History Item", "operationId": "add_context_history_item_api_v1_contexts__context_id__history_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextHistoryItemCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "contexts" ], "summary": "List Context History", "operationId": "list_context_history_api_v1_contexts__context_id__history_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "title": "Limit" } }, { "name": "page_token", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Page Token" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "title": "Order" } }, { "name": "order_by", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^created_at|updated_at$", "title": "Order By" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_ContextHistoryItem_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "contexts" ], "summary": "Delete Context History From Id", "operationId": "delete_context_history_from_id_api_v1_contexts__context_id__history_delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } }, { "name": "from_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "From Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/openai/chat/completions": { "post": { "tags": [ "openai" ], "summary": "Create Chat Completion", "operationId": "create_chat_completion_api_v1_openai_chat_completions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/openai/embeddings": { "post": { "tags": [ "openai" ], "summary": "Create Embedding", "operationId": "create_embedding_api_v1_openai_embeddings_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingsRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/openai/models": { "get": { "tags": [ "openai" ], "summary": "List Models", "operationId": "list_models_api_v1_openai_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAIPage_Model_" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/vector_stores": { "post": { "tags": [ "vector_stores" ], "summary": "Create Vector Store", "description": "Create a new vector store.", "operationId": "create_vector_store_api_v1_vector_stores_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVectorStoreRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__16" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/vector_stores/{vector_store_id}": { "get": { "tags": [ "vector_stores" ], "summary": "Get Vector Store", "description": "Get a vector store by ID.", "operationId": "get_vector_store_api_v1_vector_stores__vector_store_id__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "vector_store_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vector Store Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__17" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "vector_stores" ], "summary": "Delete Vector Store", "description": "Delete a vector store by ID.", "operationId": "delete_vector_store_api_v1_vector_stores__vector_store_id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "vector_store_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vector Store Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "vector_stores" ], "summary": "Add Items", "operationId": "add_items_api_v1_vector_stores__vector_store_id__put", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "vector_store_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vector Store Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VectorStoreItem" }, "title": "Items" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/vector_stores/{vector_store_id}/search": { "post": { "tags": [ "vector_stores" ], "summary": "Search With Vector", "description": "Search a vector store using either text or a vector.", "operationId": "search_with_vector_api_v1_vector_stores__vector_store_id__search_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "vector_store_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vector Store Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_VectorStoreSearchResult_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/vector_stores/{vector_store_id}/documents": { "get": { "tags": [ "vector_stores" ], "summary": "List Documents", "description": "List all documents in a vector store.", "operationId": "list_documents_api_v1_vector_stores__vector_store_id__documents_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "vector_store_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vector Store Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_VectorStoreDocument_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/vector_stores/{vector_store_id}/documents/{document_id}": { "delete": { "tags": [ "vector_stores" ], "summary": "Delete Document", "description": "Delete a document by ID.", "operationId": "delete_document_api_v1_vector_stores__vector_store_id__documents__document_id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "vector_store_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vector Store Id" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/user_feedback": { "post": { "tags": [ "user_feedback" ], "summary": "User Feedback", "operationId": "user_feedback_api_v1_user_feedback_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertUserFeedbackRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "user_feedback" ], "summary": "List User Feedback", "operationId": "list_user_feedback_api_v1_user_feedback_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "provider_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "after_cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "After Cursor" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_UserFeedbackResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/presets": { "get": { "tags": [ "connectors" ], "summary": "List Presets", "operationId": "list_presets_api_v1_connectors_presets_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_ConnectorPresetResponse_" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/connectors": { "get": { "tags": [ "connectors" ], "summary": "List Connectors", "operationId": "list_connectors_api_v1_connectors_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResult_ConnectorResponse_" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] }, "post": { "tags": [ "connectors" ], "summary": "Create Connector", "operationId": "create_connector_api_v1_connectors_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ] } }, "/api/v1/connectors/{connector_id}": { "get": { "tags": [ "connectors" ], "summary": "Read Connector", "operationId": "read_connector_api_v1_connectors__connector_id__get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "connectors" ], "summary": "Delete Connector", "operationId": "delete_connector_api_v1_connectors__connector_id__delete", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/connect": { "post": { "tags": [ "connectors" ], "summary": "Connect Connector", "operationId": "connect_connector_api_v1_connectors__connector_id__connect_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorConnectRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/disconnect": { "post": { "tags": [ "connectors" ], "summary": "Disconnect Connector", "operationId": "disconnect_connector_api_v1_connectors__connector_id__disconnect_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/{connector_id}/mcp": { "get": { "tags": [ "connectors" ], "summary": "Mcp", "operationId": "mcp_api_v1_connectors__connector_id__mcp_get", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "connectors" ], "summary": "Mcp", "operationId": "mcp_api_v1_connectors__connector_id__mcp_post", "security": [ { "HTTPBasic": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/connectors/oauth/callback": { "get": { "tags": [ "connectors" ], "summary": "Oauth Callback", "operationId": "oauth_callback_api_v1_connectors_oauth_callback_get", "parameters": [ { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "title": "State" } }, { "name": "error", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, { "name": "error_description", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Description" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/.well-known/oauth-protected-resource/{resource}": { "get": { "tags": [ "auth" ], "summary": "Protected Resource Metadata", "operationId": "protected_resource_metadata__well_known_oauth_protected_resource__resource__get", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/.well-known/jwks": { "get": { "tags": [ "auth" ], "summary": "Jwks", "operationId": "jwks__well_known_jwks_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } } }, "components": { "schemas": { "Audio": { "properties": { "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "Audio", "description": "Data about a previous audio response from the model.\n[Learn more](https://platform.openai.com/docs/guides/audio)." }, "AuthorizationCodeRequest": { "properties": { "type": { "type": "string", "const": "code", "title": "Type", "default": "code" }, "authorization_endpoint": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Endpoint" } }, "type": "object", "required": [ "authorization_endpoint" ], "title": "AuthorizationCodeRequest" }, "Body_upload_file_api_v1_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_file_api_v1_files_post" }, "ChatCompletionAllowedToolChoiceParam": { "properties": { "allowed_tools": { "$ref": "#/components/schemas/ChatCompletionAllowedToolsParam" }, "type": { "type": "string", "const": "allowed_tools", "title": "Type" } }, "type": "object", "required": [ "allowed_tools", "type" ], "title": "ChatCompletionAllowedToolChoiceParam", "description": "Constrains the tools available to the model to a pre-defined set." }, "ChatCompletionAllowedToolsParam": { "properties": { "mode": { "type": "string", "enum": [ "auto", "required" ], "title": "Mode" }, "tools": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Tools" } }, "type": "object", "required": [ "mode", "tools" ], "title": "ChatCompletionAllowedToolsParam", "description": "Constrains the tools available to the model to a pre-defined set." }, "ChatCompletionAssistantMessageParam": { "properties": { "role": { "type": "string", "const": "assistant", "title": "Role" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/Audio" }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionContentPartTextParam" }, { "$ref": "#/components/schemas/ChatCompletionContentPartRefusalParam" } ] }, "type": "array" }, { "type": "null" } ], "title": "Content" }, "function_call": { "anyOf": [ { "$ref": "#/components/schemas/FunctionCall" }, { "type": "null" } ] }, "name": { "type": "string", "title": "Name" }, "refusal": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refusal" }, "tool_calls": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam" }, { "$ref": "#/components/schemas/ChatCompletionMessageCustomToolCallParam" } ] }, "type": "array", "title": "Tool Calls" } }, "type": "object", "required": [ "role" ], "title": "ChatCompletionAssistantMessageParam", "description": "Messages sent by the model in response to user messages." }, "ChatCompletionAudioParam": { "properties": { "format": { "type": "string", "enum": [ "wav", "aac", "mp3", "flac", "opus", "pcm16" ], "title": "Format" }, "voice": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse", "marin", "cedar" ] }, { "$ref": "#/components/schemas/VoiceID" } ], "title": "Voice" } }, "type": "object", "required": [ "format", "voice" ], "title": "ChatCompletionAudioParam", "description": "Parameters for audio output.\n\nRequired when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](https://platform.openai.com/docs/guides/audio)." }, "ChatCompletionContentPartImageParam": { "properties": { "image_url": { "$ref": "#/components/schemas/ImageURL" }, "type": { "type": "string", "const": "image_url", "title": "Type" } }, "type": "object", "required": [ "image_url", "type" ], "title": "ChatCompletionContentPartImageParam", "description": "Learn about [image inputs](https://platform.openai.com/docs/guides/vision)." }, "ChatCompletionContentPartInputAudioParam": { "properties": { "input_audio": { "$ref": "#/components/schemas/InputAudio" }, "type": { "type": "string", "const": "input_audio", "title": "Type" } }, "type": "object", "required": [ "input_audio", "type" ], "title": "ChatCompletionContentPartInputAudioParam", "description": "Learn about [audio inputs](https://platform.openai.com/docs/guides/audio)." }, "ChatCompletionContentPartRefusalParam": { "properties": { "refusal": { "type": "string", "title": "Refusal" }, "type": { "type": "string", "const": "refusal", "title": "Type" } }, "type": "object", "required": [ "refusal", "type" ], "title": "ChatCompletionContentPartRefusalParam" }, "ChatCompletionContentPartTextParam": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "text", "title": "Type" } }, "type": "object", "required": [ "text", "type" ], "title": "ChatCompletionContentPartTextParam", "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)." }, "ChatCompletionDeveloperMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "developer", "title": "Role" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "content", "role" ], "title": "ChatCompletionDeveloperMessageParam", "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages." }, "ChatCompletionFunctionCallOptionParam": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "ChatCompletionFunctionCallOptionParam", "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function." }, "ChatCompletionFunctionMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "name": { "type": "string", "title": "Name" }, "role": { "type": "string", "const": "function", "title": "Role" } }, "type": "object", "required": [ "content", "name", "role" ], "title": "ChatCompletionFunctionMessageParam" }, "ChatCompletionFunctionToolParam": { "properties": { "function": { "$ref": "#/components/schemas/FunctionDefinition" }, "type": { "type": "string", "const": "function", "title": "Type" } }, "type": "object", "required": [ "function", "type" ], "title": "ChatCompletionFunctionToolParam", "description": "A function tool that can be used to generate a response." }, "ChatCompletionMessageCustomToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "custom": { "$ref": "#/components/schemas/openai__types__chat__chat_completion_message_custom_tool_call_param__Custom" }, "type": { "type": "string", "const": "custom", "title": "Type" } }, "type": "object", "required": [ "id", "custom", "type" ], "title": "ChatCompletionMessageCustomToolCallParam", "description": "A call to a custom tool created by the model." }, "ChatCompletionMessageFunctionToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "function": { "$ref": "#/components/schemas/openai__types__chat__chat_completion_message_function_tool_call_param__Function" }, "type": { "type": "string", "const": "function", "title": "Type" } }, "type": "object", "required": [ "id", "function", "type" ], "title": "ChatCompletionMessageFunctionToolCallParam", "description": "A call to a function tool created by the model." }, "ChatCompletionNamedToolChoiceCustomParam": { "properties": { "custom": { "$ref": "#/components/schemas/openai__types__chat__chat_completion_named_tool_choice_custom_param__Custom" }, "type": { "type": "string", "const": "custom", "title": "Type" } }, "type": "object", "required": [ "custom", "type" ], "title": "ChatCompletionNamedToolChoiceCustomParam", "description": "Specifies a tool the model should use.\n\nUse to force the model to call a specific custom tool." }, "ChatCompletionNamedToolChoiceParam": { "properties": { "function": { "$ref": "#/components/schemas/openai__types__chat__chat_completion_named_tool_choice_param__Function" }, "type": { "type": "string", "const": "function", "title": "Type" } }, "type": "object", "required": [ "function", "type" ], "title": "ChatCompletionNamedToolChoiceParam", "description": "Specifies a tool the model should use.\n\nUse to force the model to call a specific function." }, "ChatCompletionPredictionContentParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "type": { "type": "string", "const": "content", "title": "Type" } }, "type": "object", "required": [ "content", "type" ], "title": "ChatCompletionPredictionContentParam", "description": "Static predicted output content, such as the content of a text file that is\nbeing regenerated." }, "ChatCompletionRequest": { "properties": { "messages": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam" }, { "$ref": "#/components/schemas/ChatCompletionSystemMessageParam" }, { "$ref": "#/components/schemas/ChatCompletionUserMessageParam" }, { "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam" }, { "$ref": "#/components/schemas/ChatCompletionToolMessageParam" }, { "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam" } ] }, "type": "array", "title": "Messages" }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-5.4", "gpt-5.3-chat-latest", "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", "gpt-5.2-pro", "gpt-5.2-pro-2025-12-11", "gpt-5.1", "gpt-5.1-2025-11-13", "gpt-5.1-codex", "gpt-5.1-mini", "gpt-5.1-chat-latest", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07", "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "gpt-5-chat-latest", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16", "o3", "o3-2025-04-16", "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "o1-preview", "o1-preview-2024-09-12", "o1-mini", "o1-mini-2024-09-12", "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-10-01", "gpt-4o-audio-preview-2024-12-17", "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview", "gpt-4o-mini-audio-preview-2024-12-17", "gpt-4o-search-preview", "gpt-4o-mini-search-preview", "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11", "chatgpt-4o-latest", "codex-mini-latest", "gpt-4o-mini", "gpt-4o-mini-2024-07-18", "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-1106-preview", "gpt-4-vision-preview", "gpt-4", "gpt-4-0314", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613" ] } ], "title": "Model" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionAudioParam" }, { "type": "null" } ] }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty" }, "function_call": { "anyOf": [ { "type": "string", "enum": [ "none", "auto" ] }, { "$ref": "#/components/schemas/ChatCompletionFunctionCallOptionParam" }, { "type": "null" } ], "title": "Function Call" }, "functions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/openai__types__chat__completion_create_params__Function" }, "type": "array" }, { "type": "null" } ], "title": "Functions" }, "logit_bias": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "logprobs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Logprobs" }, "max_completion_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Completion Tokens" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "modalities": { "anyOf": [ { "items": { "type": "string", "enum": [ "text", "audio" ] }, "type": "array" }, { "type": "null" } ], "title": "Modalities" }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N" }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Parallel Tool Calls" }, "prediction": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionPredictionContentParam" }, { "type": "null" } ] }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty" }, "reasoning_effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh" ] }, { "type": "null" } ], "title": "Reasoning Effort" }, "response_format": { "anyOf": [ { "$ref": "#/components/schemas/ResponseFormatText" }, { "$ref": "#/components/schemas/ResponseFormatJSONSchema" }, { "$ref": "#/components/schemas/ResponseFormatJSONObject" }, { "type": "null" } ], "title": "Response Format" }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "service_tier": { "anyOf": [ { "type": "string", "enum": [ "auto", "default", "flex", "scale", "priority" ] }, { "type": "null" } ], "title": "Service Tier" }, "stop": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stop" }, "store": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Store" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream" }, "stream_options": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionStreamOptionsParam" }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "tool_choice": { "anyOf": [ { "type": "string", "enum": [ "none", "auto", "required" ] }, { "$ref": "#/components/schemas/ChatCompletionAllowedToolChoiceParam" }, { "$ref": "#/components/schemas/ChatCompletionNamedToolChoiceParam" }, { "$ref": "#/components/schemas/ChatCompletionNamedToolChoiceCustomParam" }, { "type": "null" } ], "title": "Tool Choice" }, "tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ChatCompletionFunctionToolParam" }, "type": "array" }, { "type": "null" } ], "title": "Tools" }, "top_logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top Logprobs" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "web_search_options": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchOptions" }, { "type": "null" } ] } }, "type": "object", "required": [ "messages", "model" ], "title": "ChatCompletionRequest", "description": "Corresponds to args to OpenAI `client.chat.completions.create(...)`" }, "ChatCompletionStreamOptionsParam": { "properties": { "include_obfuscation": { "type": "boolean", "title": "Include Obfuscation" }, "include_usage": { "type": "boolean", "title": "Include Usage" } }, "type": "object", "title": "ChatCompletionStreamOptionsParam", "description": "Options for streaming response. Only set this when you set `stream: true`." }, "ChatCompletionSystemMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "system", "title": "Role" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "content", "role" ], "title": "ChatCompletionSystemMessageParam", "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead." }, "ChatCompletionToolMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/components/schemas/ChatCompletionContentPartTextParam" }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "tool", "title": "Role" }, "tool_call_id": { "type": "string", "title": "Tool Call Id" } }, "type": "object", "required": [ "content", "role", "tool_call_id" ], "title": "ChatCompletionToolMessageParam" }, "ChatCompletionUserMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/components/schemas/ChatCompletionContentPartTextParam" }, { "$ref": "#/components/schemas/ChatCompletionContentPartImageParam" }, { "$ref": "#/components/schemas/ChatCompletionContentPartInputAudioParam" }, { "$ref": "#/components/schemas/File-Input" } ] }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "const": "user", "title": "Role" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "content", "role" ], "title": "ChatCompletionUserMessageParam", "description": "Messages sent by an end user, containing prompts or additional context\ninformation." }, "ConnectorConnectRequest": { "properties": { "redirect_url": { "anyOf": [ { "type": "string", "minLength": 1, "format": "uri" }, { "type": "null" } ], "title": "Redirect Url" }, "access_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Access Token" } }, "type": "object", "title": "ConnectorConnectRequest" }, "ConnectorCreateRequest": { "properties": { "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" }, "match_preset": { "type": "boolean", "title": "Match Preset", "default": true } }, "type": "object", "required": [ "url" ], "title": "ConnectorCreateRequest" }, "ConnectorPresetResponse": { "properties": { "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "url", "metadata" ], "title": "ConnectorPresetResponse" }, "ConnectorResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "url": { "type": "string", "minLength": 1, "format": "uri", "title": "Url" }, "state": { "$ref": "#/components/schemas/ConnectorState" }, "auth_request": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/AuthorizationCodeRequest" } ], "discriminator": { "propertyName": "type", "mapping": { "code": "#/components/schemas/AuthorizationCodeRequest" } } }, { "type": "null" } ], "title": "Auth Request" }, "disconnect_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disconnect Reason" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" } }, "type": "object", "required": [ "id", "url", "state", "auth_request", "disconnect_reason", "metadata", "created_at", "updated_at", "created_by" ], "title": "ConnectorResponse" }, "ConnectorState": { "type": "string", "enum": [ "created", "auth_required", "connected", "disconnected" ], "title": "ConnectorState" }, "Context": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "provider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "created_by" ], "title": "Context", "description": "A context that groups files and vector stores for LLM proxy token generation." }, "ContextCreateRequest": { "properties": { "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" }, "provider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" } }, "type": "object", "title": "ContextCreateRequest", "description": "Request schema for context creation." }, "ContextHistoryItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data": { "additionalProperties": true, "type": "object", "title": "Data" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "context_id": { "type": "string", "format": "uuid", "title": "Context Id" }, "kind": { "type": "string", "enum": [ "message", "artifact" ], "title": "Kind", "readOnly": true } }, "type": "object", "required": [ "data", "context_id", "kind" ], "title": "ContextHistoryItem" }, "ContextHistoryItemCreateRequest": { "additionalProperties": true, "type": "object", "title": "ContextHistoryItemCreateRequest" }, "ContextPatchMetadataRequest": { "properties": { "metadata": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object", "title": "Metadata", "description": "Metadata update, will add or overwrite existing keys, None will delete the key from metadata." } }, "type": "object", "required": [ "metadata" ], "title": "ContextPatchMetadataRequest", "description": "Request schema for patching context metadata." }, "ContextPermissionsGrant": { "properties": { "files": { "items": { "type": "string", "enum": [ "read", "write", "extract", "*" ] }, "type": "array", "title": "Files" }, "vector_stores": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Vector Stores" }, "context_data": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Context Data" } }, "type": "object", "title": "ContextPermissionsGrant" }, "ContextTokenCreateRequest": { "properties": { "grant_global_permissions": { "$ref": "#/components/schemas/GlobalPermissionGrant", "description": "Global permissions granted by the token. Must be subset of the users permissions" }, "grant_context_permissions": { "$ref": "#/components/schemas/ContextPermissionsGrant", "description": "Context permissions granted by the token. Must be subset of the users permissions" } }, "type": "object", "title": "ContextTokenCreateRequest" }, "ContextTokenResponse": { "properties": { "token": { "type": "string", "title": "Token" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "required": [ "token", "expires_at" ], "title": "ContextTokenResponse", "description": "Response schema for context token generation." }, "ContextUpdateRequest": { "properties": { "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "ContextUpdateRequest", "description": "Request schema for context update." }, "CreateModelProviderRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "type": { "$ref": "#/components/schemas/ModelProviderType" }, "base_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Base Url" }, "watsonx_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonx Project Id" }, "watsonx_space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonx Space Id" }, "api_key": { "type": "string", "title": "Api Key" } }, "type": "object", "required": [ "type", "base_url", "api_key" ], "title": "CreateModelProviderRequest" }, "CreateProviderRequest": { "properties": { "location": { "$ref": "#/components/schemas/NetworkProviderLocation" }, "agent_card": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Agent Card" }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Origin", "description": "A unique origin of the provider: most often a url. This is used to determine multiple versions of the same agent." } }, "type": "object", "required": [ "location" ], "title": "CreateProviderRequest" }, "CreateVectorStoreRequest": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the vector store" }, "dimension": { "type": "integer", "title": "Dimension", "description": "Dimension of the vectors to be stored" }, "model_id": { "type": "string", "title": "Model Id" } }, "type": "object", "required": [ "name", "dimension", "model_id" ], "title": "CreateVectorStoreRequest", "description": "Request to create a new vector store." }, "DocumentType": { "type": "string", "enum": [ "platform_file", "external" ], "title": "DocumentType" }, "EmbeddingsRequest": { "properties": { "model": { "type": "string", "title": "Model" }, "input": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "title": "Input" }, "encoding_format": { "anyOf": [ { "type": "string", "enum": [ "float", "base64" ] }, { "type": "null" } ], "title": "Encoding Format" } }, "type": "object", "required": [ "model", "input" ], "title": "EmbeddingsRequest", "description": "Corresponds to the arguments for OpenAI `client.embeddings.create(...)`." }, "ExtractedFileInfo": { "properties": { "file_id": { "type": "string", "format": "uuid", "title": "File Id" }, "format": { "anyOf": [ { "$ref": "#/components/schemas/ExtractionFormat" }, { "type": "null" } ] } }, "type": "object", "required": [ "file_id" ], "title": "ExtractedFileInfo", "description": "Information about an extracted file." }, "ExtractionFormat": { "type": "string", "enum": [ "markdown", "vendor_specific_json" ], "title": "ExtractionFormat" }, "ExtractionMetadata": { "properties": { "backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backend" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/TextExtractionSettings" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "title": "ExtractionMetadata" }, "ExtractionStatus": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed", "cancelled" ], "title": "ExtractionStatus" }, "File-Input": { "properties": { "file": { "$ref": "#/components/schemas/FileFile" }, "type": { "type": "string", "const": "file", "title": "Type" } }, "type": "object", "required": [ "file", "type" ], "title": "File", "description": "Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation." }, "File-Output": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "filename": { "type": "string", "title": "Filename" }, "content_type": { "type": "string", "maxLength": 256, "title": "Content Type" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "file_type": { "$ref": "#/components/schemas/FileType", "default": "user_upload" }, "parent_file_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent File Id" }, "context_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } }, "type": "object", "required": [ "filename", "content_type", "created_by" ], "title": "File" }, "FileFile": { "properties": { "file_data": { "type": "string", "title": "File Data" }, "file_id": { "type": "string", "title": "File Id" }, "filename": { "type": "string", "title": "Filename" } }, "type": "object", "title": "FileFile" }, "FileListQuery": { "properties": { "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit" }, "page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Page Token" }, "order": { "type": "string", "pattern": "^(asc|desc)$", "title": "Order" }, "order_by": { "type": "string", "pattern": "^created_at|filename|file_size_bytes$", "title": "Order By" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" }, "filename_search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename Search", "description": "Case-insensitive partial match search on filename (e.g., 'doc' matches 'my_document.pdf')" } }, "type": "object", "title": "FileListQuery", "description": "Query schema for listing files." }, "FileSystemModelProviderRegistryLocation": { "type": "string", "minLength": 1, "format": "uri", "title": "FileSystemModelProviderRegistryLocation" }, "FileType": { "type": "string", "enum": [ "user_upload", "extracted_text" ], "title": "FileType" }, "FunctionCall": { "properties": { "arguments": { "type": "string", "title": "Arguments" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "arguments", "name" ], "title": "FunctionCall", "description": "Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model." }, "FunctionDefinition": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "parameters": { "additionalProperties": true, "type": "object", "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "type": "object", "required": [ "name" ], "title": "FunctionDefinition" }, "GlobalPermissionGrant": { "properties": { "files": { "items": { "type": "string", "enum": [ "read", "write", "extract", "*" ] }, "type": "array", "title": "Files" }, "feedback": { "items": { "type": "string", "const": "write" }, "type": "array", "title": "Feedback" }, "vector_stores": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Vector Stores" }, "llm": { "items": { "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" } ] }, "type": "array", "title": "Llm" }, "embeddings": { "items": { "anyOf": [ { "type": "string", "const": "*" }, { "type": "string" } ] }, "type": "array", "title": "Embeddings" }, "model_providers": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Model Providers" }, "a2a_proxy": { "anyOf": [ { "items": { "type": "string", "const": "*" }, "type": "array" }, { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "title": "A2A Proxy" }, "providers": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Providers" }, "contexts": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Contexts" }, "context_data": { "items": { "type": "string", "enum": [ "read", "write", "*" ] }, "type": "array", "title": "Context Data" }, "connectors": { "items": { "type": "string", "enum": [ "read", "write", "proxy", "*" ] }, "type": "array", "title": "Connectors" } }, "type": "object", "title": "GlobalPermissionGrant" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ImageURL": { "properties": { "url": { "type": "string", "title": "Url" }, "detail": { "type": "string", "enum": [ "auto", "low", "high" ], "title": "Detail" } }, "type": "object", "required": [ "url" ], "title": "ImageURL" }, "InputAudio": { "properties": { "data": { "type": "string", "title": "Data" }, "format": { "type": "string", "enum": [ "wav", "mp3" ], "title": "Format" } }, "type": "object", "required": [ "data", "format" ], "title": "InputAudio" }, "InsertUserFeedbackRequest": { "properties": { "provider_id": { "type": "string", "format": "uuid", "title": "Provider Id" }, "task_id": { "type": "string", "format": "uuid", "title": "Task Id" }, "context_id": { "type": "string", "format": "uuid", "title": "Context Id" }, "rating": { "type": "integer", "title": "Rating", "description": "Rating thats either 1 or -1" }, "message": { "type": "string", "title": "Message" }, "comment_tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Comment Tags" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" } }, "type": "object", "required": [ "provider_id", "task_id", "context_id", "rating", "message" ], "title": "InsertUserFeedbackRequest", "description": "Request to create a user feedback." }, "JSONSchema": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "schema": { "additionalProperties": true, "type": "object", "title": "Schema" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "type": "object", "required": [ "name" ], "title": "JSONSchema", "description": "Structured Outputs configuration options, including a JSON Schema." }, "ListVariablesSchema": { "properties": { "variables": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Variables" } }, "type": "object", "required": [ "variables" ], "title": "ListVariablesSchema" }, "MatchModelsRequest": { "properties": { "suggested_models": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Suggested Models" }, "capability": { "$ref": "#/components/schemas/ModelCapability" }, "score_cutoff": { "type": "number", "title": "Score Cutoff", "default": 0.4 } }, "type": "object", "required": [ "capability" ], "title": "MatchModelsRequest" }, "Model": { "properties": { "id": { "type": "string", "title": "Id" }, "created": { "type": "integer", "title": "Created", "default": 0 }, "object": { "type": "string", "const": "model", "title": "Object", "default": "model" }, "owned_by": { "type": "string", "title": "Owned By", "default": "unknown" }, "provider": { "$ref": "#/components/schemas/ModelProviderInfo" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "additionalProperties": true, "type": "object", "required": [ "id", "provider" ], "title": "Model" }, "ModelCapability": { "type": "string", "enum": [ "llm", "embedding" ], "title": "ModelCapability" }, "ModelProvider": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human-readable name for the model provider" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional description of the provider" }, "type": { "$ref": "#/components/schemas/ModelProviderType", "description": "Type of model provider" }, "base_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Base Url", "description": "Base URL for the API (unique)" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "registry": { "anyOf": [ { "$ref": "#/components/schemas/FileSystemModelProviderRegistryLocation" }, { "type": "null" } ] }, "state": { "$ref": "#/components/schemas/ModelProviderState", "default": "online" }, "capabilities": { "items": { "$ref": "#/components/schemas/ModelCapability" }, "type": "array", "uniqueItems": true, "title": "Capabilities", "readOnly": true } }, "type": "object", "required": [ "type", "base_url", "capabilities" ], "title": "ModelProvider" }, "ModelProviderInfo": { "properties": { "capabilities": { "items": { "$ref": "#/components/schemas/ModelCapability" }, "type": "array", "uniqueItems": true, "title": "Capabilities" } }, "type": "object", "required": [ "capabilities" ], "title": "ModelProviderInfo" }, "ModelProviderState": { "type": "string", "enum": [ "online", "offline" ], "title": "ModelProviderState" }, "ModelProviderType": { "type": "string", "enum": [ "anthropic", "bedrock", "cerebras", "chutes", "cohere", "deepseek", "gemini", "github", "groq", "watsonx", "jan", "mistral", "moonshot", "nvidia", "ollama", "openai", "openrouter", "perplexity", "together", "voyage", "rits", "other" ], "title": "ModelProviderType" }, "ModelWithScore": { "properties": { "model_id": { "type": "string", "title": "Model Id" }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "model_id", "score" ], "title": "ModelWithScore" }, "NetworkProviderLocation": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "NetworkProviderLocation" }, "OpenAIPage_Model_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Model" }, "type": "array", "title": "Data" }, "object": { "type": "string", "const": "list", "title": "Object", "default": "list" } }, "type": "object", "required": [ "data" ], "title": "OpenAIPage[Model]" }, "PaginatedResult_ConnectorPresetResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConnectorPresetResponse" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[ConnectorPresetResponse]" }, "PaginatedResult_ConnectorResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConnectorResponse" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[ConnectorResponse]" }, "PaginatedResult_ContextHistoryItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ContextHistoryItem" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[ContextHistoryItem]" }, "PaginatedResult_Context_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Context" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[Context]" }, "PaginatedResult_File_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/File-Output" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[File]" }, "PaginatedResult_ModelOutput_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__1" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[EntityModel.__class_getitem__..ModelOutput]" }, "PaginatedResult_ModelProvider_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelProvider" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[ModelProvider]" }, "PaginatedResult_ModelWithScore_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ModelWithScore" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[ModelWithScore]" }, "PaginatedResult_UserFeedbackResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/UserFeedbackResponse" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[UserFeedbackResponse]" }, "PaginatedResult_VectorStoreDocument_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VectorStoreDocument" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[VectorStoreDocument]" }, "PaginatedResult_VectorStoreSearchResult_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VectorStoreSearchResult" }, "type": "array", "title": "Items" }, "total_count": { "type": "integer", "title": "Total Count" }, "has_more": { "type": "boolean", "title": "Has More", "default": false }, "next_page_token": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Next Page Token", "readOnly": true } }, "type": "object", "required": [ "items", "total_count", "next_page_token" ], "title": "PaginatedResult[VectorStoreSearchResult]" }, "Provider": { "properties": { "source": { "$ref": "#/components/schemas/NetworkProviderLocation" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "source_type": { "$ref": "#/components/schemas/SourceType", "default": "api" }, "origin": { "type": "string", "title": "Origin" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "agent_card": { "additionalProperties": true, "type": "object", "title": "Agent Card" }, "state": { "$ref": "#/components/schemas/ProviderState", "default": "online" } }, "type": "object", "required": [ "source", "origin", "created_by", "agent_card" ], "title": "Provider" }, "ProviderState": { "type": "string", "enum": [ "online", "offline" ], "title": "ProviderState" }, "ResponseFormatJSONObject": { "properties": { "type": { "type": "string", "const": "json_object", "title": "Type" } }, "type": "object", "required": [ "type" ], "title": "ResponseFormatJSONObject", "description": "JSON object response format.\n\nAn older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so." }, "ResponseFormatJSONSchema": { "properties": { "json_schema": { "$ref": "#/components/schemas/JSONSchema" }, "type": { "type": "string", "const": "json_schema", "title": "Type" } }, "type": "object", "required": [ "json_schema", "type" ], "title": "ResponseFormatJSONSchema", "description": "JSON Schema response format.\n\nUsed to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)." }, "ResponseFormatText": { "properties": { "type": { "type": "string", "const": "text", "title": "Type" } }, "type": "object", "required": [ "type" ], "title": "ResponseFormatText", "description": "Default response format. Used to generate text responses." }, "SearchRequest": { "properties": { "query_vector": { "items": { "type": "number" }, "type": "array", "title": "Query Vector", "description": "Vector to search for" }, "limit": { "type": "integer", "maximum": 10.0, "title": "Limit", "description": "Maximum number of results to return", "default": 5 } }, "type": "object", "required": [ "query_vector" ], "title": "SearchRequest", "description": "Request to search a vector store." }, "SourceType": { "type": "string", "enum": [ "kagenti", "api" ], "title": "SourceType" }, "TextExtractionRequest": { "properties": { "settings": { "anyOf": [ { "$ref": "#/components/schemas/TextExtractionSettings" }, { "type": "null" } ], "description": "Additional options for text extraction" } }, "type": "object", "title": "TextExtractionRequest", "description": "Request schema for text extraction." }, "TextExtractionSettings": { "properties": { "formats": { "items": { "$ref": "#/components/schemas/ExtractionFormat" }, "type": "array", "title": "Formats" } }, "type": "object", "title": "TextExtractionSettings" }, "UpdateConfigurationRequest": { "properties": { "default_llm_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Llm Model" }, "default_embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Embedding Model" } }, "type": "object", "title": "UpdateConfigurationRequest" }, "UpdateVariablesRequest": { "properties": { "variables": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object", "maxProperties": 100, "title": "Variables" } }, "type": "object", "required": [ "variables" ], "title": "UpdateVariablesRequest" }, "User": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "role": { "$ref": "#/components/schemas/UserRole", "default": "user" }, "email": { "type": "string", "format": "email", "title": "Email" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "email" ], "title": "User" }, "UserFeedbackResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "provider_id": { "type": "string", "format": "uuid", "title": "Provider Id" }, "task_id": { "type": "string", "format": "uuid", "title": "Task Id" }, "context_id": { "type": "string", "format": "uuid", "title": "Context Id" }, "rating": { "type": "integer", "title": "Rating" }, "message": { "type": "string", "title": "Message" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "comment_tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Comment Tags" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "agent_name": { "type": "string", "title": "Agent Name" } }, "type": "object", "required": [ "id", "provider_id", "task_id", "context_id", "rating", "message", "created_at", "agent_name" ], "title": "UserFeedbackResponse" }, "UserResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "role": { "$ref": "#/components/schemas/UserRole" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "email", "role", "created_at" ], "title": "UserResponse" }, "UserRole": { "type": "string", "enum": [ "admin", "developer", "user" ], "title": "UserRole" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VectorStoreDocument": { "properties": { "id": { "type": "string", "title": "Id" }, "vector_store_id": { "type": "string", "format": "uuid", "title": "Vector Store Id" }, "file_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "File Id" }, "usage_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Bytes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "vector_store_id" ], "title": "VectorStoreDocument" }, "VectorStoreItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "document_id": { "type": "string", "title": "Document Id" }, "document_type": { "$ref": "#/components/schemas/DocumentType", "default": "platform_file" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "string", "const": "platform" } ], "title": "Model Id", "default": "platform" }, "text": { "type": "string", "title": "Text" }, "embedding": { "items": { "type": "number" }, "type": "array", "title": "Embedding" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "document_id", "text", "embedding" ], "title": "VectorStoreItem", "description": "A single item in a vector store, containing text content and its vector embedding." }, "VectorStoreSearchResult": { "properties": { "item": { "$ref": "#/components/schemas/VectorStoreItem" }, "score": { "type": "number", "title": "Score" } }, "type": "object", "required": [ "item", "score" ], "title": "VectorStoreSearchResult", "description": "Result of a vector store search operation containing full item data and similarity score." }, "VectorStoreStats": { "properties": { "usage_bytes": { "type": "integer", "title": "Usage Bytes" }, "num_documents": { "type": "integer", "title": "Num Documents" } }, "type": "object", "required": [ "usage_bytes", "num_documents" ], "title": "VectorStoreStats" }, "VoiceID": { "properties": { "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "VoiceID", "description": "Custom voice reference." }, "WebSearchOptions": { "properties": { "search_context_size": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Search Context Size" }, "user_location": { "anyOf": [ { "$ref": "#/components/schemas/WebSearchOptionsUserLocation" }, { "type": "null" } ] } }, "type": "object", "title": "WebSearchOptions", "description": "This tool searches the web for relevant results to use in a response.\nLearn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat)." }, "WebSearchOptionsUserLocation": { "properties": { "approximate": { "$ref": "#/components/schemas/WebSearchOptionsUserLocationApproximate" }, "type": { "type": "string", "const": "approximate", "title": "Type" } }, "type": "object", "required": [ "approximate", "type" ], "title": "WebSearchOptionsUserLocation", "description": "Approximate location parameters for the search." }, "WebSearchOptionsUserLocationApproximate": { "properties": { "city": { "type": "string", "title": "City" }, "country": { "type": "string", "title": "Country" }, "region": { "type": "string", "title": "Region" }, "timezone": { "type": "string", "title": "Timezone" } }, "type": "object", "title": "WebSearchOptionsUserLocationApproximate", "description": "Approximate location parameters for the search." }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__1": { "properties": { "source": { "$ref": "#/components/schemas/NetworkProviderLocation" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "source_type": { "$ref": "#/components/schemas/SourceType", "default": "api" }, "origin": { "type": "string", "title": "Origin" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "agent_card": { "additionalProperties": true, "type": "object", "title": "Agent Card" }, "state": { "$ref": "#/components/schemas/ProviderState", "default": "online" } }, "type": "object", "required": [ "source", "id", "origin", "created_by", "agent_card" ], "title": "ProviderResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__10": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "file_id": { "type": "string", "format": "uuid", "title": "File Id" }, "extracted_files": { "items": { "$ref": "#/components/schemas/ExtractedFileInfo" }, "type": "array", "title": "Extracted Files" }, "status": { "$ref": "#/components/schemas/ExtractionStatus", "default": "pending" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Id" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "extraction_metadata": { "anyOf": [ { "$ref": "#/components/schemas/ExtractionMetadata" }, { "type": "null" } ] }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "file_id" ], "title": "TextExtractionResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__11": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "file_id": { "type": "string", "format": "uuid", "title": "File Id" }, "extracted_files": { "items": { "$ref": "#/components/schemas/ExtractedFileInfo" }, "type": "array", "title": "Extracted Files" }, "status": { "$ref": "#/components/schemas/ExtractionStatus", "default": "pending" }, "job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Id" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "extraction_metadata": { "anyOf": [ { "$ref": "#/components/schemas/ExtractionMetadata" }, { "type": "null" } ] }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "file_id" ], "title": "TextExtractionResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__12": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "provider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "id", "created_by" ], "title": "ContextResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__13": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "provider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "id", "created_by" ], "title": "ContextResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__14": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "provider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "id", "created_by" ], "title": "ContextResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__15": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "provider_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Provider Id" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object", "description": "\nSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional\ninformation about the object in a structured format, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings with a maximum length of\n512 characters.\n" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "id", "created_by" ], "title": "ContextResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__16": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "model_id": { "type": "string", "title": "Model Id" }, "dimension": { "type": "integer", "exclusiveMaximum": 10000.0, "exclusiveMinimum": 0.0, "title": "Dimension" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/VectorStoreStats" }, { "type": "null" } ] }, "context_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } }, "type": "object", "required": [ "id", "model_id", "dimension", "created_by" ], "title": "VectorStoreResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__17": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "model_id": { "type": "string", "title": "Model Id" }, "dimension": { "type": "integer", "exclusiveMaximum": 10000.0, "exclusiveMinimum": 0.0, "title": "Dimension" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "stats": { "anyOf": [ { "$ref": "#/components/schemas/VectorStoreStats" }, { "type": "null" } ] }, "context_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } }, "type": "object", "required": [ "id", "model_id", "dimension", "created_by" ], "title": "VectorStoreResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__2": { "properties": { "source": { "$ref": "#/components/schemas/NetworkProviderLocation" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "source_type": { "$ref": "#/components/schemas/SourceType", "default": "api" }, "origin": { "type": "string", "title": "Origin" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "agent_card": { "additionalProperties": true, "type": "object", "title": "Agent Card" }, "state": { "$ref": "#/components/schemas/ProviderState", "default": "online" } }, "type": "object", "required": [ "source", "id", "origin", "created_by", "agent_card" ], "title": "ProviderResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__3": { "properties": { "source": { "$ref": "#/components/schemas/NetworkProviderLocation" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "source_type": { "$ref": "#/components/schemas/SourceType", "default": "api" }, "origin": { "type": "string", "title": "Origin" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "last_active_at": { "type": "string", "format": "date-time", "title": "Last Active At" }, "agent_card": { "additionalProperties": true, "type": "object", "title": "Agent Card" }, "state": { "$ref": "#/components/schemas/ProviderState", "default": "online" } }, "type": "object", "required": [ "source", "id", "origin", "created_by", "agent_card" ], "title": "ProviderResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__4": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human-readable name for the model provider" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional description of the provider" }, "type": { "$ref": "#/components/schemas/ModelProviderType", "description": "Type of model provider" }, "base_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Base Url", "description": "Base URL for the API (unique)" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "registry": { "anyOf": [ { "$ref": "#/components/schemas/FileSystemModelProviderRegistryLocation" }, { "type": "null" } ] }, "state": { "$ref": "#/components/schemas/ModelProviderState", "default": "online" }, "capabilities": { "items": { "$ref": "#/components/schemas/ModelCapability" }, "type": "array", "uniqueItems": true, "title": "Capabilities", "readOnly": true } }, "type": "object", "required": [ "id", "type", "base_url", "capabilities" ], "title": "ModelProviderResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__5": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human-readable name for the model provider" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional description of the provider" }, "type": { "$ref": "#/components/schemas/ModelProviderType", "description": "Type of model provider" }, "base_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Base Url", "description": "Base URL for the API (unique)" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "registry": { "anyOf": [ { "$ref": "#/components/schemas/FileSystemModelProviderRegistryLocation" }, { "type": "null" } ] }, "state": { "$ref": "#/components/schemas/ModelProviderState", "default": "online" }, "capabilities": { "items": { "$ref": "#/components/schemas/ModelCapability" }, "type": "array", "uniqueItems": true, "title": "Capabilities", "readOnly": true } }, "type": "object", "required": [ "id", "type", "base_url", "capabilities" ], "title": "ModelProviderResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__6": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "default_llm_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Llm Model", "description": "Default LLM model (e.g., 'openai:gpt-4o')" }, "default_embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Embedding Model", "description": "Default embedding model (e.g., 'openai:text-embedding-3-small')" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" } }, "type": "object", "required": [ "id", "created_by" ], "title": "SystemConfigurationResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__7": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "default_llm_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Llm Model", "description": "Default LLM model (e.g., 'openai:gpt-4o')" }, "default_embedding_model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Embedding Model", "description": "Default embedding model (e.g., 'openai:text-embedding-3-small')" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" } }, "type": "object", "required": [ "id", "created_by" ], "title": "SystemConfigurationResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__8": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "filename": { "type": "string", "title": "Filename" }, "content_type": { "type": "string", "maxLength": 256, "title": "Content Type" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "file_type": { "$ref": "#/components/schemas/FileType", "default": "user_upload" }, "parent_file_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent File Id" }, "context_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } }, "type": "object", "required": [ "id", "filename", "content_type", "created_by" ], "title": "FileResponse" }, "adk_server__api__schema__common__EntityModel____class_getitem_____locals___ModelOutput__9": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "filename": { "type": "string", "title": "Filename" }, "content_type": { "type": "string", "maxLength": 256, "title": "Content Type" }, "file_size_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "File Size Bytes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "created_by": { "type": "string", "format": "uuid", "title": "Created By" }, "file_type": { "$ref": "#/components/schemas/FileType", "default": "user_upload" }, "parent_file_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent File Id" }, "context_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Context Id" } }, "type": "object", "required": [ "id", "filename", "content_type", "created_by" ], "title": "FileResponse" }, "openai__types__chat__chat_completion_message_custom_tool_call_param__Custom": { "properties": { "input": { "type": "string", "title": "Input" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "input", "name" ], "title": "Custom", "description": "The custom tool that the model called." }, "openai__types__chat__chat_completion_message_function_tool_call_param__Function": { "properties": { "arguments": { "type": "string", "title": "Arguments" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "arguments", "name" ], "title": "Function", "description": "The function that the model called." }, "openai__types__chat__chat_completion_named_tool_choice_custom_param__Custom": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "Custom" }, "openai__types__chat__chat_completion_named_tool_choice_param__Function": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "Function" }, "openai__types__chat__completion_create_params__Function": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "parameters": { "additionalProperties": true, "type": "object", "title": "Parameters" } }, "type": "object", "required": [ "name" ], "title": "Function" } }, "securitySchemes": { "HTTPBasic": { "type": "http", "scheme": "basic" }, "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }