diff --git a/.github/workflows/check-lazy-openapi-snapshot.yml b/.github/workflows/check-lazy-openapi-snapshot.yml new file mode 100644 index 00000000000..e3fd21a2145 --- /dev/null +++ b/.github/workflows/check-lazy-openapi-snapshot.yml @@ -0,0 +1,59 @@ +name: Check Lazy OpenAPI Snapshot Sync + +on: + pull_request: + paths: + - "litellm/proxy/**" + - "litellm/types/**" + - "enterprise/**" + - "uv.lock" + - ".github/workflows/check-lazy-openapi-snapshot.yml" + +permissions: + contents: read + +jobs: + check-sync: + name: Verify _lazy_openapi_snapshot.json matches the proxy routes + runs-on: ubuntu-latest + timeout-minutes: 15 + steps: + - name: Checkout repository + uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0 + with: + persist-credentials: false + + - name: Set up Python + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 + with: + python-version: "3.12" + + - name: Set up uv + uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7 + with: + version: "0.10.9" + + - name: Cache uv dependencies + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: | + ~/.cache/uv + .venv + key: ${{ runner.os }}-uv-${{ hashFiles('uv.lock') }} + restore-keys: | + ${{ runner.os }}-uv- + + - name: Install backend dependencies + run: .github/scripts/uv_sync_with_retries.sh --frozen --group ci --group proxy-dev --extra google --extra proxy --extra semantic-router + + - name: Generate Prisma client + env: + PRISMA_BINARY_CACHE_DIR: ${{ runner.temp }}/prisma-cache + run: uv run --no-sync prisma generate --schema litellm/proxy/schema.prisma + + - name: Fail if the snapshot is stale + run: | + if ! uv run --no-sync python -m litellm.proxy._lazy_openapi_snapshot --check; then + echo "::error file=litellm/proxy/_lazy_openapi_snapshot.json::Lazy OpenAPI snapshot is out of sync with the proxy routes." + exit 1 + fi diff --git a/litellm/proxy/_lazy_openapi_snapshot.json b/litellm/proxy/_lazy_openapi_snapshot.json index 27cdc483d4a..3733cfffe41 100644 --- a/litellm/proxy/_lazy_openapi_snapshot.json +++ b/litellm/proxy/_lazy_openapi_snapshot.json @@ -17,6 +17,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -234,27 +241,149 @@ "a2a" ] } - }, - "/v1/a2a/{agent_id}/message/send": { - "post": { - "description": "Invoke an agent using the A2A protocol (JSON-RPC 2.0).\n\nSupported methods:\n- message/send: Send a message and get a response\n- message/stream: Send a message and stream the response", - "operationId": "invoke_agent_a2a_v1_a2a__agent_id__message_send_post", - "parameters": [ - { - "in": "path", - "name": "agent_id", - "required": true, - "schema": { - "title": "Agent Id", - "type": "string" - } + } + } + }, + "a2a_registration": { + "components": { + "schemas": { + "DiscoverAgentRequest": { + "properties": { + "discovery_mode": { + "$ref": "#/components/schemas/DiscoveryMode", + "default": "well_known_fallback", + "description": "How to locate the upstream card. ``well_known_fallback`` for pure A2A agents (try standard paths); ``langgraph_platform`` for LangGraph Platform deployments where the card is shared across assistants and disambiguated by a query parameter." + }, + "params": { + "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Mode-specific parameters. ``langgraph_platform`` requires ``{'assistant_id': }``. ``well_known_fallback`` ignores this.", + "title": "Params" + }, + "url": { + "description": "Base URL of the upstream agent. Behavior depends on ``discovery_mode``: ``well_known_fallback`` (default) tries /.well-known/agent-card.json, /.well-known/agent.json, /agent.json under this URL in order; ``langgraph_platform`` hits ``/.well-known/agent-card.json?assistant_id=`` instead.", + "title": "Url", + "type": "string" } + }, + "required": [ + "url" ], + "title": "DiscoverAgentRequest", + "type": "object" + }, + "DiscoverAgentResponse": { + "properties": { + "agent_card": { + "additionalProperties": true, + "title": "Agent Card", + "type": "object" + }, + "url": { + "title": "Url", + "type": "string" + } + }, + "required": [ + "url", + "agent_card" + ], + "title": "DiscoverAgentResponse", + "type": "object" + }, + "DiscoveryMode": { + "description": "How to locate the upstream agent card.\n\nString-valued so it serializes cleanly over JSON / Pydantic.", + "enum": [ + "well_known_fallback", + "langgraph_platform" + ], + "title": "DiscoveryMode", + "type": "string" + }, + "HTTPValidationError": { + "properties": { + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "title": "Detail", + "type": "array" + } + }, + "title": "HTTPValidationError", + "type": "object" + }, + "ValidationError": { + "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, + "loc": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "title": "Location", + "type": "array" + }, + "msg": { + "title": "Message", + "type": "string" + }, + "type": { + "title": "Error Type", + "type": "string" + } + }, + "required": [ + "loc", + "msg", + "type" + ], + "title": "ValidationError", + "type": "object" + } + } + }, + "paths": { + "/v1/a2a/discover": { + "post": { + "description": "Fetch the upstream agent's well-known card so the UI can show the admin\nwhich skills/capabilities the agent exposes.\n\nOnly proxy admins can call this \u2014 the UI uses it during agent registration,\nand we don't want arbitrary keys probing internal URLs.\n\nExample:\n```bash\ncurl -X POST \"http://localhost:4000/v1/a2a/discover\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"url\": \"https://upstream-agent.example.com\"}'\n```", + "operationId": "discover_agent_card_v1_a2a_discover_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DiscoverAgentRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/DiscoverAgentResponse" + } } }, "description": "Successful Response" @@ -275,9 +404,9 @@ "APIKeyHeader": [] } ], - "summary": "Invoke Agent A2A", + "summary": "Discover Agent Card", "tags": [ - "a2a" + "a2a_registration" ] } } @@ -782,6 +911,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -1939,6 +2075,41 @@ "title": "AgentInterface", "type": "object" }, + "AgentKeySummary": { + "properties": { + "key_alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Key Alias" + }, + "key_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Key Name" + }, + "token": { + "title": "Token", + "type": "string" + } + }, + "required": [ + "token" + ], + "title": "AgentKeySummary", + "type": "object" + }, "AgentMakePublicResponse": { "properties": { "message": { @@ -2111,6 +2282,20 @@ ], "title": "Extra Headers" }, + "keys": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/AgentKeySummary" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Keys" + }, "litellm_params": { "anyOf": [ { @@ -2927,6 +3112,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -3171,7 +3363,7 @@ ] }, "post": { - "description": "Create a new agent\n\nExample Request:\n```bash\ncurl -X POST \"http://localhost:4000/v1/agents\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"agent_name\": \"my-custom-agent\",\n \"agent_card_params\": {\n \"protocolVersion\": \"1.0\",\n \"name\": \"Hello World Agent\",\n \"description\": \"Just a hello world agent\",\n \"url\": \"http://localhost:9999/\",\n \"version\": \"1.0.0\",\n \"defaultInputModes\": [\"text\"],\n \"defaultOutputModes\": [\"text\"],\n \"capabilities\": {\n \"streaming\": true\n },\n \"skills\": [\n {\n \"id\": \"hello_world\",\n \"name\": \"Returns hello world\",\n \"description\": \"just returns hello world\",\n \"tags\": [\"hello world\"],\n \"examples\": [\"hi\", \"hello world\"]\n }\n ]\n },\n \"litellm_params\": {\n \"make_public\": true\n }\n }'\n```", + "description": "Create a new agent\n\nExample Request:\n```bash\ncurl -X POST \"http://localhost:4000/v1/agents\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"agent_name\": \"my-custom-agent\",\n \"agent_card_params\": {\n \"protocolVersion\": \"1.0\",\n \"name\": \"Hello World Agent\",\n \"description\": \"Just a hello world agent\",\n \"url\": \"http://localhost:9999/\",\n \"version\": \"1.0.0\",\n \"defaultInputModes\": [\"text\"],\n \"defaultOutputModes\": [\"text\"],\n \"capabilities\": {\n \"streaming\": true\n },\n \"skills\": [\n {\n \"id\": \"hello_world\",\n \"name\": \"Returns hello world\",\n \"description\": \"just returns hello world\",\n \"tags\": [\"hello world\"],\n \"examples\": [\"hi\", \"hello world\"]\n }\n ]\n },\n \"litellm_params\": {\n \"make_public\": true\n }\n }'\n```", "operationId": "create_agent_v1_agents_post", "requestBody": { "content": { @@ -3265,7 +3457,7 @@ }, "/v1/agents/{agent_id}": { "delete": { - "description": "Delete an agent\n\nExample Request:\n```bash\ncurl -X DELETE \"http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \"\n```\n\nExample Response:\n```json\n{\n \"message\": \"Agent 123e4567-e89b-12d3-a456-426614174000 deleted successfully\"\n}\n```", + "description": "Delete an agent\n\nExample Request:\n```bash\ncurl -X DELETE \"http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \"\n```\n\nExample Response:\n```json\n{\n \"message\": \"Agent 123e4567-e89b-12d3-a456-426614174000 deleted successfully\"\n}\n```", "operationId": "delete_agent_v1_agents__agent_id__delete", "parameters": [ { @@ -3309,7 +3501,7 @@ ] }, "get": { - "description": "Get a specific agent by ID\n\nExample Request:\n```bash\ncurl -X GET \"http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \"\n```", + "description": "Get a specific agent by ID\n\nExample Request:\n```bash\ncurl -X GET \"http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \"\n```", "operationId": "get_agent_by_id_v1_agents__agent_id__get", "parameters": [ { @@ -3355,7 +3547,7 @@ ] }, "patch": { - "description": "Update an existing agent\n\nExample Request:\n```bash\ncurl -X PUT \"http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"agent\": {\n \"agent_name\": \"updated-agent\",\n \"agent_card_params\": {\n \"protocolVersion\": \"1.0\",\n \"name\": \"Updated Agent\",\n \"description\": \"Updated description\",\n \"url\": \"http://localhost:9999/\",\n \"version\": \"1.1.0\",\n \"defaultInputModes\": [\"text\"],\n \"defaultOutputModes\": [\"text\"],\n \"capabilities\": {\n \"streaming\": true\n },\n \"skills\": []\n },\n \"litellm_params\": {\n \"make_public\": false\n }\n }\n }'\n```", + "description": "Update an existing agent\n\nExample Request:\n```bash\ncurl -X PATCH \"http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"agent_name\": \"updated-agent\",\n \"agent_card_params\": {\n \"protocolVersion\": \"1.0\",\n \"name\": \"Updated Agent\",\n \"description\": \"Updated description\",\n \"url\": \"http://localhost:9999/\",\n \"version\": \"1.1.0\",\n \"defaultInputModes\": [\"text\"],\n \"defaultOutputModes\": [\"text\"],\n \"capabilities\": {\n \"streaming\": true\n },\n \"skills\": []\n },\n \"litellm_params\": {\n \"make_public\": false\n }\n }'\n```", "operationId": "patch_agent_v1_agents__agent_id__patch", "parameters": [ { @@ -3411,7 +3603,7 @@ ] }, "put": { - "description": "Update an existing agent\n\nExample Request:\n```bash\ncurl -X PUT \"http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"agent\": {\n \"agent_name\": \"updated-agent\",\n \"agent_card_params\": {\n \"protocolVersion\": \"1.0\",\n \"name\": \"Updated Agent\",\n \"description\": \"Updated description\",\n \"url\": \"http://localhost:9999/\",\n \"version\": \"1.1.0\",\n \"defaultInputModes\": [\"text\"],\n \"defaultOutputModes\": [\"text\"],\n \"capabilities\": {\n \"streaming\": true\n },\n \"skills\": []\n },\n \"litellm_params\": {\n \"make_public\": false\n }\n }\n }'\n```", + "description": "Update an existing agent\n\nExample Request:\n```bash\ncurl -X PUT \"http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"agent_name\": \"updated-agent\",\n \"agent_card_params\": {\n \"protocolVersion\": \"1.0\",\n \"name\": \"Updated Agent\",\n \"description\": \"Updated description\",\n \"url\": \"http://localhost:9999/\",\n \"version\": \"1.1.0\",\n \"defaultInputModes\": [\"text\"],\n \"defaultOutputModes\": [\"text\"],\n \"capabilities\": {\n \"streaming\": true\n },\n \"skills\": []\n },\n \"litellm_params\": {\n \"make_public\": false\n }\n }'\n```", "operationId": "update_agent_v1_agents__agent_id__put", "parameters": [ { @@ -3535,6 +3727,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -3989,6 +4188,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -4651,6 +4857,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -5250,6 +5463,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -5662,6 +5882,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -5978,6 +6205,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -6016,6 +6250,26 @@ "delete": { "description": "Delete Hashicorp Vault configuration. Idempotent.", "operationId": "delete_hashicorp_vault_config_config_overrides_hashicorp_vault_delete", + "parameters": [ + { + "description": "The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability", + "in": "header", + "name": "litellm-changed-by", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability", + "title": "Litellm-Changed-By" + } + } + ], "responses": { "200": { "content": { @@ -6024,6 +6278,16 @@ } }, "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" } }, "security": [ @@ -6064,6 +6328,26 @@ "post": { "description": "Update Hashicorp Vault secret manager configuration.\nSets environment variables, encrypts sensitive fields, and stores in DB.\nReinitializes the secret manager on this pod.", "operationId": "update_hashicorp_vault_config_config_overrides_hashicorp_vault_post", + "parameters": [ + { + "description": "The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability", + "in": "header", + "name": "litellm-changed-by", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability", + "title": "Litellm-Changed-By" + } + } + ], "requestBody": { "content": { "application/json": { @@ -6665,6 +6949,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -7559,6 +7850,251 @@ } } }, + "gemini_agents": { + "components": { + "schemas": { + "HTTPValidationError": { + "properties": { + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "title": "Detail", + "type": "array" + } + }, + "title": "HTTPValidationError", + "type": "object" + }, + "ValidationError": { + "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, + "loc": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "title": "Location", + "type": "array" + }, + "msg": { + "title": "Message", + "type": "string" + }, + "type": { + "title": "Error Type", + "type": "string" + } + }, + "required": [ + "loc", + "msg", + "type" + ], + "title": "ValidationError", + "type": "object" + } + } + }, + "paths": { + "/v1beta/agents": { + "get": { + "description": "List all custom agents on the Gemini side.\n\nPass per-request Gemini credentials via the JSON-encoded\n``litellm_params_template`` query parameter. Flat query parameters\n(e.g. ``?api_key=AIza...``) are intentionally ignored \u2014 see\n``_merge_query_params_into_data`` for the rationale.\n\n```bash\ncurl \"http://localhost:4000/v1beta/agents?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D\" \\\n -H \"Authorization: Bearer sk-...\"\n```", + "operationId": "list_gemini_agents_v1beta_agents_get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": {} + } + }, + "description": "Successful Response" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "List Gemini Agents", + "tags": [ + "gemini_agents" + ] + }, + "post": { + "description": "Create a named custom agent on the Gemini side.\n\nExample:\n```bash\ncurl -X POST \"http://localhost:4000/v1beta/agents\" \\\n -H \"Authorization: Bearer sk-...\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"my-custom-slides-agent\",\n \"base_agent\": \"waverunner\",\n \"instructions\": \"You are a helpful assistant that creates slides.\",\n \"base_environment\": {\n \"type\": \"remote\",\n \"sources\": [\n {\"type\": \"gcs\", \"source\": \"gs://eap-templates/slides-skill\",\n \"target\": \"/.agents/skills/slides-skill\"}\n ]\n }\n }'\n```", + "operationId": "create_gemini_agent_v1beta_agents_post", + "responses": { + "200": { + "content": { + "application/json": { + "schema": {} + } + }, + "description": "Successful Response" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Create Gemini Agent", + "tags": [ + "gemini_agents" + ] + } + }, + "/v1beta/agents/{name}": { + "delete": { + "description": "Delete a custom agent by name.\n\nPass per-request Gemini credentials via the JSON-encoded\n``litellm_params_template`` query parameter. Flat query parameters\n(e.g. ``?api_key=AIza...``) are intentionally ignored \u2014 see\n``_merge_query_params_into_data`` for the rationale.\n\n```bash\ncurl -X DELETE \"http://localhost:4000/v1beta/agents/my-custom-slides-agent?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D\" \\\n -H \"Authorization: Bearer sk-...\"\n```", + "operationId": "delete_gemini_agent_v1beta_agents__name__delete", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "title": "Name", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": {} + } + }, + "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Delete Gemini Agent", + "tags": [ + "gemini_agents" + ] + }, + "get": { + "description": "Get a specific custom agent by name.\n\nPass per-request Gemini credentials via the JSON-encoded\n``litellm_params_template`` query parameter. Flat query parameters\n(e.g. ``?api_key=AIza...``) are intentionally ignored \u2014 see\n``_merge_query_params_into_data`` for the rationale.\n\n```bash\ncurl \"http://localhost:4000/v1beta/agents/my-custom-slides-agent?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D\" \\\n -H \"Authorization: Bearer sk-...\"\n```", + "operationId": "get_gemini_agent_v1beta_agents__name__get", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "title": "Name", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": {} + } + }, + "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Get Gemini Agent", + "tags": [ + "gemini_agents" + ] + } + }, + "/v1beta/agents/{name}/versions": { + "get": { + "description": "List versions of a custom agent.\n\nPass per-request Gemini credentials via the JSON-encoded\n``litellm_params_template`` query parameter. Flat query parameters\n(e.g. ``?api_key=AIza...``) are intentionally ignored \u2014 see\n``_merge_query_params_into_data`` for the rationale.\n\n```bash\ncurl \"http://localhost:4000/v1beta/agents/my-custom-slides-agent/versions?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D\" \\\n -H \"Authorization: Bearer sk-...\"\n```", + "operationId": "list_gemini_agent_versions_v1beta_agents__name__versions_get", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { + "title": "Name", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": {} + } + }, + "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "List Gemini Agent Versions", + "tags": [ + "gemini_agents" + ] + } + } + } + }, "guardrails": { "components": { "schemas": { @@ -7638,7 +8174,7 @@ "title": "ApplyGuardrailResponse", "type": "object" }, - "BaseLitellmParams-Input": { + "BaseLitellmParams": { "additionalProperties": true, "properties": { "additional_provider_specific_params": { @@ -7842,7 +8378,7 @@ } ], "default": true, - "description": "Whether to fail the request if Model Armor encounters an error", + "description": "Whether to fail the request if the guardrail encounters an error. Implemented by guardrail='model_armor' and 'generic_guardrail_api'. True (default) raises the error. False logs a critical error and lets the request proceed, so only a valid guardrail response can block or modify it.", "title": "Fail On Error" }, "guard_name": { @@ -7917,6 +8453,22 @@ "description": "Optional field if guardrail requires a 'model' parameter", "title": "Model" }, + "on_sensitive_data": { + "anyOf": [ + { + "enum": [ + "block", + "route" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Action to take when sensitive data is detected. 'block' raises an exception (default behavior). 'route' reroutes the request to the model specified in sensitive_data_route_to_model.", + "title": "On Sensitive Data" + }, "on_violation": { "anyOf": [ { @@ -7996,6 +8548,18 @@ "description": "The message the bot speaks aloud when a /v1/realtime guardrail fires. Falls back to violation_message_template if not set.", "title": "Realtime Violation Message" }, + "sensitive_data_route_to_model": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Model to route requests to when sensitive data is detected and on_sensitive_data='route'. This is typically an on-premise model for data privacy. The routing decision persists for the entire session.", + "title": "Sensitive Data Route To Model" + }, "severity_threshold": { "anyOf": [ { @@ -8020,174 +8584,7 @@ "description": "When True, unified guardrails skip system-role messages when building evaluation inputs (texts and structured_messages). When False, system messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_system_message_in_guardrail setting.", "title": "Skip System Message In Guardrail" }, - "template_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The ID of your Model Armor template", - "title": "Template Id" - }, - "unreachable_fallback": { - "default": "fail_closed", - "description": "Behavior when a guardrail endpoint is unreachable due to network errors. NOTE: This is currently only implemented by guardrail='generic_guardrail_api'. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and allows the request to proceed.", - "enum": [ - "fail_closed", - "fail_open" - ], - "title": "Unreachable Fallback", - "type": "string" - }, - "violation_message_template": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Custom message when a guardrail blocks an action. Supports placeholders like {tool_name}, {rule_id}, and {default_message}.", - "title": "Violation Message Template" - } - }, - "title": "BaseLitellmParams", - "type": "object" - }, - "BaseLitellmParams-Output": { - "additionalProperties": true, - "properties": { - "additional_provider_specific_params": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Additional provider-specific parameters for generic guardrail APIs", - "title": "Additional Provider Specific Params" - }, - "api_base": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Base URL for the guardrail service API", - "title": "Api Base" - }, - "api_endpoint": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Optional custom API endpoint for Model Armor", - "title": "Api Endpoint" - }, - "api_key": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "API key for the guardrail service", - "title": "Api Key" - }, - "blocked_words": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/BlockedWord" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "description": "List of blocked words with individual actions", - "title": "Blocked Words" - }, - "blocked_words_file": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Path to YAML file containing blocked_words list", - "title": "Blocked Words File" - }, - "categories": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/ContentFilterCategoryConfig" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "description": "List of prebuilt categories to enable (harmful_*, bias_*)", - "title": "Categories" - }, - "category_thresholds": { - "anyOf": [ - { - "$ref": "#/components/schemas/LakeraCategoryThresholds" - }, - { - "type": "null" - } - ], - "description": "Threshold configuration for Lakera guardrail categories" - }, - "credentials": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Path to Google Cloud credentials JSON file or JSON string", - "title": "Credentials" - }, - "custom_code": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Python-like code containing the apply_guardrail function for custom guardrail logic", - "title": "Custom Code" - }, - "default_on": { + "skip_tool_message_in_guardrail": { "anyOf": [ { "type": "boolean" @@ -8196,63 +8593,10 @@ "type": "null" } ], - "description": "Whether the guardrail is enabled by default", - "title": "Default On" + "description": "When True, unified guardrails skip tool-role messages when building evaluation inputs (texts and structured_messages). When False, tool messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_tool_message_in_guardrail setting.", + "title": "Skip Tool Message In Guardrail" }, - "detect_secrets_config": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Configuration for detect-secrets guardrail", - "title": "Detect Secrets Config" - }, - "end_session_after_n_fails": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "description": "For /v1/realtime sessions: automatically close the session after this many guardrail violations.", - "title": "End Session After N Fails" - }, - "experimental_use_latest_role_message_only": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "default": false, - "description": "When True, guardrails only receive the latest message for the relevant role (e.g., newest user input pre-call, newest assistant output post-call)", - "title": "Experimental Use Latest Role Message Only" - }, - "extra_headers": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "description": "Header names to forward from the client request to the guardrail (e.g. x-request-id). Only these headers' values are sent; others may be omitted or sent as [present]. Used by generic_guardrail_api (similar to MCP extra_headers).", - "title": "Extra Headers" - }, - "fail_on_error": { + "sticky_session_routing": { "anyOf": [ { "type": "boolean" @@ -8262,183 +8606,8 @@ } ], "default": true, - "description": "Whether to fail the request if Model Armor encounters an error", - "title": "Fail On Error" - }, - "guard_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Name of the guardrail in guardrails.ai", - "title": "Guard Name" - }, - "keyword_redaction_tag": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Tag to use for keyword redaction", - "title": "Keyword Redaction Tag" - }, - "location": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Google Cloud location/region (e.g., us-central1)", - "title": "Location" - }, - "mask_request_content": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "description": "Will mask request content if guardrail makes any changes", - "title": "Mask Request Content" - }, - "mask_response_content": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "description": "Will mask response content if guardrail makes any changes", - "title": "Mask Response Content" - }, - "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Optional field if guardrail requires a 'model' parameter", - "title": "Model" - }, - "on_violation": { - "anyOf": [ - { - "enum": [ - "warn", - "end_session" - ], - "type": "string" - }, - { - "type": "null" - } - ], - "description": "For /v1/realtime sessions: 'warn' speaks the violation message and continues; 'end_session' speaks the message and closes the connection.", - "title": "On Violation" - }, - "pangea_input_recipe": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Recipe for input (LLM request)", - "title": "Pangea Input Recipe" - }, - "pangea_output_recipe": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Recipe for output (LLM response)", - "title": "Pangea Output Recipe" - }, - "pattern_redaction_format": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Format string for pattern redaction (use {pattern_name} placeholder)", - "title": "Pattern Redaction Format" - }, - "patterns": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/ContentFilterPattern" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "description": "List of patterns (prebuilt or custom regex) to detect", - "title": "Patterns" - }, - "realtime_violation_message": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The message the bot speaks aloud when a /v1/realtime guardrail fires. Falls back to violation_message_template if not set.", - "title": "Realtime Violation Message" - }, - "severity_threshold": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Minimum severity to block (high, medium, low)", - "title": "Severity Threshold" - }, - "skip_system_message_in_guardrail": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "description": "When True, unified guardrails skip system-role messages when building evaluation inputs (texts and structured_messages). When False, system messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_system_message_in_guardrail setting.", - "title": "Skip System Message In Guardrail" + "description": "When True (default), after sensitive data is detected and routed, all subsequent requests in the same session will continue routing to the same model.", + "title": "Sticky Session Routing" }, "template_id": { "anyOf": [ @@ -8452,9 +8621,21 @@ "description": "The ID of your Model Armor template", "title": "Template Id" }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Per-request timeout for the guardrail provider API call (seconds). Accepts int, float, or numeric string; coerced to float on load. Each guardrail handler chooses its own default when unset.", + "title": "Timeout" + }, "unreachable_fallback": { "default": "fail_closed", - "description": "Behavior when a guardrail endpoint is unreachable due to network errors. NOTE: This is currently only implemented by guardrail='generic_guardrail_api'. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and allows the request to proceed.", + "description": "Behavior when a guardrail endpoint is unreachable due to network errors. Implemented by guardrail='generic_guardrail_api', 'akto', 'vigil_guard', 'repelloai', and 'headroom'. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and allows the request to proceed.", "enum": [ "fail_closed", "fail_open" @@ -8510,6 +8691,187 @@ "title": "BlockedWord", "type": "object" }, + "CiscoAIDefenseGuardrailConfigModelOptionalParams": { + "additionalProperties": true, + "description": "Optional parameters for the Cisco AI Defense guardrail.", + "properties": { + "enabled_rules": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/CiscoAIDefenseRule" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Explicit list of Cisco AI Defense rules to evaluate. If omitted, the policies configured for the API key in the Cisco AI Defense UI are used.", + "title": "Enabled Rules" + }, + "fallback_on_error": { + "anyOf": [ + { + "enum": [ + "allow", + "block" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "default": "block", + "description": "Behaviour when the Cisco AI Defense API is unavailable: 'allow' proceeds without scanning (high availability), 'block' rejects the request (maximum security).", + "title": "Fallback On Error" + }, + "inspect_path": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Override for the inspection endpoint path. Defaults to /api/v1/inspect/chat when inspection_type='chat' and /api/v1/inspect/mcp when inspection_type='mcp'.", + "title": "Inspect Path" + }, + "inspection_type": { + "default": "chat", + "description": "Which Cisco AI Defense inspection surface to use. 'chat' scans LLM model conversations via /api/v1/inspect/chat. 'mcp' scans MCP tool calls via /api/v1/inspect/mcp. Each guardrail instance targets exactly one surface; configure two guardrails to scan both chat and MCP traffic.", + "enum": [ + "chat", + "mcp" + ], + "title": "Inspection Type", + "type": "string" + }, + "integration_profile_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Integration profile id to apply (advanced).", + "title": "Integration Profile Id" + }, + "integration_profile_version": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Integration profile version to apply (advanced).", + "title": "Integration Profile Version" + }, + "integration_tenant_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Integration tenant id to apply (advanced).", + "title": "Integration Tenant Id" + }, + "integration_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Integration type to apply (advanced).", + "title": "Integration Type" + }, + "on_flagged_action": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "block", + "description": "Action to take when Cisco AI Defense flags content. 'block' raises an HTTPException; 'monitor' logs the detection and lets the request continue.", + "title": "On Flagged Action" + }, + "timeout": { + "anyOf": [ + { + "maximum": 60.0, + "minimum": 1.0, + "type": "number" + }, + { + "type": "null" + } + ], + "default": 10.0, + "description": "Timeout (seconds) for Cisco AI Defense API calls (1-60).", + "title": "Timeout" + } + }, + "title": "CiscoAIDefenseGuardrailConfigModelOptionalParams", + "type": "object" + }, + "CiscoAIDefenseRule": { + "description": "A single rule to enable for Cisco AI Defense inspection.", + "properties": { + "entity_types": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Optional list of entity types for the rule (e.g. 'Email Address', 'Phone Number'). Applies to rules such as PII, PCI, and PHI.", + "title": "Entity Types" + }, + "rule_name": { + "description": "The canonical Cisco AI Defense rule name to evaluate.", + "enum": [ + "Code Detection", + "Harassment", + "Hate Speech", + "PCI", + "PHI", + "PII", + "Prompt Injection", + "Profanity", + "Sexual Content & Exploitation", + "Social Division & Polarization", + "Violence & Public Safety Threats" + ], + "title": "Rule Name", + "type": "string" + } + }, + "required": [ + "rule_name" + ], + "title": "CiscoAIDefenseRule", + "type": "object" + }, "ContentFilterAction": { "description": "Action to take when content filter detects a match", "enum": [ @@ -8654,106 +9016,6 @@ "title": "GUARDRAIL_DEFINITION_LOCATION", "type": "string" }, - "GraySwanGuardrailConfigModelOptionalParams": { - "description": "Optional parameters for the Gray Swan guardrail.", - "properties": { - "categories": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "description": "Default Gray Swan category definitions to send with each request.", - "title": "Categories" - }, - "fail_open": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "default": true, - "description": "If true (default), errors contacting Gray Swan are logged and the request proceeds. If false, errors propagate and block the request.", - "title": "Fail Open" - }, - "guardrail_timeout": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "default": 30.0, - "description": "Timeout in seconds for calling the Gray Swan guardrail service.", - "title": "Guardrail Timeout" - }, - "on_flagged_action": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "default": "passthrough", - "description": "Action when a violation is detected: 'block' rejects the call (400 error), 'monitor' logs only, 'passthrough' replaces response content with violation message (200 status).", - "title": "On Flagged Action" - }, - "policy_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Gray Swan policy identifier to apply during monitoring.", - "title": "Policy Id" - }, - "reasoning_mode": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Gray Swan reasoning mode override. Accepted values: 'off', 'hybrid', 'thinking'.", - "title": "Reasoning Mode" - }, - "violation_threshold": { - "anyOf": [ - { - "maximum": 1.0, - "minimum": 0.0, - "type": "number" - }, - { - "type": "null" - } - ], - "default": 0.5, - "description": "Threshold between 0 and 1 at which Gray Swan violations trigger the configured action.", - "title": "Violation Threshold" - } - }, - "title": "GraySwanGuardrailConfigModelOptionalParams", - "type": "object" - }, "Guardrail": { "properties": { "created_at": { @@ -8877,7 +9139,7 @@ "litellm_params": { "anyOf": [ { - "$ref": "#/components/schemas/BaseLitellmParams-Output" + "$ref": "#/components/schemas/BaseLitellmParams" }, { "type": "null" @@ -9227,7 +9489,7 @@ "type": "null" } ], - "description": "Base URL for the Lakera AI API", + "description": "Regional base URL for the Cisco AI Defense Inspection API. Defaults to https://us.api.inspect.aidefense.security.cisco.com. Supported regions: us (us-west-2), ap (ap-ne-1), eu (eu-central-1). The environment variable `CISCO_AI_DEFENSE_API_BASE` is consulted as a fallback. The endpoint path is derived from inspection_type (/api/v1/inspect/chat for 'chat', /api/v1/inspect/mcp for 'mcp').", "title": "Api Base" }, "api_endpoint": { @@ -9263,7 +9525,7 @@ "type": "null" } ], - "description": "API key for the Lakera AI service", + "description": "API key for the Cisco AI Defense inspection endpoint. If not provided, the `CISCO_AI_DEFENSE_API_KEY` environment variable is used. Sent in the `X-Cisco-AI-Defense-API-Key` header. Both the chat and MCP endpoints use this key.", "title": "Api Key" }, "api_version": { @@ -9318,6 +9580,18 @@ "description": "Custom assertions to validate against the output. Each assertion is a string describing a condition.", "title": "Assertions" }, + "asset_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Repello asset ID whose dashboard policies are enforced. Required; the guardrail raises at init if it is missing.", + "title": "Asset Id" + }, "async_mode": { "anyOf": [ { @@ -9836,7 +10110,7 @@ } ], "default": true, - "description": "Whether to fail the request if Model Armor encounters an error", + "description": "Whether to fail the request if the guardrail encounters an error. Implemented by guardrail='model_armor' and 'generic_guardrail_api'. True (default) raises the error. False logs a critical error and lets the request proceed, so only a valid guardrail response can block or modify it.", "title": "Fail On Error" }, "grounding_check": { @@ -10109,7 +10383,7 @@ "type": "null" } ], - "description": "Optional field if guardrail requires a 'model' parameter", + "description": "Model name forwarded to the headroom /v1/compress endpoint.", "title": "Model" }, "monitor_mode": { @@ -10164,6 +10438,22 @@ "description": "Action to take when content is flagged: 'block' (raise exception) or 'monitor' (log only)", "title": "On Flagged Action" }, + "on_sensitive_data": { + "anyOf": [ + { + "enum": [ + "block", + "route" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Action to take when sensitive data is detected. 'block' raises an exception (default behavior). 'route' reroutes the request to the model specified in sensitive_data_route_to_model.", + "title": "On Sensitive Data" + }, "on_violation": { "anyOf": [ { @@ -10183,7 +10473,7 @@ "optional_params": { "anyOf": [ { - "$ref": "#/components/schemas/GraySwanGuardrailConfigModelOptionalParams" + "$ref": "#/components/schemas/CiscoAIDefenseGuardrailConfigModelOptionalParams" }, { "type": "null" @@ -10355,6 +10645,30 @@ "title": "Policy Names", "ui_type": "multiselect" }, + "post_checkpoint_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Post-checkpoint ID for the Ovalix Tracker service.", + "title": "Post Checkpoint Id" + }, + "pre_checkpoint_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Pre-checkpoint ID for the Ovalix Tracker service.", + "title": "Pre Checkpoint Id" + }, "presidio_ad_hoc_recognizers": { "anyOf": [ { @@ -10565,6 +10879,18 @@ "description": "Whether to send user_API_key_user_id in headers", "title": "Send User Api Key User Id" }, + "sensitive_data_route_to_model": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Model to route requests to when sensitive data is detected and on_sensitive_data='route'. This is typically an on-premise model for data privacy. The routing decision persists for the entire session.", + "title": "Sensitive Data Route To Model" + }, "severity_threshold": { "anyOf": [ { @@ -10589,6 +10915,31 @@ "description": "When True, unified guardrails skip system-role messages when building evaluation inputs (texts and structured_messages). When False, system messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_system_message_in_guardrail setting.", "title": "Skip System Message In Guardrail" }, + "skip_tool_message_in_guardrail": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "When True, unified guardrails skip tool-role messages when building evaluation inputs (texts and structured_messages). When False, tool messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_tool_message_in_guardrail setting.", + "title": "Skip Tool Message In Guardrail" + }, + "sticky_session_routing": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": true, + "description": "When True (default), after sensitive data is detected and routed, all subsequent requests in the same session will continue routing to the same model.", + "title": "Sticky Session Routing" + }, "template_id": { "anyOf": [ { @@ -10601,6 +10952,18 @@ "description": "The ID of your Model Armor template", "title": "Template Id" }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Per-request timeout for the guardrail provider API call (seconds). Accepts int, float, or numeric string; coerced to float on load. Each guardrail handler chooses its own default when unset.", + "title": "Timeout" + }, "tool_selection_quality_check": { "anyOf": [ { @@ -10613,9 +10976,33 @@ "description": "Enable tool selection quality check to evaluate quality of tool/function calls.", "title": "Tool Selection Quality Check" }, + "tracker_api_base": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Base URL for the Ovalix Tracker service.", + "title": "Tracker Api Base" + }, + "tracker_api_key": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "API key for the Ovalix Tracker service.", + "title": "Tracker Api Key" + }, "unreachable_fallback": { "default": "fail_closed", - "description": "What to do when Akto is unreachable. 'fail_open' = allow, 'fail_closed' = block.", + "description": "Behavior when the headroom compression service is unreachable or errors. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and forwards the request uncompressed instead of blocking it.", "enum": [ "fail_closed", "fail_open" @@ -10767,7 +11154,7 @@ "litellm_params": { "anyOf": [ { - "$ref": "#/components/schemas/BaseLitellmParams-Input" + "$ref": "#/components/schemas/BaseLitellmParams" }, { "type": "null" @@ -10807,6 +11194,9 @@ "US_SSN", "UK_NHS", "UK_NINO", + "UK_PASSPORT", + "UK_POSTCODE", + "UK_VEHICLE_REGISTRATION", "ES_NIF", "ES_NIE", "IT_FISCAL_CODE", @@ -11403,6 +11793,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -12923,6 +13320,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -13223,6 +13627,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -13474,6 +13885,17 @@ }, "MCPCredentials": { "properties": { + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_value": { "anyOf": [ { @@ -13584,6 +14006,20 @@ ], "title": "Client Secret" }, + "redirect_uris": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Redirect Uris" + }, "scopes": { "anyOf": [ { @@ -13597,11 +14033,102 @@ } ], "title": "Scopes" + }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, + "token_endpoint_auth_method": { + "anyOf": [ + { + "enum": [ + "client_secret_basic", + "client_secret_post" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Endpoint Auth Method" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" } }, "title": "MCPCredentials", "type": "object" }, + "MCPEnvVar": { + "description": "One environment variable for an MCP server.\n\nVariables can be interpolated into ``static_headers`` using ``${NAME}``\nsyntax. ``scope=global`` values are stored on the server. ``scope=user``\nvalues are stored per-user in ``LiteLLM_MCPUserEnvVars`` and supplied by\neach user.", + "properties": { + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "name": { + "title": "Name", + "type": "string" + }, + "scope": { + "$ref": "#/components/schemas/MCPEnvVarScope", + "default": "global" + }, + "value": { + "default": "", + "title": "Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "MCPEnvVar", + "type": "object" + }, + "MCPEnvVarScope": { + "description": "Scope for an MCP server environment variable.\n\n- ``global``: value is provided by the admin and used for all users.\n- ``user``: each user must provide their own value via the per-user\n env-var endpoint. The admin-supplied ``value`` is treated as a\n placeholder/hint and is not used at request time.", + "enum": [ + "global", + "user" + ], + "title": "MCPEnvVarScope", + "type": "string" + }, "NewMCPServerRequest": { "properties": { "alias": { @@ -13653,6 +14180,17 @@ "title": "Args", "type": "array" }, + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_type": { "anyOf": [ { @@ -13664,7 +14202,10 @@ "authorization", "oauth2", "aws_sigv4", - "token" + "token", + "oauth2_token_exchange", + "true_passthrough", + "oauth_delegate" ], "type": "string" }, @@ -13729,6 +14270,22 @@ } ] }, + "dcr_bridge": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Dcr Bridge" + }, + "delegate_auth_to_upstream": { + "default": false, + "title": "Delegate Auth To Upstream", + "type": "boolean" + }, "description": { "anyOf": [ { @@ -13747,6 +14304,20 @@ "title": "Env", "type": "object" }, + "env_vars": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/MCPEnvVar" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Env Vars" + }, "extra_headers": { "anyOf": [ { @@ -13777,6 +14348,17 @@ "title": "Is Byok", "type": "boolean" }, + "max_concurrent_requests": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max Concurrent Requests" + }, "mcp_access_groups": { "items": { "type": "string" @@ -13811,6 +14393,11 @@ ], "title": "Oauth2 Flow" }, + "oauth_passthrough": { + "default": false, + "title": "Oauth Passthrough", + "type": "boolean" + }, "registration_url": { "anyOf": [ { @@ -13880,6 +14467,17 @@ ], "title": "Static Headers" }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, "submitted_at": { "anyOf": [ { @@ -13905,6 +14503,39 @@ "description": "Server-managed: set by the endpoint; caller values are overridden.", "title": "Submitted By" }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Timeout" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" + }, "token_url": { "anyOf": [ { @@ -13971,6 +14602,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -14122,7 +14760,7 @@ }, "/mcp-rest/tools/list": { "get": { - "description": "List all available tools with information about the server they belong to.\n\nExample response:\n{\n \"tools\": [\n {\n \"name\": \"create_zap\",\n \"description\": \"Create a new zap\",\n \"inputSchema\": \"tool_input_schema\",\n \"mcp_info\": {\n \"server_name\": \"zapier\",\n \"logo_url\": \"https://www.zapier.com/logo.png\",\n }\n }\n ],\n \"error\": null,\n \"message\": \"Successfully retrieved tools\"\n}", + "description": "List all available tools with information about the server they belong to.\n\nExample response:\n{\n \"tools\": [\n {\n \"name\": \"create_zap\",\n \"description\": \"Create a new zap\",\n \"inputSchema\": \"tool_input_schema\",\n \"mcp_info\": {\n \"server_name\": \"zapier\",\n \"logo_url\": \"https://www.zapier.com/logo.png\",\n \"server_id\": \"a1b2c3d4-...\",\n \"alias\": \"zapier_prod\",\n }\n }\n ],\n \"error\": null,\n \"message\": \"Successfully retrieved tools\"\n}", "operationId": "list_tool_rest_api_mcp_rest_tools_list_get_2", "parameters": [ { @@ -14142,6 +14780,54 @@ "description": "The server id to list tools for", "title": "Server Id" } + }, + { + "description": "Filter tools to a single MCP server by name or alias", + "in": "query", + "name": "mcp_server_name", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Filter tools to a single MCP server by name or alias", + "title": "Mcp Server Name" + } + }, + { + "description": "Filter tools to a single toolset by name", + "in": "query", + "name": "toolset_name", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Filter tools to a single toolset by name", + "title": "Toolset Name" + } + }, + { + "description": "Admin only. Return the full server tool catalog without the allowed_tools filter or per-key tool permissions, so the MCP settings UI can configure the allowlist. Ignored for non-admins.", + "in": "query", + "name": "include_disabled_tools", + "required": false, + "schema": { + "default": false, + "description": "Admin only. Return the full server tool catalog without the allowed_tools filter or per-key tool permissions, so the MCP settings UI can configure the allowlist. Ignored for non-admins.", + "title": "Include Disabled Tools", + "type": "boolean" + } } ], "responses": { @@ -14341,6 +15027,17 @@ "title": "Args", "type": "array" }, + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_type": { "anyOf": [ { @@ -14352,7 +15049,10 @@ "authorization", "oauth2", "aws_sigv4", - "token" + "token", + "oauth2_token_exchange", + "true_passthrough", + "oauth_delegate" ], "type": "string" }, @@ -14440,6 +15140,22 @@ } ] }, + "dcr_bridge": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Dcr Bridge" + }, + "delegate_auth_to_upstream": { + "default": false, + "title": "Delegate Auth To Upstream", + "type": "boolean" + }, "description": { "anyOf": [ { @@ -14458,6 +15174,20 @@ "title": "Env", "type": "object" }, + "env_vars": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/MCPEnvVar" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Env Vars" + }, "extra_headers": { "items": { "type": "string" @@ -14515,6 +15245,17 @@ ], "title": "Last Health Check" }, + "max_concurrent_requests": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max Concurrent Requests" + }, "mcp_access_groups": { "items": { "type": "string" @@ -14534,6 +15275,26 @@ ], "title": "Mcp Info" }, + "oauth2_flow": { + "anyOf": [ + { + "enum": [ + "client_credentials", + "authorization_code" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Oauth2 Flow" + }, + "oauth_passthrough": { + "default": false, + "title": "Oauth Passthrough", + "type": "boolean" + }, "registration_url": { "anyOf": [ { @@ -14637,6 +15398,17 @@ "description": "Health status: 'healthy', 'unhealthy', 'unknown'", "title": "Status" }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, "submitted_at": { "anyOf": [ { @@ -14677,6 +15449,39 @@ "title": "Teams", "type": "array" }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Timeout" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" + }, "token_url": { "anyOf": [ { @@ -14769,6 +15574,17 @@ }, "MCPCredentials": { "properties": { + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_value": { "anyOf": [ { @@ -14879,6 +15695,20 @@ ], "title": "Client Secret" }, + "redirect_uris": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Redirect Uris" + }, "scopes": { "anyOf": [ { @@ -14892,11 +15722,102 @@ } ], "title": "Scopes" + }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, + "token_endpoint_auth_method": { + "anyOf": [ + { + "enum": [ + "client_secret_basic", + "client_secret_post" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Endpoint Auth Method" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" } }, "title": "MCPCredentials", "type": "object" }, + "MCPEnvVar": { + "description": "One environment variable for an MCP server.\n\nVariables can be interpolated into ``static_headers`` using ``${NAME}``\nsyntax. ``scope=global`` values are stored on the server. ``scope=user``\nvalues are stored per-user in ``LiteLLM_MCPUserEnvVars`` and supplied by\neach user.", + "properties": { + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "name": { + "title": "Name", + "type": "string" + }, + "scope": { + "$ref": "#/components/schemas/MCPEnvVarScope", + "default": "global" + }, + "value": { + "default": "", + "title": "Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "MCPEnvVar", + "type": "object" + }, + "MCPEnvVarScope": { + "description": "Scope for an MCP server environment variable.\n\n- ``global``: value is provided by the admin and used for all users.\n- ``user``: each user must provide their own value via the per-user\n env-var endpoint. The admin-supplied ``value`` is treated as a\n placeholder/hint and is not used at request time.", + "enum": [ + "global", + "user" + ], + "title": "MCPEnvVarScope", + "type": "string" + }, "MCPOAuthUserCredentialRequest": { "description": "Stores a user's OAuth2 token for an OpenAPI MCP server.", "properties": { @@ -15151,6 +16072,112 @@ "title": "MCPUserCredentialResponse", "type": "object" }, + "MCPUserEnvVarSpec": { + "description": "Describes one per-user env var slot for the calling user.\n\nStored values are write-only: the status only reports whether a value\n``is_set`` and never echoes the decrypted secret back to the client.", + "properties": { + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "is_set": { + "default": false, + "title": "Is Set", + "type": "boolean" + }, + "name": { + "title": "Name", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "MCPUserEnvVarSpec", + "type": "object" + }, + "MCPUserEnvVarsRequest": { + "description": "Payload for storing the calling user's per-user env var values.", + "properties": { + "values": { + "additionalProperties": { + "type": "string" + }, + "title": "Values", + "type": "object" + } + }, + "required": [ + "values" + ], + "title": "MCPUserEnvVarsRequest", + "type": "object" + }, + "MCPUserEnvVarsStatus": { + "description": "Per-user env var status for a single MCP server.", + "properties": { + "alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + }, + "missing_count": { + "default": 0, + "title": "Missing Count", + "type": "integer" + }, + "required": { + "items": { + "$ref": "#/components/schemas/MCPUserEnvVarSpec" + }, + "title": "Required", + "type": "array" + }, + "server_id": { + "title": "Server Id", + "type": "string" + }, + "server_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Server Name" + }, + "setup_url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Setup Url" + } + }, + "required": [ + "server_id" + ], + "title": "MCPUserEnvVarsStatus", + "type": "object" + }, "MakeMCPServersPublicRequest": { "properties": { "mcp_server_ids": { @@ -15218,6 +16245,17 @@ "title": "Args", "type": "array" }, + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_type": { "anyOf": [ { @@ -15229,7 +16267,10 @@ "authorization", "oauth2", "aws_sigv4", - "token" + "token", + "oauth2_token_exchange", + "true_passthrough", + "oauth_delegate" ], "type": "string" }, @@ -15294,6 +16335,22 @@ } ] }, + "dcr_bridge": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Dcr Bridge" + }, + "delegate_auth_to_upstream": { + "default": false, + "title": "Delegate Auth To Upstream", + "type": "boolean" + }, "description": { "anyOf": [ { @@ -15312,6 +16369,20 @@ "title": "Env", "type": "object" }, + "env_vars": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/MCPEnvVar" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Env Vars" + }, "extra_headers": { "anyOf": [ { @@ -15342,6 +16413,17 @@ "title": "Is Byok", "type": "boolean" }, + "max_concurrent_requests": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max Concurrent Requests" + }, "mcp_access_groups": { "items": { "type": "string" @@ -15376,6 +16458,11 @@ ], "title": "Oauth2 Flow" }, + "oauth_passthrough": { + "default": false, + "title": "Oauth Passthrough", + "type": "boolean" + }, "registration_url": { "anyOf": [ { @@ -15445,6 +16532,17 @@ ], "title": "Static Headers" }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, "submitted_at": { "anyOf": [ { @@ -15470,6 +16568,39 @@ "description": "Server-managed: set by the endpoint; caller values are overridden.", "title": "Submitted By" }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Timeout" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" + }, "token_url": { "anyOf": [ { @@ -15622,6 +16753,17 @@ "title": "Args", "type": "array" }, + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_type": { "anyOf": [ { @@ -15633,7 +16775,10 @@ "authorization", "oauth2", "aws_sigv4", - "token" + "token", + "oauth2_token_exchange", + "true_passthrough", + "oauth_delegate" ], "type": "string" }, @@ -15698,6 +16843,22 @@ } ] }, + "dcr_bridge": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Dcr Bridge" + }, + "delegate_auth_to_upstream": { + "default": false, + "title": "Delegate Auth To Upstream", + "type": "boolean" + }, "description": { "anyOf": [ { @@ -15716,6 +16877,20 @@ "title": "Env", "type": "object" }, + "env_vars": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/MCPEnvVar" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Env Vars" + }, "extra_headers": { "anyOf": [ { @@ -15746,6 +16921,17 @@ "title": "Is Byok", "type": "boolean" }, + "max_concurrent_requests": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max Concurrent Requests" + }, "mcp_access_groups": { "items": { "type": "string" @@ -15765,6 +16951,26 @@ ], "title": "Mcp Info" }, + "oauth2_flow": { + "anyOf": [ + { + "enum": [ + "client_credentials", + "authorization_code" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Oauth2 Flow" + }, + "oauth_passthrough": { + "default": false, + "title": "Oauth Passthrough", + "type": "boolean" + }, "registration_url": { "anyOf": [ { @@ -15827,6 +17033,50 @@ ], "title": "Static Headers" }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Timeout" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" + }, "token_url": { "anyOf": [ { @@ -15945,6 +17195,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -17052,6 +18309,156 @@ ] } }, + "/v1/mcp/server/{server_id}/user-env-vars": { + "delete": { + "description": "Clear the calling user's per-user MCP env var values for this server.", + "operationId": "clear_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_delete", + "parameters": [ + { + "in": "path", + "name": "server_id", + "required": true, + "schema": { + "title": "Server Id", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MCPUserEnvVarsStatus" + } + } + }, + "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Clear Mcp User Env Vars", + "tags": [ + "mcp_management" + ] + }, + "get": { + "description": "Return the calling user's per-user MCP env var status for this server.", + "operationId": "get_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_get", + "parameters": [ + { + "in": "path", + "name": "server_id", + "required": true, + "schema": { + "title": "Server Id", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MCPUserEnvVarsStatus" + } + } + }, + "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Get Mcp User Env Vars", + "tags": [ + "mcp_management" + ] + }, + "post": { + "description": "Store the calling user's per-user MCP env var values for this server. Submitted values are merged over any previously stored values, so you only send the fields you want to set or change; a variable omitted (or sent empty) keeps its stored value. Use DELETE to clear all stored values.", + "operationId": "store_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_post", + "parameters": [ + { + "in": "path", + "name": "server_id", + "required": true, + "schema": { + "title": "Server Id", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MCPUserEnvVarsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MCPUserEnvVarsStatus" + } + } + }, + "description": "Successful Response" + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + }, + "description": "Validation Error" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Store Mcp User Env Vars", + "tags": [ + "mcp_management" + ] + } + }, "/v1/mcp/tools": { "get": { "description": "Get all MCP tools available for the current key, including those from access groups", @@ -17360,6 +18767,37 @@ "mcp_management" ] } + }, + "/v1/mcp/user-env-vars/status": { + "get": { + "description": "Per-user MCP env var status across every server the user can access. Used by the dashboard to highlight servers with missing per-user vars.", + "operationId": "list_mcp_user_env_var_status_v1_mcp_user_env_vars_status_get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/MCPUserEnvVarsStatus" + }, + "title": "Response List Mcp User Env Var Status V1 Mcp User Env Vars Status Get", + "type": "array" + } + } + }, + "description": "Successful Response" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "List Mcp User Env Var Status", + "tags": [ + "mcp_management" + ] + } } } }, @@ -17381,6 +18819,17 @@ }, "MCPCredentials": { "properties": { + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_value": { "anyOf": [ { @@ -17491,6 +18940,20 @@ ], "title": "Client Secret" }, + "redirect_uris": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Redirect Uris" + }, "scopes": { "anyOf": [ { @@ -17504,11 +18967,102 @@ } ], "title": "Scopes" + }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, + "token_endpoint_auth_method": { + "anyOf": [ + { + "enum": [ + "client_secret_basic", + "client_secret_post" + ], + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Endpoint Auth Method" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" } }, "title": "MCPCredentials", "type": "object" }, + "MCPEnvVar": { + "description": "One environment variable for an MCP server.\n\nVariables can be interpolated into ``static_headers`` using ``${NAME}``\nsyntax. ``scope=global`` values are stored on the server. ``scope=user``\nvalues are stored per-user in ``LiteLLM_MCPUserEnvVars`` and supplied by\neach user.", + "properties": { + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Description" + }, + "name": { + "title": "Name", + "type": "string" + }, + "scope": { + "$ref": "#/components/schemas/MCPEnvVarScope", + "default": "global" + }, + "value": { + "default": "", + "title": "Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "title": "MCPEnvVar", + "type": "object" + }, + "MCPEnvVarScope": { + "description": "Scope for an MCP server environment variable.\n\n- ``global``: value is provided by the admin and used for all users.\n- ``user``: each user must provide their own value via the per-user\n env-var endpoint. The admin-supplied ``value`` is treated as a\n placeholder/hint and is not used at request time.", + "enum": [ + "global", + "user" + ], + "title": "MCPEnvVarScope", + "type": "string" + }, "NewMCPServerRequest": { "properties": { "alias": { @@ -17560,6 +19114,17 @@ "title": "Args", "type": "array" }, + "audience": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Audience" + }, "auth_type": { "anyOf": [ { @@ -17571,7 +19136,10 @@ "authorization", "oauth2", "aws_sigv4", - "token" + "token", + "oauth2_token_exchange", + "true_passthrough", + "oauth_delegate" ], "type": "string" }, @@ -17636,6 +19204,22 @@ } ] }, + "dcr_bridge": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Dcr Bridge" + }, + "delegate_auth_to_upstream": { + "default": false, + "title": "Delegate Auth To Upstream", + "type": "boolean" + }, "description": { "anyOf": [ { @@ -17654,6 +19238,20 @@ "title": "Env", "type": "object" }, + "env_vars": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/MCPEnvVar" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Env Vars" + }, "extra_headers": { "anyOf": [ { @@ -17684,6 +19282,17 @@ "title": "Is Byok", "type": "boolean" }, + "max_concurrent_requests": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max Concurrent Requests" + }, "mcp_access_groups": { "items": { "type": "string" @@ -17718,6 +19327,11 @@ ], "title": "Oauth2 Flow" }, + "oauth_passthrough": { + "default": false, + "title": "Oauth Passthrough", + "type": "boolean" + }, "registration_url": { "anyOf": [ { @@ -17787,6 +19401,17 @@ ], "title": "Static Headers" }, + "subject_token_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Subject Token Type" + }, "submitted_at": { "anyOf": [ { @@ -17812,6 +19437,39 @@ "description": "Server-managed: set by the endpoint; caller values are overridden.", "title": "Submitted By" }, + "timeout": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "title": "Timeout" + }, + "token_exchange_endpoint": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Endpoint" + }, + "token_exchange_profile": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Token Exchange Profile" + }, "token_url": { "anyOf": [ { @@ -17878,6 +19536,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -18029,7 +19694,7 @@ }, "/mcp-rest/tools/list": { "get": { - "description": "List all available tools with information about the server they belong to.\n\nExample response:\n{\n \"tools\": [\n {\n \"name\": \"create_zap\",\n \"description\": \"Create a new zap\",\n \"inputSchema\": \"tool_input_schema\",\n \"mcp_info\": {\n \"server_name\": \"zapier\",\n \"logo_url\": \"https://www.zapier.com/logo.png\",\n }\n }\n ],\n \"error\": null,\n \"message\": \"Successfully retrieved tools\"\n}", + "description": "List all available tools with information about the server they belong to.\n\nExample response:\n{\n \"tools\": [\n {\n \"name\": \"create_zap\",\n \"description\": \"Create a new zap\",\n \"inputSchema\": \"tool_input_schema\",\n \"mcp_info\": {\n \"server_name\": \"zapier\",\n \"logo_url\": \"https://www.zapier.com/logo.png\",\n \"server_id\": \"a1b2c3d4-...\",\n \"alias\": \"zapier_prod\",\n }\n }\n ],\n \"error\": null,\n \"message\": \"Successfully retrieved tools\"\n}", "operationId": "list_tool_rest_api_mcp_rest_tools_list_get", "parameters": [ { @@ -18049,6 +19714,54 @@ "description": "The server id to list tools for", "title": "Server Id" } + }, + { + "description": "Filter tools to a single MCP server by name or alias", + "in": "query", + "name": "mcp_server_name", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Filter tools to a single MCP server by name or alias", + "title": "Mcp Server Name" + } + }, + { + "description": "Filter tools to a single toolset by name", + "in": "query", + "name": "toolset_name", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Filter tools to a single toolset by name", + "title": "Toolset Name" + } + }, + { + "description": "Admin only. Return the full server tool catalog without the allowed_tools filter or per-key tool permissions, so the MCP settings UI can configure the allowlist. Ignored for non-admins.", + "in": "query", + "name": "include_disabled_tools", + "required": false, + "schema": { + "default": false, + "description": "Admin only. Return the full server tool catalog without the allowed_tools filter or per-key tool permissions, so the MCP settings UI can configure the allowlist. Ignored for non-admins.", + "title": "Include Disabled Tools", + "type": "boolean" + } } ], "responses": { @@ -18667,8 +20380,15 @@ "title": "Cache Control" }, "signature": { - "title": "Signature", - "type": "string" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Signature" }, "thinking": { "title": "Thinking", @@ -18790,6 +20510,13 @@ }, "ChatCompletionToolParam": { "properties": { + "allowed_callers": { + "items": { + "type": "string" + }, + "title": "Allowed Callers", + "type": "array" + }, "cache_control": { "$ref": "#/components/schemas/ChatCompletionCachedContent" }, @@ -19710,6 +21437,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -21231,6 +22965,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -22484,6 +24225,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -22634,7 +24382,7 @@ "Body_convert_prompt_file_to_json_utils_dotprompt_json_converter_post": { "properties": { "file": { - "format": "binary", + "contentMediaType": "application/octet-stream", "title": "File", "type": "string" } @@ -23040,6 +24788,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -23685,6 +25440,26 @@ ], "title": "RealtimeClientSecretResponse", "type": "object" + }, + "RealtimeTranscriptionSessionResponse": { + "additionalProperties": true, + "description": "Response from POST /v1/realtime/transcription_sessions.\n\n`client_secret.value` contains the encrypted token instead of the raw\nephemeral key. Unknown fields pass through unchanged.", + "properties": { + "client_secret": { + "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Client Secret" + } + }, + "title": "RealtimeTranscriptionSessionResponse", + "type": "object" } } }, @@ -23734,6 +25509,33 @@ ] } }, + "/openai/v1/realtime/transcription_sessions": { + "post": { + "description": "Create an ephemeral Realtime transcription session\n(POST /v1/realtime/transcription_sessions) for the WebRTC/WebSocket flow.\n\nMirrors the client_secrets route but targets the transcription_sessions\nendpoint and encrypts the ephemeral key returned under `client_secret.value`.", + "operationId": "create_realtime_transcription_session_openai_v1_realtime_transcription_sessions_post", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RealtimeTranscriptionSessionResponse" + } + } + }, + "description": "Successful Response" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Create Realtime Transcription Session", + "tags": [ + "realtime" + ] + } + }, "/realtime/calls": { "post": { "operationId": "proxy_realtime_calls_realtime_calls_post", @@ -23779,6 +25581,33 @@ ] } }, + "/realtime/transcription_sessions": { + "post": { + "description": "Create an ephemeral Realtime transcription session\n(POST /v1/realtime/transcription_sessions) for the WebRTC/WebSocket flow.\n\nMirrors the client_secrets route but targets the transcription_sessions\nendpoint and encrypts the ephemeral key returned under `client_secret.value`.", + "operationId": "create_realtime_transcription_session_realtime_transcription_sessions_post", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RealtimeTranscriptionSessionResponse" + } + } + }, + "description": "Successful Response" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Create Realtime Transcription Session", + "tags": [ + "realtime" + ] + } + }, "/v1/realtime/calls": { "post": { "operationId": "proxy_realtime_calls_v1_realtime_calls_post", @@ -23823,6 +25652,33 @@ "realtime" ] } + }, + "/v1/realtime/transcription_sessions": { + "post": { + "description": "Create an ephemeral Realtime transcription session\n(POST /v1/realtime/transcription_sessions) for the WebRTC/WebSocket flow.\n\nMirrors the client_secrets route but targets the transcription_sessions\nendpoint and encrypts the ephemeral key returned under `client_secret.value`.", + "operationId": "create_realtime_transcription_session_v1_realtime_transcription_sessions_post", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RealtimeTranscriptionSessionResponse" + } + } + }, + "description": "Successful Response" + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ], + "summary": "Create Realtime Transcription Session", + "tags": [ + "realtime" + ] + } } } }, @@ -23842,6 +25698,77 @@ "title": "HTTPValidationError", "type": "object" }, + "SCIMEnterpriseUser": { + "properties": { + "costCenter": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Costcenter" + }, + "department": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Department" + }, + "division": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Division" + }, + "employeeNumber": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Employeenumber" + }, + "manager": { + "anyOf": [ + { + "$ref": "#/components/schemas/SCIMUserManager" + }, + { + "type": "null" + } + ] + }, + "organization": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Organization" + } + }, + "title": "SCIMEnterpriseUser", + "type": "object" + }, "SCIMFeature": { "properties": { "maxOperations": { @@ -23963,7 +25890,7 @@ "anyOf": [ { "items": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Output" }, "type": "array" }, @@ -24184,7 +26111,7 @@ "title": "SCIMServiceProviderConfig", "type": "object" }, - "SCIMUser": { + "SCIMUser-Input": { "properties": { "active": { "default": true, @@ -24281,6 +26208,16 @@ "title": "Schemas", "type": "array" }, + "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { + "anyOf": [ + { + "$ref": "#/components/schemas/SCIMEnterpriseUser" + }, + { + "type": "null" + } + ] + }, "userName": { "anyOf": [ { @@ -24299,6 +26236,10 @@ "title": "SCIMUser", "type": "object" }, + "SCIMUser-Output": { + "additionalProperties": true, + "type": "object" + }, "SCIMUserEmail": { "properties": { "primary": { @@ -24371,6 +26312,45 @@ "title": "SCIMUserGroup", "type": "object" }, + "SCIMUserManager": { + "properties": { + "$ref": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "$Ref" + }, + "displayName": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Displayname" + }, + "value": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Value" + } + }, + "title": "SCIMUserManager", + "type": "object" + }, "SCIMUserName": { "properties": { "familyName": { @@ -24445,6 +26425,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -25355,7 +27342,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Input" } } }, @@ -25366,7 +27353,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Output" } } }, @@ -25485,7 +27472,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Output" } } }, @@ -25557,7 +27544,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Output" } } }, @@ -25618,7 +27605,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Input" } } }, @@ -25629,7 +27616,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SCIMUser" + "$ref": "#/components/schemas/SCIMUser-Output" } } }, @@ -25925,6 +27912,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -26846,6 +28840,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -27645,6 +29646,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -27744,6 +29752,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -28292,6 +30307,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ @@ -29540,756 +31562,6 @@ } } }, - "vector_store_management": { - "components": { - "schemas": { - "HTTPValidationError": { - "properties": { - "detail": { - "items": { - "$ref": "#/components/schemas/ValidationError" - }, - "title": "Detail", - "type": "array" - } - }, - "title": "HTTPValidationError", - "type": "object" - }, - "LiteLLM_ManagedVectorStore": { - "description": "LiteLLM managed vector store object - this is is the object stored in the database", - "properties": { - "created_at": { - "anyOf": [ - { - "format": "date-time", - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "custom_llm_provider": { - "title": "Custom Llm Provider", - "type": "string" - }, - "litellm_credential_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Litellm Credential Name" - }, - "litellm_params": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Litellm Params" - }, - "team_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Team Id" - }, - "updated_at": { - "anyOf": [ - { - "format": "date-time", - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "user_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "User Id" - }, - "vector_store_description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Description" - }, - "vector_store_id": { - "title": "Vector Store Id", - "type": "string" - }, - "vector_store_metadata": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Metadata" - }, - "vector_store_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Name" - } - }, - "title": "LiteLLM_ManagedVectorStore", - "type": "object" - }, - "LiteLLM_ManagedVectorStoreListResponse": { - "description": "Response format for listing vector stores", - "properties": { - "current_page": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Current Page" - }, - "data": { - "items": { - "$ref": "#/components/schemas/LiteLLM_ManagedVectorStore" - }, - "title": "Data", - "type": "array" - }, - "object": { - "const": "list", - "title": "Object", - "type": "string" - }, - "total_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Count" - }, - "total_pages": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Pages" - } - }, - "title": "LiteLLM_ManagedVectorStoreListResponse", - "type": "object" - }, - "LiteLLM_ManagedVectorStoresTable": { - "properties": { - "created_at": { - "anyOf": [ - { - "format": "date-time", - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Created At" - }, - "custom_llm_provider": { - "title": "Custom Llm Provider", - "type": "string" - }, - "litellm_credential_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Litellm Credential Name" - }, - "litellm_params": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Litellm Params" - }, - "team_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Team Id" - }, - "updated_at": { - "anyOf": [ - { - "format": "date-time", - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "user_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "User Id" - }, - "vector_store_description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Description" - }, - "vector_store_id": { - "title": "Vector Store Id", - "type": "string" - }, - "vector_store_metadata": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Vector Store Metadata" - }, - "vector_store_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Name" - } - }, - "required": [ - "vector_store_id", - "custom_llm_provider", - "vector_store_name", - "vector_store_description", - "vector_store_metadata", - "created_at", - "updated_at", - "litellm_credential_name", - "litellm_params", - "team_id", - "user_id" - ], - "title": "LiteLLM_ManagedVectorStoresTable", - "type": "object" - }, - "ResponseLiteLLM_ManagedVectorStore": { - "properties": { - "vector_store": { - "$ref": "#/components/schemas/LiteLLM_ManagedVectorStoresTable" - } - }, - "title": "ResponseLiteLLM_ManagedVectorStore", - "type": "object" - }, - "ValidationError": { - "properties": { - "loc": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "title": "Location", - "type": "array" - }, - "msg": { - "title": "Message", - "type": "string" - }, - "type": { - "title": "Error Type", - "type": "string" - } - }, - "required": [ - "loc", - "msg", - "type" - ], - "title": "ValidationError", - "type": "object" - }, - "VectorStoreDeleteRequest": { - "properties": { - "vector_store_id": { - "title": "Vector Store Id", - "type": "string" - } - }, - "required": [ - "vector_store_id" - ], - "title": "VectorStoreDeleteRequest", - "type": "object" - }, - "VectorStoreInfoRequest": { - "properties": { - "vector_store_id": { - "title": "Vector Store Id", - "type": "string" - } - }, - "required": [ - "vector_store_id" - ], - "title": "VectorStoreInfoRequest", - "type": "object" - }, - "VectorStoreUpdateRequest": { - "properties": { - "custom_llm_provider": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Custom Llm Provider" - }, - "vector_store_description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Description" - }, - "vector_store_id": { - "title": "Vector Store Id", - "type": "string" - }, - "vector_store_metadata": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Vector Store Metadata" - }, - "vector_store_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Vector Store Name" - } - }, - "required": [ - "vector_store_id" - ], - "title": "VectorStoreUpdateRequest", - "type": "object" - } - } - }, - "paths": { - "/v1/vector_store/list": { - "get": { - "description": "List all available vector stores with optional filtering and pagination.\nCombines both in-memory vector stores and those stored in the database.\nDatabase is the source of truth - deleted stores are removed from memory, updated stores sync to memory.\n\nParameters:\n- page: int - Page number for pagination (default: 1)\n- page_size: int - Number of items per page (default: 100)", - "operationId": "list_vector_stores_v1_vector_store_list_get", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 1, - "title": "Page", - "type": "integer" - } - }, - { - "in": "query", - "name": "page_size", - "required": false, - "schema": { - "default": 100, - "title": "Page Size", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LiteLLM_ManagedVectorStoreListResponse" - } - } - }, - "description": "Successful Response" - }, - "422": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - }, - "description": "Validation Error" - } - }, - "security": [ - { - "APIKeyHeader": [] - } - ], - "summary": "List Vector Stores", - "tags": [ - "vector_store_management" - ] - } - }, - "/vector_store/delete": { - "post": { - "description": "Delete a vector store from both database and in-memory registry.\n\nParameters:\n- vector_store_id: str - ID of the vector store to delete", - "operationId": "delete_vector_store_vector_store_delete_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreDeleteRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": {} - } - }, - "description": "Successful Response" - }, - "422": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - }, - "description": "Validation Error" - } - }, - "security": [ - { - "APIKeyHeader": [] - } - ], - "summary": "Delete Vector Store", - "tags": [ - "vector_store_management" - ] - } - }, - "/vector_store/info": { - "post": { - "description": "Return a single vector store's details", - "operationId": "get_vector_store_info_vector_store_info_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreInfoRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResponseLiteLLM_ManagedVectorStore" - } - } - }, - "description": "Successful Response" - }, - "422": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - }, - "description": "Validation Error" - } - }, - "security": [ - { - "APIKeyHeader": [] - } - ], - "summary": "Get Vector Store Info", - "tags": [ - "vector_store_management" - ] - } - }, - "/vector_store/list": { - "get": { - "description": "List all available vector stores with optional filtering and pagination.\nCombines both in-memory vector stores and those stored in the database.\nDatabase is the source of truth - deleted stores are removed from memory, updated stores sync to memory.\n\nParameters:\n- page: int - Page number for pagination (default: 1)\n- page_size: int - Number of items per page (default: 100)", - "operationId": "list_vector_stores_vector_store_list_get", - "parameters": [ - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 1, - "title": "Page", - "type": "integer" - } - }, - { - "in": "query", - "name": "page_size", - "required": false, - "schema": { - "default": 100, - "title": "Page Size", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LiteLLM_ManagedVectorStoreListResponse" - } - } - }, - "description": "Successful Response" - }, - "422": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - }, - "description": "Validation Error" - } - }, - "security": [ - { - "APIKeyHeader": [] - } - ], - "summary": "List Vector Stores", - "tags": [ - "vector_store_management" - ] - } - }, - "/vector_store/new": { - "post": { - "description": "Create a new vector store.\n\nParameters:\n- vector_store_id: str - Unique identifier for the vector store\n- custom_llm_provider: str - Provider of the vector store\n- vector_store_name: Optional[str] - Name of the vector store\n- vector_store_description: Optional[str] - Description of the vector store\n- vector_store_metadata: Optional[Dict] - Additional metadata for the vector store", - "operationId": "new_vector_store_vector_store_new_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LiteLLM_ManagedVectorStore" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": {} - } - }, - "description": "Successful Response" - }, - "422": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - }, - "description": "Validation Error" - } - }, - "security": [ - { - "APIKeyHeader": [] - } - ], - "summary": "New Vector Store", - "tags": [ - "vector_store_management" - ] - } - }, - "/vector_store/update": { - "post": { - "description": "Update vector store details in both database and in-memory registry.\nThe updated data is immediately synchronized to the in-memory registry.", - "operationId": "update_vector_store_vector_store_update_post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": {} - } - }, - "description": "Successful Response" - }, - "422": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } - }, - "description": "Validation Error" - } - }, - "security": [ - { - "APIKeyHeader": [] - } - ], - "summary": "Update Vector Store", - "tags": [ - "vector_store_management" - ] - } - } - } - }, "vector_stores": { "components": { "schemas": { @@ -30355,6 +31627,13 @@ }, "ValidationError": { "properties": { + "ctx": { + "title": "Context", + "type": "object" + }, + "input": { + "title": "Input" + }, "loc": { "items": { "anyOf": [ diff --git a/litellm/proxy/_lazy_openapi_snapshot.py b/litellm/proxy/_lazy_openapi_snapshot.py index 818232d650e..e469d0f609c 100644 --- a/litellm/proxy/_lazy_openapi_snapshot.py +++ b/litellm/proxy/_lazy_openapi_snapshot.py @@ -3,15 +3,20 @@ Per-feature OpenAPI snapshot for lazy-loaded routers. The committed JSON is generated by `python -m litellm.proxy._lazy_openapi_snapshot` and consumed at runtime so /openapi.json can show full route info for unloaded -features without importing them. CI verifies the file is current and surfaces -any drift as a neutral check. +features without importing them. + +The snapshot is also an *input* to the dashboard's generated types: `npm run gen:api` +dumps the proxy spec without loading the lazy features, so their paths and schemas +come from this file verbatim. A stale fragment therefore ships stale `schema.d.ts` +types, and the UI types-sync check cannot catch it (it regenerates from this same +file). `--check` closes that loop; the Lazy OpenAPI Snapshot Sync workflow runs it. """ import json import re import sys from pathlib import Path -from typing import Dict, Optional, Set +from typing import Dict, Optional, Sequence, Set SNAPSHOT_FILE = Path(__file__).parent / "_lazy_openapi_snapshot.json" HTTP_METHOD_SUFFIXES = { @@ -80,22 +85,42 @@ def _normalize_operation_ids(paths: Dict[str, Dict]) -> None: break -def generate_snapshot() -> Dict[str, Dict]: +def _register_lazy_feature(app, feat) -> tuple[str, str] | None: + """Import and register one lazy feature. Returns (name, error) if it could not be loaded.""" import importlib + if feat.module_path in sys.modules: + return None + try: + feat.register_fn(app, importlib.import_module(feat.module_path)) + return None + except Exception as exc: + return (feat.name, f"{type(exc).__name__}: {exc}") + + +def generate_snapshot(*, strict: bool = False) -> dict[str, dict]: + """Build a fragment per lazy feature. + + A feature whose module fails to import is skipped, which yields an incomplete + snapshot. That is tolerable when writing the file by hand but not when verifying + it, so `strict` turns a skip into an error rather than silent drift. + """ from fastapi.openapi.utils import get_openapi from litellm.proxy._lazy_features import LAZY_FEATURES from litellm.proxy.proxy_server import app, ensure_unique_openapi_operation_ids - for feat in LAZY_FEATURES: - if feat.module_path in sys.modules: - continue - try: - module = importlib.import_module(feat.module_path) - feat.register_fn(app, module) - except Exception as exc: - sys.stderr.write(f"warning: skip {feat.name}: {exc}\n") + skipped = tuple( + result for result in (_register_lazy_feature(app, feat) for feat in LAZY_FEATURES) if result is not None + ) + for name, error in skipped: + sys.stderr.write(f"warning: skip {name}: {error}\n") + if strict and skipped: + raise RuntimeError( + "cannot verify the snapshot: " + + ", ".join(f"{name} ({error})" for name, error in skipped) + + ". Install the extras these features need, then re-run." + ) fragments: Dict[str, Dict] = {} used_operation_ids: Set[str] = set() @@ -126,7 +151,49 @@ def generate_snapshot() -> Dict[str, Dict]: return fragments -if __name__ == "__main__": +REGEN_COMMAND = "python -m litellm.proxy._lazy_openapi_snapshot" + + +def serialize_snapshot(fragments: dict[str, dict]) -> str: + return json.dumps(fragments, indent=2, sort_keys=True) + "\n" + + +def drifted_features(committed: dict[str, dict], fresh: dict[str, dict]) -> tuple[str, ...]: + """Feature names whose fragment was added, removed, or changed.""" + return tuple(sorted(name for name in set(committed) | set(fresh) if committed.get(name) != fresh.get(name))) + + +def check_snapshot() -> int: + """Regenerate in memory and compare against the committed file. 0 when in sync.""" + fresh = generate_snapshot(strict=True) + committed = load_snapshot() + + if committed is not None and serialize_snapshot(committed) == serialize_snapshot(fresh): + sys.stdout.write(f"{SNAPSHOT_FILE.name} is in sync ({len(fresh)} feature fragments).\n") + return 0 + + drifted = drifted_features(committed or {}, fresh) + sys.stderr.write( + f"{SNAPSHOT_FILE.name} is out of sync with the proxy routes.\n\n" + "This file feeds /openapi.json for unloaded features AND the dashboard's generated\n" + "types, so stale fragments ship stale schema.d.ts.\n\n" + f"Drifted features ({len(drifted)}): {', '.join(drifted) or 'formatting only'}\n\n" + f"To fix, run:\n {REGEN_COMMAND}\n" + "then commit the updated litellm/proxy/_lazy_openapi_snapshot.json (and re-run\n" + "`npm run gen:api` in ui/litellm-dashboard if schema.d.ts changes).\n" + ) + return 1 + + +def _main(argv: Sequence[str]) -> int: + if "--check" in argv: + return check_snapshot() + fragments = generate_snapshot() - SNAPSHOT_FILE.write_text(json.dumps(fragments, indent=2, sort_keys=True) + "\n") + SNAPSHOT_FILE.write_text(serialize_snapshot(fragments)) sys.stdout.write(f"wrote {len(fragments)} feature fragments to {SNAPSHOT_FILE}\n") + return 0 + + +if __name__ == "__main__": + raise SystemExit(_main(sys.argv[1:])) diff --git a/ruff-strict-budget.json b/ruff-strict-budget.json index dcde6fd1641..f585f71b865 100644 --- a/ruff-strict-budget.json +++ b/ruff-strict-budget.json @@ -324,7 +324,7 @@ "limit": 883 }, "UP006": { - "limit": 12792 + "limit": 12790 }, "UP007": { "limit": 2570 diff --git a/tests/test_litellm/proxy/test_lazy_openapi_snapshot.py b/tests/test_litellm/proxy/test_lazy_openapi_snapshot.py index 64cb931888b..30255e7866c 100644 --- a/tests/test_litellm/proxy/test_lazy_openapi_snapshot.py +++ b/tests/test_litellm/proxy/test_lazy_openapi_snapshot.py @@ -1,7 +1,16 @@ import sys from types import ModuleType, SimpleNamespace -from litellm.proxy._lazy_openapi_snapshot import _normalize_operation_ids +import pytest + +from litellm.proxy import _lazy_openapi_snapshot as snapshot_module +from litellm.proxy._lazy_openapi_snapshot import ( + _normalize_operation_ids, + _register_lazy_feature, + check_snapshot, + drifted_features, + serialize_snapshot, +) def test_generate_snapshot_uses_shared_operation_id_reservations(monkeypatch): @@ -35,9 +44,7 @@ def test_generate_snapshot_uses_shared_operation_id_reservations(monkeypatch): register_fn=lambda app, module: None, ), ] - monkeypatch.setitem( - sys.modules, "litellm.proxy._lazy_features", fake_lazy_features_module - ) + monkeypatch.setitem(sys.modules, "litellm.proxy._lazy_features", fake_lazy_features_module) def fake_get_openapi(title, version, routes): path = routes[0].path @@ -58,30 +65,16 @@ def test_generate_snapshot_uses_shared_operation_id_reservations(monkeypatch): fake_proxy_server_module = ModuleType("litellm.proxy.proxy_server") fake_proxy_server_module.app = fake_app - fake_proxy_server_module.ensure_unique_openapi_operation_ids = ( - fake_ensure_unique_openapi_operation_ids - ) - monkeypatch.setitem( - sys.modules, "litellm.proxy.proxy_server", fake_proxy_server_module - ) + fake_proxy_server_module.ensure_unique_openapi_operation_ids = fake_ensure_unique_openapi_operation_ids + monkeypatch.setitem(sys.modules, "litellm.proxy.proxy_server", fake_proxy_server_module) monkeypatch.setattr("fastapi.openapi.utils.get_openapi", fake_get_openapi) fragments = _lazy_openapi_snapshot.generate_snapshot() - assert ( - fragments["feature-a"]["paths"]["/feature-a/items"]["get"]["operationId"] - == "shared_operation_id_get" - ) - assert ( - fragments["feature-b"]["paths"]["/feature-b/items"]["get"]["operationId"] - == "shared_operation_id_get_2" - ) - assert fragments["feature-a"]["paths"]["/feature-a/items"]["get"]["tags"] == [ - "feature-a" - ] - assert fragments["feature-b"]["paths"]["/feature-b/items"]["get"]["tags"] == [ - "feature-b" - ] + assert fragments["feature-a"]["paths"]["/feature-a/items"]["get"]["operationId"] == "shared_operation_id_get" + assert fragments["feature-b"]["paths"]["/feature-b/items"]["get"]["operationId"] == "shared_operation_id_get_2" + assert fragments["feature-a"]["paths"]["/feature-a/items"]["get"]["tags"] == ["feature-a"] + assert fragments["feature-b"]["paths"]["/feature-b/items"]["get"]["tags"] == ["feature-b"] def test_normalize_operation_ids_uses_each_http_method(): @@ -116,3 +109,105 @@ def test_normalize_operation_ids_preserves_custom_ids(): operations = paths["/proxy/{endpoint}"] assert operations["get"]["operationId"] == "custom_operation" assert operations["post"]["operationId"] == "custom_operation" + + +class TestDriftedFeatures: + def test_reports_changed_added_and_removed_fragments(self): + committed = {"kept": {"paths": {}}, "changed": {"paths": {"/a": {}}}, "removed": {"paths": {}}} + fresh = {"kept": {"paths": {}}, "changed": {"paths": {"/b": {}}}, "added": {"paths": {}}} + + assert drifted_features(committed, fresh) == ("added", "changed", "removed") + + def test_identical_snapshots_have_no_drift(self): + fragments = {"a": {"paths": {"/a": {}}, "components": {"schemas": {}}}} + + assert drifted_features(fragments, dict(fragments)) == () + + +class TestRegisterLazyFeature: + def test_skips_a_module_that_is_already_imported(self): + feature = SimpleNamespace(name="ok", module_path="json", register_fn=lambda app, module: None) + + assert _register_lazy_feature(SimpleNamespace(), feature) is None + + def test_registers_a_module_that_imports_cleanly(self, monkeypatch): + registered = [] + feature = SimpleNamespace( + name="ok", module_path="json", register_fn=lambda app, module: registered.append(module.__name__) + ) + monkeypatch.delitem(sys.modules, "json", raising=False) + + assert _register_lazy_feature(SimpleNamespace(), feature) is None + assert registered == ["json"] + + def test_reports_the_feature_and_error_when_the_module_is_missing(self): + feature = SimpleNamespace( + name="broken", module_path="litellm_no_such_module", register_fn=lambda app, module: None + ) + + result = _register_lazy_feature(SimpleNamespace(), feature) + + assert result is not None + name, error = result + assert name == "broken" + assert "ModuleNotFoundError" in error + + def test_reports_the_error_when_registration_raises(self, monkeypatch): + def _raise(app, module): + raise ValueError("router blew up") + + feature = SimpleNamespace(name="broken", module_path="json", register_fn=_raise) + monkeypatch.delitem(sys.modules, "json", raising=False) + + assert _register_lazy_feature(SimpleNamespace(), feature) == ("broken", "ValueError: router blew up") + + +class TestCheckSnapshot: + """The check exists to fail when the committed file drifts; prove it does.""" + + def test_passes_when_the_committed_file_matches(self, monkeypatch): + fragments = {"guardrails": {"paths": {"/g": {}}, "components": {"schemas": {}}}} + monkeypatch.setattr(snapshot_module, "generate_snapshot", lambda *, strict=False: fragments) + monkeypatch.setattr(snapshot_module, "load_snapshot", lambda: dict(fragments)) + + assert check_snapshot() == 0 + + def test_fails_when_a_fragment_drifted(self, monkeypatch, capsys): + monkeypatch.setattr( + snapshot_module, + "generate_snapshot", + lambda *, strict=False: {"guardrails": {"paths": {"/new": {}}, "components": {"schemas": {}}}}, + ) + monkeypatch.setattr( + snapshot_module, + "load_snapshot", + lambda: {"guardrails": {"paths": {"/old": {}}, "components": {"schemas": {}}}}, + ) + + assert check_snapshot() == 1 + assert "guardrails" in capsys.readouterr().err + + def test_fails_when_the_file_is_absent(self, monkeypatch): + monkeypatch.setattr(snapshot_module, "generate_snapshot", lambda *, strict=False: {"a": {"paths": {}}}) + monkeypatch.setattr(snapshot_module, "load_snapshot", lambda: None) + + assert check_snapshot() == 1 + + def test_verification_refuses_to_run_on_an_incomplete_regen(self, monkeypatch): + """A feature that fails to import would silently look like a deleted fragment.""" + + def _boom(*, strict: bool = False): + raise RuntimeError("cannot verify the snapshot: mcp_app (ImportError: no module)") + + monkeypatch.setattr(snapshot_module, "generate_snapshot", _boom) + + with pytest.raises(RuntimeError, match="cannot verify the snapshot"): + check_snapshot() + + +class TestSerializeSnapshot: + def test_is_stable_regardless_of_key_order(self): + assert serialize_snapshot({"b": {"x": 1}, "a": {"y": 2}}) == serialize_snapshot({"a": {"y": 2}, "b": {"x": 1}}) + + def test_ends_with_a_trailing_newline(self): + assert serialize_snapshot({"a": {}}).endswith("}\n") diff --git a/ui/litellm-dashboard/src/lib/http/schema.d.ts b/ui/litellm-dashboard/src/lib/http/schema.d.ts index 1d620e9d153..094df5d371e 100644 --- a/ui/litellm-dashboard/src/lib/http/schema.d.ts +++ b/ui/litellm-dashboard/src/lib/http/schema.d.ts @@ -7266,6 +7266,8 @@ export interface paths { * "mcp_info": { * "server_name": "zapier", * "logo_url": "https://www.zapier.com/logo.png", + * "server_id": "a1b2c3d4-...", + * "alias": "zapier_prod", * } * } * ], @@ -8362,6 +8364,30 @@ export interface paths { patch?: never; trace?: never; }; + "/openai/v1/realtime/transcription_sessions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create Realtime Transcription Session + * @description Create an ephemeral Realtime transcription session + * (POST /v1/realtime/transcription_sessions) for the WebRTC/WebSocket flow. + * + * Mirrors the client_secrets route but targets the transcription_sessions + * endpoint and encrypts the ephemeral key returned under `client_secret.value`. + */ + post: operations["create_realtime_transcription_session_openai_v1_realtime_transcription_sessions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/openai/v1/responses": { parameters: { query?: never; @@ -11071,6 +11097,30 @@ export interface paths { patch?: never; trace?: never; }; + "/realtime/transcription_sessions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create Realtime Transcription Session + * @description Create an ephemeral Realtime transcription session + * (POST /v1/realtime/transcription_sessions) for the WebRTC/WebSocket flow. + * + * Mirrors the client_secrets route but targets the transcription_sessions + * endpoint and encrypts the ephemeral key returned under `client_secret.value`. + */ + post: operations["create_realtime_transcription_session_realtime_transcription_sessions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/reload/anthropic_beta_headers": { parameters: { query?: never; @@ -14938,40 +14988,6 @@ export interface paths { trace?: never; }; "/v1/a2a/discover": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** a2a_registration */ - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v1/a2a/{agent_id}/message/send": { parameters: { query?: never; header?: never; @@ -14981,14 +14997,22 @@ export interface paths { get?: never; put?: never; /** - * Invoke Agent A2A - * @description Invoke an agent using the A2A protocol (JSON-RPC 2.0). + * Discover Agent Card + * @description Fetch the upstream agent's well-known card so the UI can show the admin + * which skills/capabilities the agent exposes. * - * Supported methods: - * - message/send: Send a message and get a response - * - message/stream: Send a message and stream the response + * Only proxy admins can call this — the UI uses it during agent registration, + * and we don't want arbitrary keys probing internal URLs. + * + * Example: + * ```bash + * curl -X POST "http://localhost:4000/v1/a2a/discover" \ + * -H "Authorization: Bearer " \ + * -H "Content-Type: application/json" \ + * -d '{"url": "https://upstream-agent.example.com"}' + * ``` */ - post: operations["invoke_agent_a2a_v1_a2a__agent_id__message_send_post"]; + post: operations["discover_agent_card_v1_a2a_discover_post"]; delete?: never; options?: never; head?: never; @@ -15064,30 +15088,30 @@ export interface paths { * -H "Content-Type: application/json" \ * -d '{ * "agent_name": "my-custom-agent", - * "agent_card_params": { - * "protocolVersion": "1.0", - * "name": "Hello World Agent", - * "description": "Just a hello world agent", - * "url": "http://localhost:9999/", - * "version": "1.0.0", - * "defaultInputModes": ["text"], - * "defaultOutputModes": ["text"], - * "capabilities": { - * "streaming": true - * }, - * "skills": [ - * { - * "id": "hello_world", - * "name": "Returns hello world", - * "description": "just returns hello world", - * "tags": ["hello world"], - * "examples": ["hi", "hello world"] - * } - * ] + * "agent_card_params": { + * "protocolVersion": "1.0", + * "name": "Hello World Agent", + * "description": "Just a hello world agent", + * "url": "http://localhost:9999/", + * "version": "1.0.0", + * "defaultInputModes": ["text"], + * "defaultOutputModes": ["text"], + * "capabilities": { + * "streaming": true * }, - * "litellm_params": { - * "make_public": true - * } + * "skills": [ + * { + * "id": "hello_world", + * "name": "Returns hello world", + * "description": "just returns hello world", + * "tags": ["hello world"], + * "examples": ["hi", "hello world"] + * } + * ] + * }, + * "litellm_params": { + * "make_public": true + * } * }' * ``` */ @@ -15157,7 +15181,7 @@ export interface paths { * * Example Request: * ```bash - * curl -X GET "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \ + * curl -X GET "http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000" \ * -H "Authorization: Bearer " * ``` */ @@ -15168,28 +15192,26 @@ export interface paths { * * Example Request: * ```bash - * curl -X PUT "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \ + * curl -X PUT "http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000" \ * -H "Authorization: Bearer " \ * -H "Content-Type: application/json" \ * -d '{ - * "agent": { - * "agent_name": "updated-agent", - * "agent_card_params": { - * "protocolVersion": "1.0", - * "name": "Updated Agent", - * "description": "Updated description", - * "url": "http://localhost:9999/", - * "version": "1.1.0", - * "defaultInputModes": ["text"], - * "defaultOutputModes": ["text"], - * "capabilities": { - * "streaming": true - * }, - * "skills": [] + * "agent_name": "updated-agent", + * "agent_card_params": { + * "protocolVersion": "1.0", + * "name": "Updated Agent", + * "description": "Updated description", + * "url": "http://localhost:9999/", + * "version": "1.1.0", + * "defaultInputModes": ["text"], + * "defaultOutputModes": ["text"], + * "capabilities": { + * "streaming": true * }, - * "litellm_params": { - * "make_public": false - * } + * "skills": [] + * }, + * "litellm_params": { + * "make_public": false * } * }' * ``` @@ -15202,7 +15224,7 @@ export interface paths { * * Example Request: * ```bash - * curl -X DELETE "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \ + * curl -X DELETE "http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000" \ * -H "Authorization: Bearer " * ``` * @@ -15222,28 +15244,26 @@ export interface paths { * * Example Request: * ```bash - * curl -X PUT "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \ + * curl -X PATCH "http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000" \ * -H "Authorization: Bearer " \ * -H "Content-Type: application/json" \ * -d '{ - * "agent": { - * "agent_name": "updated-agent", - * "agent_card_params": { - * "protocolVersion": "1.0", - * "name": "Updated Agent", - * "description": "Updated description", - * "url": "http://localhost:9999/", - * "version": "1.1.0", - * "defaultInputModes": ["text"], - * "defaultOutputModes": ["text"], - * "capabilities": { - * "streaming": true - * }, - * "skills": [] + * "agent_name": "updated-agent", + * "agent_card_params": { + * "protocolVersion": "1.0", + * "name": "Updated Agent", + * "description": "Updated description", + * "url": "http://localhost:9999/", + * "version": "1.1.0", + * "defaultInputModes": ["text"], + * "defaultOutputModes": ["text"], + * "capabilities": { + * "streaming": true * }, - * "litellm_params": { - * "make_public": false - * } + * "skills": [] + * }, + * "litellm_params": { + * "make_public": false * } * }' * ``` @@ -16641,6 +16661,34 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/mcp/server/{server_id}/user-env-vars": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Mcp User Env Vars + * @description Return the calling user's per-user MCP env var status for this server. + */ + get: operations["get_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_get"]; + put?: never; + /** + * Store Mcp User Env Vars + * @description Store the calling user's per-user MCP env var values for this server. Submitted values are merged over any previously stored values, so you only send the fields you want to set or change; a variable omitted (or sent empty) keeps its stored value. Use DELETE to clear all stored values. + */ + post: operations["store_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_post"]; + /** + * Clear Mcp User Env Vars + * @description Clear the calling user's per-user MCP env var values for this server. + */ + delete: operations["clear_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/mcp/tools": { parameters: { query?: never; @@ -16733,6 +16781,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/mcp/user-env-vars/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Mcp User Env Var Status + * @description Per-user MCP env var status across every server the user can access. Used by the dashboard to highlight servers with missing per-user vars. + */ + get: operations["list_mcp_user_env_var_status_v1_mcp_user_env_vars_status_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/memory": { parameters: { query?: never; @@ -17195,6 +17263,30 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/realtime/transcription_sessions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create Realtime Transcription Session + * @description Create an ephemeral Realtime transcription session + * (POST /v1/realtime/transcription_sessions) for the WebRTC/WebSocket flow. + * + * Mirrors the client_secrets route but targets the transcription_sessions + * endpoint and encrypts the ephemeral key returned under `client_secret.value`. + */ + post: operations["create_realtime_transcription_session_v1_realtime_transcription_sessions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/rerank": { parameters: { query?: never; @@ -18016,32 +18108,6 @@ export interface paths { patch?: never; trace?: never; }; - "/v1/vector_store/list": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List Vector Stores - * @description List all available vector stores with optional filtering and pagination. - * Combines both in-memory vector stores and those stored in the database. - * Database is the source of truth - deleted stores are removed from memory, updated stores sync to memory. - * - * Parameters: - * - page: int - Page number for pagination (default: 1) - * - page_size: int - Number of items per page (default: 100) - */ - get: operations["list_vector_stores_v1_vector_store_list_get"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/v1/vector_stores": { parameters: { query?: never; @@ -18549,25 +18615,118 @@ export interface paths { path?: never; cookie?: never; }; - /** gemini_agents */ - get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description OK */ - 200: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; + /** + * List Gemini Agents + * @description List all custom agents on the Gemini side. + * + * Pass per-request Gemini credentials via the JSON-encoded + * ``litellm_params_template`` query parameter. Flat query parameters + * (e.g. ``?api_key=AIza...``) are intentionally ignored — see + * ``_merge_query_params_into_data`` for the rationale. + * + * ```bash + * curl "http://localhost:4000/v1beta/agents?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D" \ + * -H "Authorization: Bearer sk-..." + * ``` + */ + get: operations["list_gemini_agents_v1beta_agents_get"]; + put?: never; + /** + * Create Gemini Agent + * @description Create a named custom agent on the Gemini side. + * + * Example: + * ```bash + * curl -X POST "http://localhost:4000/v1beta/agents" \ + * -H "Authorization: Bearer sk-..." \ + * -H "Content-Type: application/json" \ + * -d '{ + * "name": "my-custom-slides-agent", + * "base_agent": "waverunner", + * "instructions": "You are a helpful assistant that creates slides.", + * "base_environment": { + * "type": "remote", + * "sources": [ + * {"type": "gcs", "source": "gs://eap-templates/slides-skill", + * "target": "/.agents/skills/slides-skill"} + * ] + * } + * }' + * ``` + */ + post: operations["create_gemini_agent_v1beta_agents_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1beta/agents/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; + /** + * Get Gemini Agent + * @description Get a specific custom agent by name. + * + * Pass per-request Gemini credentials via the JSON-encoded + * ``litellm_params_template`` query parameter. Flat query parameters + * (e.g. ``?api_key=AIza...``) are intentionally ignored — see + * ``_merge_query_params_into_data`` for the rationale. + * + * ```bash + * curl "http://localhost:4000/v1beta/agents/my-custom-slides-agent?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D" \ + * -H "Authorization: Bearer sk-..." + * ``` + */ + get: operations["get_gemini_agent_v1beta_agents__name__get"]; + put?: never; + post?: never; + /** + * Delete Gemini Agent + * @description Delete a custom agent by name. + * + * Pass per-request Gemini credentials via the JSON-encoded + * ``litellm_params_template`` query parameter. Flat query parameters + * (e.g. ``?api_key=AIza...``) are intentionally ignored — see + * ``_merge_query_params_into_data`` for the rationale. + * + * ```bash + * curl -X DELETE "http://localhost:4000/v1beta/agents/my-custom-slides-agent?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D" \ + * -H "Authorization: Bearer sk-..." + * ``` + */ + delete: operations["delete_gemini_agent_v1beta_agents__name__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1beta/agents/{name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Gemini Agent Versions + * @description List versions of a custom agent. + * + * Pass per-request Gemini credentials via the JSON-encoded + * ``litellm_params_template`` query parameter. Flat query parameters + * (e.g. ``?api_key=AIza...``) are intentionally ignored — see + * ``_merge_query_params_into_data`` for the rationale. + * + * ```bash + * curl "http://localhost:4000/v1beta/agents/my-custom-slides-agent/versions?litellm_params_template=%7B%22api_key%22%3A%22AIza...%22%7D" \ + * -H "Authorization: Bearer sk-..." + * ``` + */ + get: operations["list_gemini_agent_versions_v1beta_agents__name__versions_get"]; put?: never; post?: never; delete?: never; @@ -19146,67 +19305,32 @@ export interface paths { patch?: never; trace?: never; }; - "/vector_store/delete": { + "/vector_store/": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - /** - * Delete Vector Store - * @description Delete a vector store from both database and in-memory registry. - * - * Parameters: - * - vector_store_id: str - ID of the vector store to delete - */ - post: operations["delete_vector_store_vector_store_delete_post"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/vector_store/info": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; + /** vector_store_management */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; }; - get?: never; - put?: never; - /** - * Get Vector Store Info - * @description Return a single vector store's details - */ - post: operations["get_vector_store_info_vector_store_info_post"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/vector_store/list": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List Vector Stores - * @description List all available vector stores with optional filtering and pagination. - * Combines both in-memory vector stores and those stored in the database. - * Database is the source of truth - deleted stores are removed from memory, updated stores sync to memory. - * - * Parameters: - * - page: int - Page number for pagination (default: 1) - * - page_size: int - Number of items per page (default: 100) - */ - get: operations["list_vector_stores_vector_store_list_get"]; put?: never; post?: never; delete?: never; @@ -19215,54 +19339,6 @@ export interface paths { patch?: never; trace?: never; }; - "/vector_store/new": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * New Vector Store - * @description Create a new vector store. - * - * Parameters: - * - vector_store_id: str - Unique identifier for the vector store - * - custom_llm_provider: str - Provider of the vector store - * - vector_store_name: Optional[str] - Name of the vector store - * - vector_store_description: Optional[str] - Description of the vector store - * - vector_store_metadata: Optional[Dict] - Additional metadata for the vector store - */ - post: operations["new_vector_store_vector_store_new_post"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/vector_store/update": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * Update Vector Store - * @description Update vector store details in both database and in-memory registry. - * The updated data is immediately synchronized to the in-memory registry. - */ - post: operations["update_vector_store_vector_store_update_post"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/vector_stores": { parameters: { query?: never; @@ -20527,6 +20603,15 @@ export interface components { /** Url */ url?: string; }; + /** AgentKeySummary */ + AgentKeySummary: { + /** Key Alias */ + key_alias?: string | null; + /** Key Name */ + key_name?: string | null; + /** Token */ + token: string; + }; /** AgentMakePublicResponse */ AgentMakePublicResponse: { /** Message */ @@ -20577,6 +20662,8 @@ export interface components { created_by?: string | null; /** Extra Headers */ extra_headers?: string[] | null; + /** Keys */ + keys?: components["schemas"]["AgentKeySummary"][] | null; /** Litellm Params */ litellm_params?: { [key: string]: unknown; @@ -20738,7 +20825,7 @@ export interface components { } | null; }; /** BaseLitellmParams */ - "BaseLitellmParams-Input": { + BaseLitellmParams: { /** * Additional Provider Specific Params * @description Additional provider-specific parameters for generic guardrail APIs @@ -20818,7 +20905,7 @@ export interface components { extra_headers?: string[] | null; /** * Fail On Error - * @description Whether to fail the request if Model Armor encounters an error + * @description Whether to fail the request if the guardrail encounters an error. Implemented by guardrail='model_armor' and 'generic_guardrail_api'. True (default) raises the error. False logs a critical error and lets the request proceed, so only a valid guardrail response can block or modify it. * @default true */ fail_on_error: boolean | null; @@ -20852,6 +20939,11 @@ export interface components { * @description Optional field if guardrail requires a 'model' parameter */ model?: string | null; + /** + * On Sensitive Data + * @description Action to take when sensitive data is detected. 'block' raises an exception (default behavior). 'route' reroutes the request to the model specified in sensitive_data_route_to_model. + */ + on_sensitive_data?: ("block" | "route") | null; /** * On Violation * @description For /v1/realtime sessions: 'warn' speaks the violation message and continues; 'end_session' speaks the message and closes the connection. @@ -20882,6 +20974,11 @@ export interface components { * @description The message the bot speaks aloud when a /v1/realtime guardrail fires. Falls back to violation_message_template if not set. */ realtime_violation_message?: string | null; + /** + * Sensitive Data Route To Model + * @description Model to route requests to when sensitive data is detected and on_sensitive_data='route'. This is typically an on-premise model for data privacy. The routing decision persists for the entire session. + */ + sensitive_data_route_to_model?: string | null; /** * Severity Threshold * @description Minimum severity to block (high, medium, low) @@ -20893,188 +20990,29 @@ export interface components { */ skip_system_message_in_guardrail?: boolean | null; /** - * Template Id - * @description The ID of your Model Armor template + * Skip Tool Message In Guardrail + * @description When True, unified guardrails skip tool-role messages when building evaluation inputs (texts and structured_messages). When False, tool messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_tool_message_in_guardrail setting. */ - template_id?: string | null; + skip_tool_message_in_guardrail?: boolean | null; /** - * Unreachable Fallback - * @description Behavior when a guardrail endpoint is unreachable due to network errors. NOTE: This is currently only implemented by guardrail='generic_guardrail_api'. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and allows the request to proceed. - * @default fail_closed - * @enum {string} - */ - unreachable_fallback: "fail_closed" | "fail_open"; - /** - * Violation Message Template - * @description Custom message when a guardrail blocks an action. Supports placeholders like {tool_name}, {rule_id}, and {default_message}. - */ - violation_message_template?: string | null; - } & { - [key: string]: unknown; - }; - /** BaseLitellmParams */ - "BaseLitellmParams-Output": { - /** - * Additional Provider Specific Params - * @description Additional provider-specific parameters for generic guardrail APIs - */ - additional_provider_specific_params?: { - [key: string]: unknown; - } | null; - /** - * Api Base - * @description Base URL for the guardrail service API - */ - api_base?: string | null; - /** - * Api Endpoint - * @description Optional custom API endpoint for Model Armor - */ - api_endpoint?: string | null; - /** - * Api Key - * @description API key for the guardrail service - */ - api_key?: string | null; - /** - * Blocked Words - * @description List of blocked words with individual actions - */ - blocked_words?: components["schemas"]["BlockedWord"][] | null; - /** - * Blocked Words File - * @description Path to YAML file containing blocked_words list - */ - blocked_words_file?: string | null; - /** - * Categories - * @description List of prebuilt categories to enable (harmful_*, bias_*) - */ - categories?: components["schemas"]["ContentFilterCategoryConfig"][] | null; - /** @description Threshold configuration for Lakera guardrail categories */ - category_thresholds?: components["schemas"]["LakeraCategoryThresholds"] | null; - /** - * Credentials - * @description Path to Google Cloud credentials JSON file or JSON string - */ - credentials?: string | null; - /** - * Custom Code - * @description Python-like code containing the apply_guardrail function for custom guardrail logic - */ - custom_code?: string | null; - /** - * Default On - * @description Whether the guardrail is enabled by default - */ - default_on?: boolean | null; - /** - * Detect Secrets Config - * @description Configuration for detect-secrets guardrail - */ - detect_secrets_config?: { - [key: string]: unknown; - } | null; - /** - * End Session After N Fails - * @description For /v1/realtime sessions: automatically close the session after this many guardrail violations. - */ - end_session_after_n_fails?: number | null; - /** - * Experimental Use Latest Role Message Only - * @description When True, guardrails only receive the latest message for the relevant role (e.g., newest user input pre-call, newest assistant output post-call) - * @default false - */ - experimental_use_latest_role_message_only: boolean | null; - /** - * Extra Headers - * @description Header names to forward from the client request to the guardrail (e.g. x-request-id). Only these headers' values are sent; others may be omitted or sent as [present]. Used by generic_guardrail_api (similar to MCP extra_headers). - */ - extra_headers?: string[] | null; - /** - * Fail On Error - * @description Whether to fail the request if Model Armor encounters an error + * Sticky Session Routing + * @description When True (default), after sensitive data is detected and routed, all subsequent requests in the same session will continue routing to the same model. * @default true */ - fail_on_error: boolean | null; - /** - * Guard Name - * @description Name of the guardrail in guardrails.ai - */ - guard_name?: string | null; - /** - * Keyword Redaction Tag - * @description Tag to use for keyword redaction - */ - keyword_redaction_tag?: string | null; - /** - * Location - * @description Google Cloud location/region (e.g., us-central1) - */ - location?: string | null; - /** - * Mask Request Content - * @description Will mask request content if guardrail makes any changes - */ - mask_request_content?: boolean | null; - /** - * Mask Response Content - * @description Will mask response content if guardrail makes any changes - */ - mask_response_content?: boolean | null; - /** - * Model - * @description Optional field if guardrail requires a 'model' parameter - */ - model?: string | null; - /** - * On Violation - * @description For /v1/realtime sessions: 'warn' speaks the violation message and continues; 'end_session' speaks the message and closes the connection. - */ - on_violation?: ("warn" | "end_session") | null; - /** - * Pangea Input Recipe - * @description Recipe for input (LLM request) - */ - pangea_input_recipe?: string | null; - /** - * Pangea Output Recipe - * @description Recipe for output (LLM response) - */ - pangea_output_recipe?: string | null; - /** - * Pattern Redaction Format - * @description Format string for pattern redaction (use {pattern_name} placeholder) - */ - pattern_redaction_format?: string | null; - /** - * Patterns - * @description List of patterns (prebuilt or custom regex) to detect - */ - patterns?: components["schemas"]["ContentFilterPattern"][] | null; - /** - * Realtime Violation Message - * @description The message the bot speaks aloud when a /v1/realtime guardrail fires. Falls back to violation_message_template if not set. - */ - realtime_violation_message?: string | null; - /** - * Severity Threshold - * @description Minimum severity to block (high, medium, low) - */ - severity_threshold?: string | null; - /** - * Skip System Message In Guardrail - * @description When True, unified guardrails skip system-role messages when building evaluation inputs (texts and structured_messages). When False, system messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_system_message_in_guardrail setting. - */ - skip_system_message_in_guardrail?: boolean | null; + sticky_session_routing: boolean | null; /** * Template Id * @description The ID of your Model Armor template */ template_id?: string | null; + /** + * Timeout + * @description Per-request timeout for the guardrail provider API call (seconds). Accepts int, float, or numeric string; coerced to float on load. Each guardrail handler chooses its own default when unset. + */ + timeout?: number | null; /** * Unreachable Fallback - * @description Behavior when a guardrail endpoint is unreachable due to network errors. NOTE: This is currently only implemented by guardrail='generic_guardrail_api'. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and allows the request to proceed. + * @description Behavior when a guardrail endpoint is unreachable due to network errors. Implemented by guardrail='generic_guardrail_api', 'akto', 'vigil_guard', 'repelloai', and 'headroom'. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and allows the request to proceed. * @default fail_closed * @enum {string} */ @@ -21160,10 +21098,7 @@ export interface components { }; /** Body_convert_prompt_file_to_json_utils_dotprompt_json_converter_post */ Body_convert_prompt_file_to_json_utils_dotprompt_json_converter_post: { - /** - * File - * Format: binary - */ + /** File */ file: string; }; /** Body_create_file__provider__v1_files_post */ @@ -22093,6 +22028,8 @@ export interface components { }; /** ChatCompletionToolParam */ ChatCompletionToolParam: { + /** Allowed Callers */ + allowed_callers?: string[]; cache_control?: components["schemas"]["ChatCompletionCachedContent"]; function: components["schemas"]["ChatCompletionToolParamFunctionChunk"]; /** Type */ @@ -22175,6 +22112,86 @@ export interface components { } & { [key: string]: unknown; }; + /** + * CiscoAIDefenseGuardrailConfigModelOptionalParams + * @description Optional parameters for the Cisco AI Defense guardrail. + */ + CiscoAIDefenseGuardrailConfigModelOptionalParams: { + /** + * Enabled Rules + * @description Explicit list of Cisco AI Defense rules to evaluate. If omitted, the policies configured for the API key in the Cisco AI Defense UI are used. + */ + enabled_rules?: components["schemas"]["CiscoAIDefenseRule"][] | null; + /** + * Fallback On Error + * @description Behaviour when the Cisco AI Defense API is unavailable: 'allow' proceeds without scanning (high availability), 'block' rejects the request (maximum security). + * @default block + */ + fallback_on_error: ("allow" | "block") | null; + /** + * Inspect Path + * @description Override for the inspection endpoint path. Defaults to /api/v1/inspect/chat when inspection_type='chat' and /api/v1/inspect/mcp when inspection_type='mcp'. + */ + inspect_path?: string | null; + /** + * Inspection Type + * @description Which Cisco AI Defense inspection surface to use. 'chat' scans LLM model conversations via /api/v1/inspect/chat. 'mcp' scans MCP tool calls via /api/v1/inspect/mcp. Each guardrail instance targets exactly one surface; configure two guardrails to scan both chat and MCP traffic. + * @default chat + * @enum {string} + */ + inspection_type: "chat" | "mcp"; + /** + * Integration Profile Id + * @description Integration profile id to apply (advanced). + */ + integration_profile_id?: string | null; + /** + * Integration Profile Version + * @description Integration profile version to apply (advanced). + */ + integration_profile_version?: string | null; + /** + * Integration Tenant Id + * @description Integration tenant id to apply (advanced). + */ + integration_tenant_id?: string | null; + /** + * Integration Type + * @description Integration type to apply (advanced). + */ + integration_type?: string | null; + /** + * On Flagged Action + * @description Action to take when Cisco AI Defense flags content. 'block' raises an HTTPException; 'monitor' logs the detection and lets the request continue. + * @default block + */ + on_flagged_action: string | null; + /** + * Timeout + * @description Timeout (seconds) for Cisco AI Defense API calls (1-60). + * @default 10 + */ + timeout: number | null; + } & { + [key: string]: unknown; + }; + /** + * CiscoAIDefenseRule + * @description A single rule to enable for Cisco AI Defense inspection. + */ + CiscoAIDefenseRule: { + /** + * Entity Types + * @description Optional list of entity types for the rule (e.g. 'Email Address', 'Phone Number'). Applies to rules such as PII, PCI, and PHI. + */ + entity_types?: string[] | null; + /** + * Rule Name + * @description The canonical Cisco AI Defense rule name to evaluate. + * @enum {string} + */ + rule_name: "Code Detection" | "Harassment" | "Hate Speech" | "PCI" | "PHI" | "PII" | "Prompt Injection" | "Profanity" | "Sexual Content & Exploitation" | "Social Division & Polarization" | "Violence & Public Safety Threats"; + }; /** CitationsObject */ CitationsObject: { /** Enabled */ @@ -23422,6 +23439,43 @@ export interface components { } & { [key: string]: unknown; }; + /** DiscoverAgentRequest */ + DiscoverAgentRequest: { + /** + * @description How to locate the upstream card. ``well_known_fallback`` for pure A2A agents (try standard paths); ``langgraph_platform`` for LangGraph Platform deployments where the card is shared across assistants and disambiguated by a query parameter. + * @default well_known_fallback + */ + discovery_mode: components["schemas"]["DiscoveryMode"]; + /** + * Params + * @description Mode-specific parameters. ``langgraph_platform`` requires ``{'assistant_id': }``. ``well_known_fallback`` ignores this. + */ + params?: { + [key: string]: unknown; + } | null; + /** + * Url + * @description Base URL of the upstream agent. Behavior depends on ``discovery_mode``: ``well_known_fallback`` (default) tries /.well-known/agent-card.json, /.well-known/agent.json, /agent.json under this URL in order; ``langgraph_platform`` hits ``/.well-known/agent-card.json?assistant_id=`` instead. + */ + url: string; + }; + /** DiscoverAgentResponse */ + DiscoverAgentResponse: { + /** Agent Card */ + agent_card: { + [key: string]: unknown; + }; + /** Url */ + url: string; + }; + /** + * DiscoveryMode + * @description How to locate the upstream agent card. + * + * String-valued so it serializes cleanly over JSON / Pydantic. + * @enum {string} + */ + DiscoveryMode: "well_known_fallback" | "langgraph_platform"; /** * DistinctTagResponse * @description Response for distinct user agent tags @@ -24155,53 +24209,6 @@ export interface components { /** Starttime */ startTime?: string | null; }; - /** - * GraySwanGuardrailConfigModelOptionalParams - * @description Optional parameters for the Gray Swan guardrail. - */ - GraySwanGuardrailConfigModelOptionalParams: { - /** - * Categories - * @description Default Gray Swan category definitions to send with each request. - */ - categories?: { - [key: string]: string; - } | null; - /** - * Fail Open - * @description If true (default), errors contacting Gray Swan are logged and the request proceeds. If false, errors propagate and block the request. - * @default true - */ - fail_open: boolean | null; - /** - * Guardrail Timeout - * @description Timeout in seconds for calling the Gray Swan guardrail service. - * @default 30 - */ - guardrail_timeout: number | null; - /** - * On Flagged Action - * @description Action when a violation is detected: 'block' rejects the call (400 error), 'monitor' logs only, 'passthrough' replaces response content with violation message (200 status). - * @default passthrough - */ - on_flagged_action: string | null; - /** - * Policy Id - * @description Gray Swan policy identifier to apply during monitoring. - */ - policy_id?: string | null; - /** - * Reasoning Mode - * @description Gray Swan reasoning mode override. Accepted values: 'off', 'hybrid', 'thinking'. - */ - reasoning_mode?: string | null; - /** - * Violation Threshold - * @description Threshold between 0 and 1 at which Gray Swan violations trigger the configured action. - * @default 0.5 - */ - violation_threshold: number | null; - }; /** Guardrail */ Guardrail: { /** Created At */ @@ -24234,7 +24241,7 @@ export interface components { } | null; /** Guardrail Name */ guardrail_name: string; - litellm_params?: components["schemas"]["BaseLitellmParams-Output"] | null; + litellm_params?: components["schemas"]["BaseLitellmParams"] | null; /** Updated At */ updated_at?: string | null; }; @@ -25166,8 +25173,10 @@ export interface components { approval_status: string | null; /** Args */ args?: string[]; + /** Audience */ + audience?: string | null; /** Auth Type */ - auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token") | null; + auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token" | "oauth2_token_exchange" | "true_passthrough" | "oauth_delegate") | null; /** Authorization Url */ authorization_url?: string | null; /** @@ -25186,12 +25195,21 @@ export interface components { /** Created By */ created_by?: string | null; credentials?: components["schemas"]["MCPCredentials"] | null; + /** Dcr Bridge */ + dcr_bridge?: boolean | null; + /** + * Delegate Auth To Upstream + * @default false + */ + delegate_auth_to_upstream: boolean; /** Description */ description?: string | null; /** Env */ env?: { [key: string]: string; }; + /** Env Vars */ + env_vars?: components["schemas"]["MCPEnvVar"][] | null; /** Extra Headers */ extra_headers?: string[]; /** Has User Credential */ @@ -25207,12 +25225,21 @@ export interface components { is_byok: boolean; /** Last Health Check */ last_health_check?: string | null; + /** Max Concurrent Requests */ + max_concurrent_requests?: number | null; /** Mcp Access Groups */ mcp_access_groups?: string[]; /** Mcp Info */ mcp_info?: { [key: string]: unknown; } | null; + /** Oauth2 Flow */ + oauth2_flow?: ("client_credentials" | "authorization_code") | null; + /** + * Oauth Passthrough + * @default false + */ + oauth_passthrough: boolean; /** Registration Url */ registration_url?: string | null; /** Review Notes */ @@ -25237,6 +25264,8 @@ export interface components { * @default unknown */ status: ("healthy" | "unhealthy" | "unknown") | null; + /** Subject Token Type */ + subject_token_type?: string | null; /** Submitted At */ submitted_at?: string | null; /** Submitted By */ @@ -25245,6 +25274,12 @@ export interface components { teams?: { [key: string]: string | null; }[]; + /** Timeout */ + timeout?: number | null; + /** Token Exchange Endpoint */ + token_exchange_endpoint?: string | null; + /** Token Exchange Profile */ + token_exchange_profile?: string | null; /** Token Url */ token_url?: string | null; /** Tool Name To Description */ @@ -25267,86 +25302,6 @@ export interface components { /** Url */ url?: string | null; }; - /** - * LiteLLM_ManagedVectorStore - * @description LiteLLM managed vector store object - this is is the object stored in the database - */ - LiteLLM_ManagedVectorStore: { - /** Created At */ - created_at?: string | null; - /** Custom Llm Provider */ - custom_llm_provider?: string; - /** Litellm Credential Name */ - litellm_credential_name?: string | null; - /** Litellm Params */ - litellm_params?: { - [key: string]: unknown; - } | null; - /** Team Id */ - team_id?: string | null; - /** Updated At */ - updated_at?: string | null; - /** User Id */ - user_id?: string | null; - /** Vector Store Description */ - vector_store_description?: string | null; - /** Vector Store Id */ - vector_store_id?: string; - /** Vector Store Metadata */ - vector_store_metadata?: { - [key: string]: unknown; - } | string | null; - /** Vector Store Name */ - vector_store_name?: string | null; - }; - /** - * LiteLLM_ManagedVectorStoreListResponse - * @description Response format for listing vector stores - */ - LiteLLM_ManagedVectorStoreListResponse: { - /** Current Page */ - current_page?: number | null; - /** Data */ - data?: components["schemas"]["LiteLLM_ManagedVectorStore"][]; - /** - * Object - * @constant - */ - object?: "list"; - /** Total Count */ - total_count?: number | null; - /** Total Pages */ - total_pages?: number | null; - }; - /** LiteLLM_ManagedVectorStoresTable */ - LiteLLM_ManagedVectorStoresTable: { - /** Created At */ - created_at: string | null; - /** Custom Llm Provider */ - custom_llm_provider: string; - /** Litellm Credential Name */ - litellm_credential_name: string | null; - /** Litellm Params */ - litellm_params: { - [key: string]: unknown; - } | null; - /** Team Id */ - team_id: string | null; - /** Updated At */ - updated_at: string | null; - /** User Id */ - user_id: string | null; - /** Vector Store Description */ - vector_store_description: string | null; - /** Vector Store Id */ - vector_store_id: string; - /** Vector Store Metadata */ - vector_store_metadata: { - [key: string]: unknown; - } | null; - /** Vector Store Name */ - vector_store_name: string | null; - }; /** LiteLLM_MemoryRow */ LiteLLM_MemoryRow: { /** Created At */ @@ -26553,7 +26508,7 @@ export interface components { anonymize_input?: boolean | null; /** * Api Base - * @description Base URL for the Lakera AI API + * @description Regional base URL for the Cisco AI Defense Inspection API. Defaults to https://us.api.inspect.aidefense.security.cisco.com. Supported regions: us (us-west-2), ap (ap-ne-1), eu (eu-central-1). The environment variable `CISCO_AI_DEFENSE_API_BASE` is consulted as a fallback. The endpoint path is derived from inspection_type (/api/v1/inspect/chat for 'chat', /api/v1/inspect/mcp for 'mcp'). */ api_base?: string | null; /** @@ -26568,7 +26523,7 @@ export interface components { api_id?: string | null; /** * Api Key - * @description API key for the Lakera AI service + * @description API key for the Cisco AI Defense inspection endpoint. If not provided, the `CISCO_AI_DEFENSE_API_KEY` environment variable is used. Sent in the `X-Cisco-AI-Defense-API-Key` header. Both the chat and MCP endpoints use this key. */ api_key?: string | null; /** @@ -26592,6 +26547,11 @@ export interface components { * @description Custom assertions to validate against the output. Each assertion is a string describing a condition. */ assertions?: string[] | null; + /** + * Asset Id + * @description Repello asset ID whose dashboard policies are enforced. Required; the guardrail raises at init if it is missing. + */ + asset_id?: string | null; /** * Async Mode * @description Set to True to request asynchronous analysis (sets `plr_async` header). Defaults to provider behaviour when omitted. @@ -26806,7 +26766,7 @@ export interface components { extra_headers?: string[] | null; /** * Fail On Error - * @description Whether to fail the request if Model Armor encounters an error + * @description Whether to fail the request if the guardrail encounters an error. Implemented by guardrail='model_armor' and 'generic_guardrail_api'. True (default) raises the error. False logs a critical error and lets the request proceed, so only a valid guardrail response can block or modify it. * @default true */ fail_on_error: boolean | null; @@ -26925,7 +26885,7 @@ export interface components { mode: string | string[] | components["schemas"]["Mode"]; /** * Model - * @description Optional field if guardrail requires a 'model' parameter + * @description Model name forwarded to the headroom /v1/compress endpoint. */ model?: string | null; /** @@ -26952,13 +26912,18 @@ export interface components { * @default monitor */ on_flagged_action: string | null; + /** + * On Sensitive Data + * @description Action to take when sensitive data is detected. 'block' raises an exception (default behavior). 'route' reroutes the request to the model specified in sensitive_data_route_to_model. + */ + on_sensitive_data?: ("block" | "route") | null; /** * On Violation * @description For /v1/realtime sessions: 'warn' speaks the violation message and continues; 'end_session' speaks the message and closes the connection. */ on_violation?: ("warn" | "end_session") | null; /** @description Optional parameters for the guardrail */ - optional_params?: components["schemas"]["GraySwanGuardrailConfigModelOptionalParams"] | null; + optional_params?: components["schemas"]["CiscoAIDefenseGuardrailConfigModelOptionalParams"] | null; /** * Output Parse Pii * @description When True, LiteLLM will replace the masked text with the original text in the response @@ -27022,6 +26987,16 @@ export interface components { * @description XecGuard policies to apply on each scan. Select one or more of the built-in default policies; if none are selected, the guardrail defaults to System Prompt Enforcement + Harmful Content Protection. */ policy_names?: string[] | null; + /** + * Post Checkpoint Id + * @description Post-checkpoint ID for the Ovalix Tracker service. + */ + post_checkpoint_id?: string | null; + /** + * Pre Checkpoint Id + * @description Pre-checkpoint ID for the Ovalix Tracker service. + */ + pre_checkpoint_id?: string | null; /** * Presidio Ad Hoc Recognizers * @description Path to a JSON file containing ad-hoc recognizers for Presidio @@ -27103,6 +27078,11 @@ export interface components { * @default false */ send_user_api_key_user_id: boolean | null; + /** + * Sensitive Data Route To Model + * @description Model to route requests to when sensitive data is detected and on_sensitive_data='route'. This is typically an on-premise model for data privacy. The routing decision persists for the entire session. + */ + sensitive_data_route_to_model?: string | null; /** * Severity Threshold * @description Minimum severity to block (high, medium, low) @@ -27113,19 +27093,45 @@ export interface components { * @description When True, unified guardrails skip system-role messages when building evaluation inputs (texts and structured_messages). When False, system messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_system_message_in_guardrail setting. */ skip_system_message_in_guardrail?: boolean | null; + /** + * Skip Tool Message In Guardrail + * @description When True, unified guardrails skip tool-role messages when building evaluation inputs (texts and structured_messages). When False, tool messages are included even if litellm_settings sets a global skip. When None, use the global litellm.skip_tool_message_in_guardrail setting. + */ + skip_tool_message_in_guardrail?: boolean | null; + /** + * Sticky Session Routing + * @description When True (default), after sensitive data is detected and routed, all subsequent requests in the same session will continue routing to the same model. + * @default true + */ + sticky_session_routing: boolean | null; /** * Template Id * @description The ID of your Model Armor template */ template_id?: string | null; + /** + * Timeout + * @description Per-request timeout for the guardrail provider API call (seconds). Accepts int, float, or numeric string; coerced to float on load. Each guardrail handler chooses its own default when unset. + */ + timeout?: number | null; /** * Tool Selection Quality Check * @description Enable tool selection quality check to evaluate quality of tool/function calls. */ tool_selection_quality_check?: boolean | null; + /** + * Tracker Api Base + * @description Base URL for the Ovalix Tracker service. + */ + tracker_api_base?: string | null; + /** + * Tracker Api Key + * @description API key for the Ovalix Tracker service. + */ + tracker_api_key?: string | null; /** * Unreachable Fallback - * @description What to do when Akto is unreachable. 'fail_open' = allow, 'fail_closed' = block. + * @description Behavior when the headroom compression service is unreachable or errors. 'fail_closed' raises an error (default). 'fail_open' logs a critical error and forwards the request uncompressed instead of blocking it. * @default fail_closed * @enum {string} */ @@ -27196,6 +27202,8 @@ export interface components { }; /** MCPCredentials */ MCPCredentials: { + /** Audience */ + audience?: string | null; /** Auth Value */ auth_value?: string | null; /** Aws Access Key Id */ @@ -27216,9 +27224,52 @@ export interface components { client_id?: string | null; /** Client Secret */ client_secret?: string | null; + /** Redirect Uris */ + redirect_uris?: string[] | null; /** Scopes */ scopes?: string[] | null; + /** Subject Token Type */ + subject_token_type?: string | null; + /** Token Endpoint Auth Method */ + token_endpoint_auth_method?: ("client_secret_basic" | "client_secret_post") | null; + /** Token Exchange Endpoint */ + token_exchange_endpoint?: string | null; + /** Token Exchange Profile */ + token_exchange_profile?: string | null; }; + /** + * MCPEnvVar + * @description One environment variable for an MCP server. + * + * Variables can be interpolated into ``static_headers`` using ``${NAME}`` + * syntax. ``scope=global`` values are stored on the server. ``scope=user`` + * values are stored per-user in ``LiteLLM_MCPUserEnvVars`` and supplied by + * each user. + */ + MCPEnvVar: { + /** Description */ + description?: string | null; + /** Name */ + name: string; + /** @default global */ + scope: components["schemas"]["MCPEnvVarScope"]; + /** + * Value + * @default + */ + value: string; + }; + /** + * MCPEnvVarScope + * @description Scope for an MCP server environment variable. + * + * - ``global``: value is provided by the admin and used for all users. + * - ``user``: each user must provide their own value via the per-user + * env-var endpoint. The admin-supplied ``value`` is treated as a + * placeholder/hint and is not used at request time. + * @enum {string} + */ + MCPEnvVarScope: "global" | "user"; /** * MCPOAuthUserCredentialRequest * @description Stores a user's OAuth2 token for an OpenAPI MCP server. @@ -27380,6 +27431,55 @@ export interface components { /** Server Id */ server_id: string; }; + /** + * MCPUserEnvVarSpec + * @description Describes one per-user env var slot for the calling user. + * + * Stored values are write-only: the status only reports whether a value + * ``is_set`` and never echoes the decrypted secret back to the client. + */ + MCPUserEnvVarSpec: { + /** Description */ + description?: string | null; + /** + * Is Set + * @default false + */ + is_set: boolean; + /** Name */ + name: string; + }; + /** + * MCPUserEnvVarsRequest + * @description Payload for storing the calling user's per-user env var values. + */ + MCPUserEnvVarsRequest: { + /** Values */ + values: { + [key: string]: string; + }; + }; + /** + * MCPUserEnvVarsStatus + * @description Per-user env var status for a single MCP server. + */ + MCPUserEnvVarsStatus: { + /** Alias */ + alias?: string | null; + /** + * Missing Count + * @default 0 + */ + missing_count: number; + /** Required */ + required?: components["schemas"]["MCPUserEnvVarSpec"][]; + /** Server Id */ + server_id: string; + /** Server Name */ + server_name?: string | null; + /** Setup Url */ + setup_url?: string | null; + }; /** MakeAgentsPublicRequest */ MakeAgentsPublicRequest: { /** Agent Ids */ @@ -27726,8 +27826,10 @@ export interface components { approval_status?: string | null; /** Args */ args?: string[]; + /** Audience */ + audience?: string | null; /** Auth Type */ - auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token") | null; + auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token" | "oauth2_token_exchange" | "true_passthrough" | "oauth_delegate") | null; /** Authorization Url */ authorization_url?: string | null; /** @@ -27742,12 +27844,21 @@ export interface components { /** Command */ command?: string | null; credentials?: components["schemas"]["MCPCredentials"] | null; + /** Dcr Bridge */ + dcr_bridge?: boolean | null; + /** + * Delegate Auth To Upstream + * @default false + */ + delegate_auth_to_upstream: boolean; /** Description */ description?: string | null; /** Env */ env?: { [key: string]: string; }; + /** Env Vars */ + env_vars?: components["schemas"]["MCPEnvVar"][] | null; /** Extra Headers */ extra_headers?: string[] | null; /** Instructions */ @@ -27757,6 +27868,8 @@ export interface components { * @default false */ is_byok: boolean; + /** Max Concurrent Requests */ + max_concurrent_requests?: number | null; /** Mcp Access Groups */ mcp_access_groups?: string[]; /** Mcp Info */ @@ -27765,6 +27878,11 @@ export interface components { } | null; /** Oauth2 Flow */ oauth2_flow?: ("client_credentials" | "authorization_code") | null; + /** + * Oauth Passthrough + * @default false + */ + oauth_passthrough: boolean; /** Registration Url */ registration_url?: string | null; /** Server Id */ @@ -27779,6 +27897,8 @@ export interface components { static_headers?: { [key: string]: string; } | null; + /** Subject Token Type */ + subject_token_type?: string | null; /** * Submitted At * @description Server-managed: set by the endpoint; caller values are overridden. @@ -27789,6 +27909,12 @@ export interface components { * @description Server-managed: set by the endpoint; caller values are overridden. */ submitted_by?: string | null; + /** Timeout */ + timeout?: number | null; + /** Token Exchange Endpoint */ + token_exchange_endpoint?: string | null; + /** Token Exchange Profile */ + token_exchange_profile?: string | null; /** Token Url */ token_url?: string | null; /** Tool Name To Description */ @@ -28751,7 +28877,7 @@ export interface components { } | null; /** Guardrail Name */ guardrail_name?: string | null; - litellm_params?: components["schemas"]["BaseLitellmParams-Input"] | null; + litellm_params?: components["schemas"]["BaseLitellmParams"] | null; }; /** PatchPromptRequest */ PatchPromptRequest: { @@ -28831,7 +28957,7 @@ export interface components { * PiiEntityType * @enum {string} */ - PiiEntityType: "CREDIT_CARD" | "CRYPTO" | "DATE_TIME" | "EMAIL_ADDRESS" | "IBAN_CODE" | "IP_ADDRESS" | "NRP" | "LOCATION" | "PERSON" | "PHONE_NUMBER" | "MEDICAL_LICENSE" | "URL" | "US_BANK_NUMBER" | "US_DRIVER_LICENSE" | "US_ITIN" | "US_PASSPORT" | "US_SSN" | "UK_NHS" | "UK_NINO" | "ES_NIF" | "ES_NIE" | "IT_FISCAL_CODE" | "IT_DRIVER_LICENSE" | "IT_VAT_CODE" | "IT_PASSPORT" | "IT_IDENTITY_CARD" | "PL_PESEL" | "SG_NRIC_FIN" | "SG_UEN" | "AU_ABN" | "AU_ACN" | "AU_TFN" | "AU_MEDICARE" | "IN_PAN" | "IN_AADHAAR" | "IN_VEHICLE_REGISTRATION" | "IN_VOTER" | "IN_PASSPORT" | "FI_PERSONAL_IDENTITY_CODE"; + PiiEntityType: "CREDIT_CARD" | "CRYPTO" | "DATE_TIME" | "EMAIL_ADDRESS" | "IBAN_CODE" | "IP_ADDRESS" | "NRP" | "LOCATION" | "PERSON" | "PHONE_NUMBER" | "MEDICAL_LICENSE" | "URL" | "US_BANK_NUMBER" | "US_DRIVER_LICENSE" | "US_ITIN" | "US_PASSPORT" | "US_SSN" | "UK_NHS" | "UK_NINO" | "UK_PASSPORT" | "UK_POSTCODE" | "UK_VEHICLE_REGISTRATION" | "ES_NIF" | "ES_NIE" | "IT_FISCAL_CODE" | "IT_DRIVER_LICENSE" | "IT_VAT_CODE" | "IT_PASSPORT" | "IT_IDENTITY_CARD" | "PL_PESEL" | "SG_NRIC_FIN" | "SG_UEN" | "AU_ABN" | "AU_ACN" | "AU_TFN" | "AU_MEDICARE" | "IN_PAN" | "IN_AADHAAR" | "IN_VEHICLE_REGISTRATION" | "IN_VOTER" | "IN_PASSPORT" | "FI_PERSONAL_IDENTITY_CODE"; /** * PipelineTestRequest * @description Request body for testing a guardrail pipeline with sample messages. @@ -29940,6 +30066,21 @@ export interface components { /** Value */ value: string; }; + /** + * RealtimeTranscriptionSessionResponse + * @description Response from POST /v1/realtime/transcription_sessions. + * + * `client_secret.value` contains the encrypted token instead of the raw + * ephemeral key. Unknown fields pass through unchanged. + */ + RealtimeTranscriptionSessionResponse: { + /** Client Secret */ + client_secret?: { + [key: string]: unknown; + } | null; + } & { + [key: string]: unknown; + }; /** RegenerateKeyRequest */ RegenerateKeyRequest: { /** Access Group Ids */ @@ -30197,10 +30338,6 @@ export interface components { /** Reset To */ reset_to: number; }; - /** ResponseLiteLLM_ManagedVectorStore */ - ResponseLiteLLM_ManagedVectorStore: { - vector_store?: components["schemas"]["LiteLLM_ManagedVectorStoresTable"]; - }; /** * ResultCounts * @description Result counts for a run @@ -30417,6 +30554,20 @@ export interface components { /** Run Id */ run_id: string; }; + /** SCIMEnterpriseUser */ + SCIMEnterpriseUser: { + /** Costcenter */ + costCenter?: string | null; + /** Department */ + department?: string | null; + /** Division */ + division?: string | null; + /** Employeenumber */ + employeeNumber?: string | null; + manager?: components["schemas"]["SCIMUserManager"] | null; + /** Organization */ + organization?: string | null; + }; /** SCIMFeature */ SCIMFeature: { /** Maxoperations */ @@ -30448,7 +30599,7 @@ export interface components { /** SCIMListResponse */ SCIMListResponse: { /** Resources */ - Resources: components["schemas"]["SCIMUser"][] | components["schemas"]["SCIMGroup"][]; + Resources: components["schemas"]["SCIMUser-Output"][] | components["schemas"]["SCIMGroup"][]; /** * Itemsperpage * @default 10 @@ -30552,7 +30703,7 @@ export interface components { sort: components["schemas"]["SCIMFeature"]; }; /** SCIMUser */ - SCIMUser: { + "SCIMUser-Input": { /** * Active * @default true @@ -30575,9 +30726,13 @@ export interface components { name?: components["schemas"]["SCIMUserName"] | null; /** Schemas */ schemas: string[]; + "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: components["schemas"]["SCIMEnterpriseUser"] | null; /** Username */ userName?: string | null; }; + "SCIMUser-Output": { + [key: string]: unknown; + }; /** SCIMUserEmail */ SCIMUserEmail: { /** Primary */ @@ -30602,6 +30757,15 @@ export interface components { /** Value */ value: string; }; + /** SCIMUserManager */ + SCIMUserManager: { + /** $Ref */ + $ref?: string | null; + /** Displayname */ + displayName?: string | null; + /** Value */ + value?: string | null; + }; /** SCIMUserName */ SCIMUserName: { /** Familyname */ @@ -32062,8 +32226,10 @@ export interface components { allowed_tools?: string[] | null; /** Args */ args?: string[]; + /** Audience */ + audience?: string | null; /** Auth Type */ - auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token") | null; + auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token" | "oauth2_token_exchange" | "true_passthrough" | "oauth_delegate") | null; /** Authorization Url */ authorization_url?: string | null; /** @@ -32078,12 +32244,21 @@ export interface components { /** Command */ command?: string | null; credentials?: components["schemas"]["MCPCredentials"] | null; + /** Dcr Bridge */ + dcr_bridge?: boolean | null; + /** + * Delegate Auth To Upstream + * @default false + */ + delegate_auth_to_upstream: boolean; /** Description */ description?: string | null; /** Env */ env?: { [key: string]: string; }; + /** Env Vars */ + env_vars?: components["schemas"]["MCPEnvVar"][] | null; /** Extra Headers */ extra_headers?: string[] | null; /** Instructions */ @@ -32093,12 +32268,21 @@ export interface components { * @default false */ is_byok: boolean; + /** Max Concurrent Requests */ + max_concurrent_requests?: number | null; /** Mcp Access Groups */ mcp_access_groups?: string[]; /** Mcp Info */ mcp_info?: { [key: string]: unknown; } | null; + /** Oauth2 Flow */ + oauth2_flow?: ("client_credentials" | "authorization_code") | null; + /** + * Oauth Passthrough + * @default false + */ + oauth_passthrough: boolean; /** Registration Url */ registration_url?: string | null; /** Server Id */ @@ -32113,6 +32297,14 @@ export interface components { static_headers?: { [key: string]: string; } | null; + /** Subject Token Type */ + subject_token_type?: string | null; + /** Timeout */ + timeout?: number | null; + /** Token Exchange Endpoint */ + token_exchange_endpoint?: string | null; + /** Token Exchange Profile */ + token_exchange_profile?: string | null; /** Token Url */ token_url?: string | null; /** Tool Name To Description */ @@ -33252,31 +33444,6 @@ export interface components { */ status?: string | null; }; - /** VectorStoreDeleteRequest */ - VectorStoreDeleteRequest: { - /** Vector Store Id */ - vector_store_id: string; - }; - /** VectorStoreInfoRequest */ - VectorStoreInfoRequest: { - /** Vector Store Id */ - vector_store_id: string; - }; - /** VectorStoreUpdateRequest */ - VectorStoreUpdateRequest: { - /** Custom Llm Provider */ - custom_llm_provider?: string | null; - /** Vector Store Description */ - vector_store_description?: string | null; - /** Vector Store Id */ - vector_store_id: string; - /** Vector Store Metadata */ - vector_store_metadata?: { - [key: string]: unknown; - } | null; - /** Vector Store Name */ - vector_store_name?: string | null; - }; /** WorkerRegistryEntry */ WorkerRegistryEntry: { /** Name */ @@ -37124,7 +37291,10 @@ export interface operations { update_hashicorp_vault_config_config_overrides_hashicorp_vault_post: { parameters: { query?: never; - header?: never; + header?: { + /** @description The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability */ + "litellm-changed-by"?: string | null; + }; path?: never; cookie?: never; }; @@ -37157,7 +37327,10 @@ export interface operations { delete_hashicorp_vault_config_config_overrides_hashicorp_vault_delete: { parameters: { query?: never; - header?: never; + header?: { + /** @description The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability */ + "litellm-changed-by"?: string | null; + }; path?: never; cookie?: never; }; @@ -37172,6 +37345,15 @@ export interface operations { "application/json": unknown; }; }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; }; }; test_hashicorp_vault_connection_config_overrides_hashicorp_vault_test_connection_post: { @@ -43008,6 +43190,12 @@ export interface operations { query?: { /** @description The server id to list tools for */ server_id?: string | null; + /** @description Filter tools to a single MCP server by name or alias */ + mcp_server_name?: string | null; + /** @description Filter tools to a single toolset by name */ + toolset_name?: string | null; + /** @description Admin only. Return the full server tool catalog without the allowed_tools filter or per-key tool permissions, so the MCP settings UI can configure the allowlist. Ignored for non-admins. */ + include_disabled_tools?: boolean; }; header?: never; path?: never; @@ -44712,6 +44900,26 @@ export interface operations { }; }; }; + create_realtime_transcription_session_openai_v1_realtime_transcription_sessions_post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["RealtimeTranscriptionSessionResponse"]; + }; + }; + }; + }; responses_api_openai_v1_responses_post: { parameters: { query?: never; @@ -47451,6 +47659,26 @@ export interface operations { }; }; }; + create_realtime_transcription_session_realtime_transcription_sessions_post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["RealtimeTranscriptionSessionResponse"]; + }; + }; + }; + }; reload_anthropic_beta_headers_reload_anthropic_beta_headers_post: { parameters: { query?: never; @@ -48357,7 +48585,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["SCIMUser"]; + "application/json": components["schemas"]["SCIMUser-Input"]; }; }; responses: { @@ -48367,7 +48595,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SCIMUser"]; + "application/json": components["schemas"]["SCIMUser-Output"]; }; }; /** @description Validation Error */ @@ -48400,7 +48628,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SCIMUser"]; + "application/json": components["schemas"]["SCIMUser-Output"]; }; }; /** @description Validation Error */ @@ -48427,7 +48655,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["SCIMUser"]; + "application/json": components["schemas"]["SCIMUser-Input"]; }; }; responses: { @@ -48437,7 +48665,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SCIMUser"]; + "application/json": components["schemas"]["SCIMUser-Output"]; }; }; /** @description Validation Error */ @@ -48505,7 +48733,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["SCIMUser"]; + "application/json": components["schemas"]["SCIMUser-Output"]; }; }; /** @description Validation Error */ @@ -51892,16 +52120,18 @@ export interface operations { }; }; }; - invoke_agent_a2a_v1_a2a__agent_id__message_send_post: { + discover_agent_card_v1_a2a_discover_post: { parameters: { query?: never; header?: never; - path: { - agent_id: string; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["DiscoverAgentRequest"]; + }; + }; responses: { /** @description Successful Response */ 200: { @@ -51909,7 +52139,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": unknown; + "application/json": components["schemas"]["DiscoverAgentResponse"]; }; }; /** @description Validation Error */ @@ -54613,6 +54843,103 @@ export interface operations { }; }; }; + get_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_get: { + parameters: { + query?: never; + header?: never; + path: { + server_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MCPUserEnvVarsStatus"]; + }; + }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; + store_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_post: { + parameters: { + query?: never; + header?: never; + path: { + server_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["MCPUserEnvVarsRequest"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MCPUserEnvVarsStatus"]; + }; + }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; + clear_mcp_user_env_vars_v1_mcp_server__server_id__user_env_vars_delete: { + parameters: { + query?: never; + header?: never; + path: { + server_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MCPUserEnvVarsStatus"]; + }; + }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; get_mcp_tools_v1_mcp_tools_get: { parameters: { query?: never; @@ -54807,6 +55134,26 @@ export interface operations { }; }; }; + list_mcp_user_env_var_status_v1_mcp_user_env_vars_status_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MCPUserEnvVarsStatus"][]; + }; + }; + }; + }; list_memory_v1_memory_get: { parameters: { query?: { @@ -55258,6 +55605,26 @@ export interface operations { }; }; }; + create_realtime_transcription_session_v1_realtime_transcription_sessions_post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["RealtimeTranscriptionSessionResponse"]; + }; + }; + }; + }; rerank_v1_rerank_post: { parameters: { query?: never; @@ -56218,38 +56585,6 @@ export interface operations { }; }; }; - list_vector_stores_v1_vector_store_list_get: { - parameters: { - query?: { - page?: number; - page_size?: number; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Successful Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["LiteLLM_ManagedVectorStoreListResponse"]; - }; - }; - /** @description Validation Error */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; vector_store_list_v1_vector_stores_get: { parameters: { query?: { @@ -57134,6 +57469,139 @@ export interface operations { }; }; }; + list_gemini_agents_v1beta_agents_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + }; + }; + create_gemini_agent_v1beta_agents_post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + }; + }; + get_gemini_agent_v1beta_agents__name__get: { + parameters: { + query?: never; + header?: never; + path: { + name: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; + delete_gemini_agent_v1beta_agents__name__delete: { + parameters: { + query?: never; + header?: never; + path: { + name: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; + list_gemini_agent_versions_v1beta_agents__name__versions_get: { + parameters: { + query?: never; + header?: never; + path: { + name: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Validation Error */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HTTPValidationError"]; + }; + }; + }; + }; create_interaction_v1beta_interactions_post: { parameters: { query?: never; @@ -57778,170 +58246,6 @@ export interface operations { }; }; }; - delete_vector_store_vector_store_delete_post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["VectorStoreDeleteRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": unknown; - }; - }; - /** @description Validation Error */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - get_vector_store_info_vector_store_info_post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["VectorStoreInfoRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ResponseLiteLLM_ManagedVectorStore"]; - }; - }; - /** @description Validation Error */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - list_vector_stores_vector_store_list_get: { - parameters: { - query?: { - page?: number; - page_size?: number; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Successful Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["LiteLLM_ManagedVectorStoreListResponse"]; - }; - }; - /** @description Validation Error */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - new_vector_store_vector_store_new_post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["LiteLLM_ManagedVectorStore"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": unknown; - }; - }; - /** @description Validation Error */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; - update_vector_store_vector_store_update_post: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["VectorStoreUpdateRequest"]; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": unknown; - }; - }; - /** @description Validation Error */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["HTTPValidationError"]; - }; - }; - }; - }; vector_store_list_vector_stores_get: { parameters: { query?: {