litellm/ui/litellm-dashboard/src/lib/http/schema.d.ts

58326 lines
1.9 MiB
Generated

/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Home */
get: operations["home__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/.well-known/litellm-ui-config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Ui Config */
get: operations["get_ui_config__well_known_litellm_ui_config_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/a2a/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Invoke Agent A2A
* @description Invoke an agent using the A2A protocol (JSON-RPC 2.0).
*
* Supported methods:
* - message/send: Send a message and get a response
* - message/stream: Send a message and stream the response
*/
post: operations["invoke_agent_a2a_a2a__agent_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/a2a/{agent_id}/.well-known/agent-card.json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Card
* @description Get the agent card for an agent (A2A discovery endpoint).
*
* Supports both standard paths:
* - /.well-known/agent-card.json
* - /.well-known/agent.json
*
* The URL in the agent card is rewritten to point to the LiteLLM proxy,
* so all subsequent A2A calls go through LiteLLM for logging and cost tracking.
*/
get: operations["get_agent_card_a2a__agent_id___well_known_agent_card_json_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/a2a/{agent_id}/.well-known/agent.json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Card
* @description Get the agent card for an agent (A2A discovery endpoint).
*
* Supports both standard paths:
* - /.well-known/agent-card.json
* - /.well-known/agent.json
*
* The URL in the agent card is rewritten to point to the LiteLLM proxy,
* so all subsequent A2A calls go through LiteLLM for logging and cost tracking.
*/
get: operations["get_agent_card_a2a__agent_id___well_known_agent_json_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/a2a/{agent_id}/message/send": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Invoke Agent A2A
* @description Invoke an agent using the A2A protocol (JSON-RPC 2.0).
*
* Supported methods:
* - message/send: Send a message and get a response
* - message/stream: Send a message and stream the response
*/
post: operations["invoke_agent_a2a_a2a__agent_id__message_send_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/access_group/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Access Groups
* @description List all access groups.
*
* Returns a list of all access groups with their model names and deployment counts.
*
* Example:
* ```bash
* curl -X GET 'http://localhost:4000/access_group/list' \
* -H 'Authorization: Bearer sk-1234'
* ```
*
* Returns:
* - ListAccessGroupsResponse with all access groups
*/
get: operations["list_access_groups_access_group_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/access_group/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Model Group
* @description Create a new access group containing multiple model names.
*
* An access group is a named collection of model groups that can be referenced
* by teams/keys for simplified access control.
*
* Example:
* ```bash
* curl -X POST 'http://localhost:4000/access_group/new' \
* -H 'Authorization: Bearer sk-1234' \
* -H 'Content-Type: application/json' \
* -d '{
* "access_group": "production-models",
* "model_names": ["gpt-4", "claude-3-opus", "gemini-pro"]
* }'
* ```
*
* Parameters:
* - access_group: str - The access group name (e.g., "production-models")
* - model_names: List[str] - List of existing model groups to include
*
* Returns:
* - NewModelGroupResponse with the created access group details
*
* Raises:
* - HTTPException 400: If any model names don't exist
* - HTTPException 500: If database operations fail
*/
post: operations["create_model_group_access_group_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/access_group/{access_group}/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Access Group
* @description Delete an access group.
*
* Removes the access group from all deployments that have it.
*
* Example:
* ```bash
* curl -X DELETE 'http://localhost:4000/access_group/production-models/delete' \
* -H 'Authorization: Bearer sk-1234'
* ```
*
* Parameters:
* - access_group: str - The access group name (URL path parameter)
*
* Returns:
* - DeleteModelGroupResponse with deletion details
*
* Raises:
* - HTTPException 404: If access group not found
*/
delete: operations["delete_access_group_access_group__access_group__delete_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/access_group/{access_group}/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Access Group Info
* @description Get information about a specific access group.
*
* Example:
* ```bash
* curl -X GET 'http://localhost:4000/access_group/production-models/info' \
* -H 'Authorization: Bearer sk-1234'
* ```
*
* Parameters:
* - access_group: str - The access group name (URL path parameter)
*
* Returns:
* - AccessGroupInfo with the access group details
*
* Raises:
* - HTTPException 404: If access group not found
*/
get: operations["get_access_group_info_access_group__access_group__info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/access_group/{access_group}/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Access Group
* @description Update an access group's model names.
*
* This will:
* 1. Remove the access group from all current deployments
* 2. Add the access group to all deployments for the new model_names list
*
* Example:
* ```bash
* curl -X PUT 'http://localhost:4000/access_group/production-models/update' \
* -H 'Authorization: Bearer sk-1234' \
* -H 'Content-Type: application/json' \
* -d '{
* "model_names": ["gpt-4", "claude-3-sonnet"]
* }'
* ```
*
* Parameters:
* - access_group: str - The access group name (URL path parameter)
* - model_names: List[str] - New list of model groups to include
*
* Returns:
* - NewModelGroupResponse with the updated access group details
*
* Raises:
* - HTTPException 400: If any model names don't exist
* - HTTPException 404: If access group not found
*/
put: operations["update_access_group_access_group__access_group__update_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/active/callbacks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Active Callbacks
* @description Returns a list of litellm level settings
*
* This is useful for debugging and ensuring the proxy server is configured correctly.
*
* Response schema:
* ```
* {
* "alerting": _alerting,
* "litellm.callbacks": litellm_callbacks,
* "litellm.input_callback": litellm_input_callbacks,
* "litellm.failure_callback": litellm_failure_callbacks,
* "litellm.success_callback": litellm_success_callbacks,
* "litellm._async_success_callback": litellm_async_success_callbacks,
* "litellm._async_failure_callback": litellm_async_failure_callbacks,
* "litellm._async_input_callback": litellm_async_input_callbacks,
* "all_litellm_callbacks": all_litellm_callbacks,
* "num_callbacks": len(all_litellm_callbacks),
* "num_alerting": _num_alerting,
* "litellm.request_timeout": litellm.request_timeout,
* }
* ```
*/
get: operations["active_callbacks_active_callbacks_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/adaptive_router/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Adaptive Router State
* @description Return live bandit posteriors + queue depth for every configured adaptive router.
*
* Admin-only. Returns 404 if no adaptive router is configured.
*
* Response shape: `{"routers": [<snapshot>, ...]}` — one snapshot per
* adaptive-router deployment. Each snapshot's `router_name` field identifies
* which deployment it came from.
*/
get: operations["get_adaptive_router_state_adaptive_router_state_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/add/allowed_ip": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Add Allowed Ip */
post: operations["add_allowed_ip_add_allowed_ip_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/agent/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Daily Activity
* @description Get daily activity for specific agents or all accessible agents.
*/
get: operations["get_agent_daily_activity_agent_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/alerting/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Alerting Settings
* @description Return the configurable alerting param, description, and current value
*/
get: operations["alerting_settings_alerting_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/anthropic/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Anthropic Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/anthropic_completion)
*/
get: operations["anthropic_proxy_route_anthropic__endpoint__get"];
/**
* Anthropic Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/anthropic_completion)
*/
put: operations["anthropic_proxy_route_anthropic__endpoint__put"];
/**
* Anthropic Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/anthropic_completion)
*/
post: operations["anthropic_proxy_route_anthropic__endpoint__post"];
/**
* Anthropic Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/anthropic_completion)
*/
delete: operations["anthropic_proxy_route_anthropic__endpoint__delete"];
options?: never;
head?: never;
/**
* Anthropic Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/anthropic_completion)
*/
patch: operations["anthropic_proxy_route_anthropic__endpoint__patch"];
trace?: never;
};
"/api/event_logging/batch": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Event Logging Batch
* @description Stubbed endpoint for Anthropic event logging batch requests.
*
* This endpoint accepts event logging requests but does nothing with them.
* It exists to prevent 404 errors from Claude Code clients that send telemetry.
*/
post: operations["event_logging_batch_api_event_logging_batch_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/apply_guardrail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Apply Guardrail
* @description Apply a guardrail to text input and return the processed result.
*
* This endpoint allows testing guardrails by applying them to custom text inputs.
*/
post: operations["apply_guardrail_apply_guardrail_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/assemblyai/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Assemblyai Proxy Route */
get: operations["assemblyai_proxy_route_assemblyai__endpoint__get"];
/** Assemblyai Proxy Route */
put: operations["assemblyai_proxy_route_assemblyai__endpoint__put"];
/** Assemblyai Proxy Route */
post: operations["assemblyai_proxy_route_assemblyai__endpoint__post"];
/** Assemblyai Proxy Route */
delete: operations["assemblyai_proxy_route_assemblyai__endpoint__delete"];
options?: never;
head?: never;
/** Assemblyai Proxy Route */
patch: operations["assemblyai_proxy_route_assemblyai__endpoint__patch"];
trace?: never;
};
"/assistants": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Assistants
* @description Returns a list of assistants.
*
* API Reference docs - https://platform.openai.com/docs/api-reference/assistants/listAssistants
*/
get: operations["get_assistants_assistants_get"];
put?: never;
/**
* Create Assistant
* @description Create assistant
*
* API Reference docs - https://platform.openai.com/docs/api-reference/assistants/createAssistant
*/
post: operations["create_assistant_assistants_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/assistants/{assistant_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Assistant
* @description Delete assistant
*
* API Reference docs - https://platform.openai.com/docs/api-reference/assistants/createAssistant
*/
delete: operations["delete_assistant_assistants__assistant_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/audio/speech": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Audio Speech
* @description Same params as:
*
* https://platform.openai.com/docs/api-reference/audio/createSpeech
*/
post: operations["audio_speech_audio_speech_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/audio/transcriptions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Audio Transcriptions
* @description Same params as:
*
* https://platform.openai.com/docs/api-reference/audio/createTranscription?lang=curl
*/
post: operations["audio_transcriptions_audio_transcriptions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/audit": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Audit Logs
* @description Get all audit logs with filtering and pagination.
*
* Returns a paginated response of audit logs matching the specified filters.
*
* Note: object_team_id and object_key_hash use Prisma JSON path filtering,
* which requires PostgreSQL.
*/
get: operations["get_audit_logs_audit_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/audit/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Audit Log By Id
* @description Get detailed information about a specific audit log entry by its ID.
*
* Args:
* id (str): The unique identifier of the audit log entry
*
* Returns:
* AuditLogResponse: Detailed information about the audit log entry
*
* Raises:
* HTTPException: If the audit log is not found or if there's a database connection error
*/
get: operations["get_audit_log_by_id_audit__id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/azure/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
get: operations["azure_proxy_route_azure__endpoint__get"];
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
put: operations["azure_proxy_route_azure__endpoint__put"];
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
post: operations["azure_proxy_route_azure__endpoint__post"];
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
delete: operations["azure_proxy_route_azure__endpoint__delete"];
options?: never;
head?: never;
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
patch: operations["azure_proxy_route_azure__endpoint__patch"];
trace?: never;
};
"/azure_ai/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
get: operations["azure_proxy_route_azure_ai__endpoint__get"];
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
put: operations["azure_proxy_route_azure_ai__endpoint__put"];
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
post: operations["azure_proxy_route_azure_ai__endpoint__post"];
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
delete: operations["azure_proxy_route_azure_ai__endpoint__delete"];
options?: never;
head?: never;
/**
* Azure Proxy Route
* @description Call any azure endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/azure/{endpoint:path}`
*
* Checks if the deployment id in the url is a litellm model name. If so, it will route using the llm_router.allm_passthrough_route.
*/
patch: operations["azure_proxy_route_azure_ai__endpoint__patch"];
trace?: never;
};
"/batches": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Batches
* @description Lists
* This is the equivalent of GET https://api.openai.com/v1/batches/
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches?limit=2 -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*/
get: operations["list_batches_batches_get"];
put?: never;
/**
* Create Batch
* @description Create large batches of API requests for asynchronous processing.
* This is the equivalent of POST https://api.openai.com/v1/batch
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "input_file_id": "file-abc123",
* "endpoint": "/v1/chat/completions",
* "completion_window": "24h"
* }'
* ```
*/
post: operations["create_batch_batches_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/batches/{batch_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Retrieve Batch
* @description Retrieves a batch.
* This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id}
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches/batch_abc123 -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*/
get: operations["retrieve_batch_batches__batch_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/batches/{batch_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Batch
* @description Cancel a batch.
* This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches/batch_abc123/cancel -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -X POST
*
* ```
*/
post: operations["cancel_batch_batches__batch_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/bedrock/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Bedrock Proxy Route
* @description This is the v1 passthrough for Bedrock.
* V2 is handled by the `/bedrock/v2` endpoint.
* [Docs](https://docs.litellm.ai/docs/pass_through/bedrock)
*/
get: operations["bedrock_proxy_route_bedrock__endpoint__get"];
/**
* Bedrock Proxy Route
* @description This is the v1 passthrough for Bedrock.
* V2 is handled by the `/bedrock/v2` endpoint.
* [Docs](https://docs.litellm.ai/docs/pass_through/bedrock)
*/
put: operations["bedrock_proxy_route_bedrock__endpoint__put"];
/**
* Bedrock Proxy Route
* @description This is the v1 passthrough for Bedrock.
* V2 is handled by the `/bedrock/v2` endpoint.
* [Docs](https://docs.litellm.ai/docs/pass_through/bedrock)
*/
post: operations["bedrock_proxy_route_bedrock__endpoint__post"];
/**
* Bedrock Proxy Route
* @description This is the v1 passthrough for Bedrock.
* V2 is handled by the `/bedrock/v2` endpoint.
* [Docs](https://docs.litellm.ai/docs/pass_through/bedrock)
*/
delete: operations["bedrock_proxy_route_bedrock__endpoint__delete"];
options?: never;
head?: never;
/**
* Bedrock Proxy Route
* @description This is the v1 passthrough for Bedrock.
* V2 is handled by the `/bedrock/v2` endpoint.
* [Docs](https://docs.litellm.ai/docs/pass_through/bedrock)
*/
patch: operations["bedrock_proxy_route_bedrock__endpoint__patch"];
trace?: never;
};
"/budget/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Budget
* @description Delete budget
*
* Parameters:
* - id: str - The budget id to delete
*/
post: operations["delete_budget_budget_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/budget/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Info Budget
* @description Get the budget id specific information
*
* Parameters:
* - budgets: List[str] - The list of budget ids to get information for
*/
post: operations["info_budget_budget_info_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/budget/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Budget
* @description List all the created budgets in proxy db. Used on Admin UI.
*/
get: operations["list_budget_budget_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/budget/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New Budget
* @description Create a new budget object. Can apply this to teams, orgs, end-users, keys.
*
* Parameters:
* - budget_duration: Optional[str] - Budget reset period ("30d", "1h", etc.)
* - budget_id: Optional[str] - The id of the budget. If not provided, a new id will be generated.
* - max_budget: Optional[float] - The max budget for the budget.
* - soft_budget: Optional[float] - The soft budget for the budget.
* - max_parallel_requests: Optional[int] - The max number of parallel requests for the budget.
* - tpm_limit: Optional[int] - The tokens per minute limit for the budget.
* - rpm_limit: Optional[int] - The requests per minute limit for the budget.
* - model_max_budget: Optional[dict] - Specify max budget for a given model. Example: {"openai/gpt-4o-mini": {"max_budget": 100.0, "budget_duration": "1d", "tpm_limit": 100000, "rpm_limit": 100000}}
* - budget_reset_at: Optional[datetime] - Datetime when the initial budget is reset. Default is now.
*/
post: operations["new_budget_budget_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/budget/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Budget Settings
* @description Get list of configurable params + current value for a budget item + description of each field
*
* Used on Admin UI.
*
* Query Parameters:
* - budget_id: str - The budget id to get information for
*/
get: operations["budget_settings_budget_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/budget/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Budget
* @description Update an existing budget object.
*
* Parameters:
* - budget_duration: Optional[str] - Budget reset period ("30d", "1h", etc.)
* - budget_id: Optional[str] - The id of the budget. If not provided, a new id will be generated.
* - max_budget: Optional[float] - The max budget for the budget.
* - soft_budget: Optional[float] - The soft budget for the budget.
* - max_parallel_requests: Optional[int] - The max number of parallel requests for the budget.
* - tpm_limit: Optional[int] - The tokens per minute limit for the budget.
* - rpm_limit: Optional[int] - The requests per minute limit for the budget.
* - model_max_budget: Optional[dict] - Specify max budget for a given model. Example: {"openai/gpt-4o-mini": {"max_budget": 100.0, "budget_duration": "1d", "tpm_limit": 100000, "rpm_limit": 100000}}
* - budget_reset_at: Optional[datetime] - Update the Datetime when the budget was last reset.
*/
post: operations["update_budget_budget_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cache/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cache Delete
* @description Endpoint for deleting a key from the cache. All responses from litellm proxy have `x-litellm-cache-key` in the headers
*
* Parameters:
* - **keys**: *Optional[List[str]]* - A list of keys to delete from the cache. Example {"keys": ["key1", "key2"]}
*
* ```shell
* curl -X POST "http://0.0.0.0:4000/cache/delete" -H "Authorization: Bearer sk-1234" -d '{"keys": ["key1", "key2"]}'
* ```
*/
post: operations["cache_delete_cache_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cache/flushall": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cache Flushall
* @description A function to flush all items from the cache. (All items will be deleted from the cache with this)
* Raises HTTPException if the cache is not initialized or if the cache type does not support flushing.
* Returns a dictionary with the status of the operation.
*
* Usage:
* ```
* curl -X POST http://0.0.0.0:4000/cache/flushall -H "Authorization: Bearer sk-1234"
* ```
*/
post: operations["cache_flushall_cache_flushall_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cache/ping": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Cache Ping
* @description Endpoint for checking if cache can be pinged
*/
get: operations["cache_ping_cache_ping_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cache/redis/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Cache Redis Info
* @description Endpoint for getting /redis/info
*/
get: operations["cache_redis_info_cache_redis_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cache/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Cache Settings
* @description Get cache configuration and available settings.
*
* Returns:
* - fields: List of all configurable cache settings with their metadata (type, description, default, options)
* - current_values: Current values of cache settings from database
*/
get: operations["get_cache_settings_cache_settings_get"];
put?: never;
/**
* Update Cache Settings
* @description Save cache settings to database and initialize cache.
*
* This endpoint:
* 1. Encrypts sensitive fields (passwords, etc.)
* 2. Saves to LiteLLM_CacheConfig table
* 3. Reinitializes cache with new settings
*/
post: operations["update_cache_settings_cache_settings_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cache/settings/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Cache Connection
* @description Test cache connection with provided credentials.
*
* Creates a temporary cache instance and uses its test_connection method
* to verify the credentials work without affecting global state.
*/
post: operations["test_cache_connection_cache_settings_test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/callbacks/configs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Callback Configs
* @description Get Available Callback Configurations
*
* Returns the configuration details for all available logging callbacks,
* including supported parameters, field types, and descriptions.
*/
get: operations["get_callback_configs_callbacks_configs_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/callbacks/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Callbacks
* @description View List of Active Logging Callbacks
*/
get: operations["list_callbacks_callbacks_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/chat/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Chat Completion
* @description Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`
*
* ```bash
* curl -X POST http://localhost:4000/v1/chat/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-4o",
* "messages": [
* {
* "role": "user",
* "content": "Hello!"
* }
* ]
* }'
* ```
*/
post: operations["chat_completion_chat_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/claude-code/marketplace.json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Marketplace
* @description Serve marketplace.json for Claude Code plugin discovery.
*
* This endpoint is accessed by Claude Code CLI when users run:
* - claude plugin marketplace add <url>
* - claude plugin install <name>@<marketplace>
*
* Returns:
* Marketplace catalog with list of available plugins and their git sources.
*
* Example:
* ```bash
* claude plugin marketplace add http://localhost:4000/claude-code/marketplace.json
* claude plugin install my-plugin@litellm
* ```
*/
get: operations["get_marketplace_claude_code_marketplace_json_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/claude-code/plugins": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Plugins
* @description List all plugins in the marketplace.
*
* Parameters:
* - enabled_only: If true, only return enabled plugins
*
* Returns:
* List of plugins with their metadata.
*/
get: operations["list_plugins_claude_code_plugins_get"];
put?: never;
/**
* Register Plugin
* @description Register a plugin in the LiteLLM marketplace.
*
* LiteLLM acts as a registry/discovery layer. Plugins are hosted on
* GitHub/GitLab/Bitbucket. Claude Code will clone from the git source
* when users install.
*
* Parameters:
* - name: Plugin name (kebab-case)
* - source: Git source reference (github, url, or git-subdir format)
* - version: Semantic version (optional)
* - description: Plugin description (optional)
* - author: Author information (optional)
* - homepage: Plugin homepage URL (optional)
* - keywords: Search keywords (optional)
* - category: Plugin category (optional)
*
* Returns:
* Registration status and plugin information.
*
* Example:
* ```bash
* curl -X POST http://localhost:4000/claude-code/plugins \
* -H "Authorization: Bearer sk-..." \
* -H "Content-Type: application/json" \
* -d '{
* "name": "my-plugin",
* "source": {"source": "github", "repo": "org/my-plugin"},
* "version": "1.0.0",
* "description": "My awesome plugin"
* }'
* ```
*/
post: operations["register_plugin_claude_code_plugins_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/claude-code/plugins/{plugin_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Plugin
* @description Get details of a specific plugin.
*
* Parameters:
* - plugin_name: The name of the plugin
*
* Returns:
* Plugin details including source and metadata.
*/
get: operations["get_plugin_claude_code_plugins__plugin_name__get"];
put?: never;
post?: never;
/**
* Delete Plugin
* @description Delete a plugin from the marketplace.
*
* Parameters:
* - plugin_name: The name of the plugin to delete
*/
delete: operations["delete_plugin_claude_code_plugins__plugin_name__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/claude-code/plugins/{plugin_name}/disable": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Disable Plugin
* @description Disable a plugin without deleting it.
*
* Parameters:
* - plugin_name: The name of the plugin to disable
*/
post: operations["disable_plugin_claude_code_plugins__plugin_name__disable_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/claude-code/plugins/{plugin_name}/enable": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Enable Plugin
* @description Enable a disabled plugin.
*
* Parameters:
* - plugin_name: The name of the plugin to enable
*/
post: operations["enable_plugin_claude_code_plugins__plugin_name__enable_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cloudzero/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Cloudzero Settings
* @description Delete CloudZero settings from the database.
*
* This endpoint removes the CloudZero configuration (API key, connection ID, timezone)
* from the proxy database. Only the CloudZero settings entry will be deleted;
* other configuration values in the database will remain unchanged.
*
* Only admin users can delete CloudZero settings.
*/
delete: operations["delete_cloudzero_settings_cloudzero_delete_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cloudzero/dry-run": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cloudzero Dry Run Export
* @description Perform a dry run export using the CloudZero logger.
*
* This endpoint uses the CloudZero logger to perform a dry run export,
* which returns the data that would be exported without actually sending it to CloudZero.
*
* Parameters:
* - limit: Optional limit on number of records to process (default: 10000)
*
* Returns:
* - usage_data: Sample of the raw usage data (first 50 records)
* - cbf_data: CloudZero CBF formatted data ready for export
* - summary: Statistics including total cost, tokens, and record counts
*
* Only admin users can perform CloudZero exports.
*/
post: operations["cloudzero_dry_run_export_cloudzero_dry_run_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cloudzero/export": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cloudzero Export
* @description Perform an actual export using the CloudZero logger.
*
* This endpoint uses the CloudZero logger to export usage data to CloudZero AnyCost API.
*
* Parameters:
* - limit: Optional limit on number of records to export
* - operation: CloudZero operation type ("replace_hourly" or "sum", default: "replace_hourly")
*
* Only admin users can perform CloudZero exports.
*/
post: operations["cloudzero_export_cloudzero_export_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cloudzero/init": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Init Cloudzero Settings
* @description Initialize CloudZero settings and store in the database.
*
* This endpoint stores the CloudZero API key, connection ID, and timezone configuration
* in the proxy database for use by the CloudZero logger.
*
* Parameters:
* - api_key: CloudZero API key for authentication
* - connection_id: CloudZero connection ID for data submission
* - timezone: Timezone for date handling (default: UTC)
*
* Only admin users can configure CloudZero settings.
*/
post: operations["init_cloudzero_settings_cloudzero_init_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cloudzero/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Cloudzero Settings
* @description View current CloudZero settings.
*
* Returns the current CloudZero configuration with the API key masked for security.
* Only the first 4 and last 4 characters of the API key are shown.
* Returns null/empty values when settings are not configured (consistent with other settings endpoints).
*
* Only admin users (Proxy Admin or Admin Viewer) can view CloudZero settings.
*/
get: operations["get_cloudzero_settings_cloudzero_settings_get"];
/**
* Update Cloudzero Settings
* @description Update existing CloudZero settings.
*
* Allows updating individual CloudZero configuration fields without requiring all fields.
* Only provided fields will be updated; others will remain unchanged.
*
* Parameters:
* - api_key: (Optional) New CloudZero API key for authentication
* - connection_id: (Optional) New CloudZero connection ID for data submission
* - timezone: (Optional) New timezone for date handling
*
* Only admin users can update CloudZero settings.
*/
put: operations["update_cloudzero_settings_cloudzero_settings_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cohere/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Cohere Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/cohere)
*/
get: operations["cohere_proxy_route_cohere__endpoint__get"];
/**
* Cohere Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/cohere)
*/
put: operations["cohere_proxy_route_cohere__endpoint__put"];
/**
* Cohere Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/cohere)
*/
post: operations["cohere_proxy_route_cohere__endpoint__post"];
/**
* Cohere Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/cohere)
*/
delete: operations["cohere_proxy_route_cohere__endpoint__delete"];
options?: never;
head?: never;
/**
* Cohere Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/cohere)
*/
patch: operations["cohere_proxy_route_cohere__endpoint__patch"];
trace?: never;
};
"/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Completion
* @description Follows the exact same API spec as `OpenAI's Completions API https://platform.openai.com/docs/api-reference/completions`
*
* ```bash
* curl -X POST http://localhost:4000/v1/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-3.5-turbo-instruct",
* "prompt": "Once upon a time",
* "max_tokens": 50,
* "temperature": 0.7
* }'
* ```
*/
post: operations["completion_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/compliance/eu-ai-act": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Check Eu Ai Act Compliance
* @description Check EU AI Act compliance for a spend log entry.
*
* Checks:
* - Art. 9: Guardrails applied (any guardrail)
* - Art. 5: Content screened before LLM (pre-call guardrails)
* - Art. 12: Audit record complete (user_id, model, timestamp, guardrail_results)
*/
post: operations["check_eu_ai_act_compliance_compliance_eu_ai_act_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/compliance/gdpr": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Check Gdpr Compliance
* @description Check GDPR compliance for a spend log entry.
*
* Checks:
* - Art. 32: Data protection applied (pre-call guardrails)
* - Art. 5(1)(c): Sensitive data protected (masked/blocked or no issues)
* - Art. 30: Audit record complete (user_id, model, timestamp, guardrail_results)
*/
post: operations["check_gdpr_compliance_compliance_gdpr_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/callback/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Callback
* @description Delete specific logging callback from configuration.
*/
post: operations["delete_callback_config_callback_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/cost_discount_config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Cost Discount Config
* @description Get current cost discount configuration.
*
* Returns the cost_discount_config from litellm_settings.
*/
get: operations["get_cost_discount_config_config_cost_discount_config_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Cost Discount Config
* @description Update cost discount configuration.
*
* Updates the cost_discount_config in litellm_settings.
* Discounts should be between 0 and 1 (e.g., 0.05 = 5% discount).
*
* Example:
* ```json
* {
* "vertex_ai": 0.05,
* "gemini": 0.05,
* "openai": 0.01
* }
* ```
*/
patch: operations["update_cost_discount_config_config_cost_discount_config_patch"];
trace?: never;
};
"/config/cost_margin_config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Cost Margin Config
* @description Get current cost margin configuration.
*
* Returns the cost_margin_config from litellm_settings.
*/
get: operations["get_cost_margin_config_config_cost_margin_config_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Cost Margin Config
* @description Update cost margin configuration.
*
* Updates the cost_margin_config in litellm_settings.
* Margins can be:
* - Percentage: {"openai": 0.10} = 10% margin
* - Fixed amount: {"openai": {"fixed_amount": 0.001}} = $0.001 per request
* - Combined: {"vertex_ai": {"percentage": 0.08, "fixed_amount": 0.0005}}
* - Global: {"global": 0.05} = 5% global margin on all providers
*
* Example:
* ```json
* {
* "global": 0.05,
* "openai": 0.10,
* "anthropic": {"fixed_amount": 0.001},
* "vertex_ai": {"percentage": 0.08, "fixed_amount": 0.0005}
* }
* ```
*/
patch: operations["update_cost_margin_config_config_cost_margin_config_patch"];
trace?: never;
};
"/config/field/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Config General Settings
* @description Delete the db value of this field in litellm general settings. Resets it to it's initial default value on litellm.
*/
post: operations["delete_config_general_settings_config_field_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/field/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Config General Settings */
get: operations["get_config_general_settings_config_field_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/field/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Config General Settings
* @description Update a specific field in litellm general settings
*/
post: operations["update_config_general_settings_config_field_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Config List
* @description List the available fields + current values for a given type of setting (currently just 'general_settings'user_api_key_dict: UserAPIKeyAuth = Depends(user_api_key_auth),)
*/
get: operations["get_config_list_config_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/pass_through_endpoint": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Pass Through Endpoints
* @description GET configured pass through endpoint.
*
* If no endpoint_id given, return all configured endpoints.
*/
get: operations["get_pass_through_endpoints_config_pass_through_endpoint_get"];
put?: never;
/**
* Create Pass Through Endpoints
* @description Create new pass-through endpoint
*/
post: operations["create_pass_through_endpoints_config_pass_through_endpoint_post"];
/**
* Delete Pass Through Endpoints
* @description Delete a pass-through endpoint by ID.
*
* Returns - the deleted endpoint
*/
delete: operations["delete_pass_through_endpoints_config_pass_through_endpoint_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/pass_through_endpoint/team/{team_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Pass Through Endpoints
* @description GET configured pass through endpoint.
*
* If no endpoint_id given, return all configured endpoints.
*/
get: operations["get_pass_through_endpoints_config_pass_through_endpoint_team__team_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/pass_through_endpoint/{endpoint_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Pass Through Endpoints
* @description Update a pass-through endpoint by ID.
*/
post: operations["update_pass_through_endpoints_config_pass_through_endpoint__endpoint_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Config
* @description For Admin UI - allows admin to update config via UI.
*
* Writes only the sections present in the request body to LiteLLM_Config rows
* (one row per top-level section). Sections the caller did not send are left
* untouched — this endpoint never persists pre-existing YAML values to DB as
* a side effect of an unrelated update.
*/
post: operations["update_config_config_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config/yaml": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Config Yaml Endpoint
* @description This is a mock endpoint, to show what you can set in config.yaml details in the Swagger UI.
*
* Parameters:
*
* The config.yaml object has the following attributes:
* - **model_list**: *Optional[List[ModelParams]]* - A list of supported models on the server, along with model-specific configurations. ModelParams includes "model_name" (name of the model), "litellm_params" (litellm-specific parameters for the model), and "model_info" (additional info about the model such as id, mode, cost per token, etc).
*
* - **litellm_settings**: *Optional[dict]*: Settings for the litellm module. You can specify multiple properties like "drop_params", "set_verbose", "api_base", "cache".
*
* - **general_settings**: *Optional[ConfigGeneralSettings]*: General settings for the server like "completion_model" (default model for chat completion calls), "use_azure_key_vault" (option to load keys from azure key vault), "master_key" (key required for all calls to proxy), and others.
*
* Please, refer to each class's description for a better understanding of the specific attributes within them.
*
* Note: This is a mock endpoint primarily meant for demonstration purposes, and does not actually provide or change any configurations.
*/
get: operations["config_yaml_endpoint_config_yaml_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config_overrides/hashicorp_vault": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Hashicorp Vault Config
* @description Get current Hashicorp Vault configuration.
* Returns decrypted values from DB, or falls back to current env vars.
*/
get: operations["get_hashicorp_vault_config_config_overrides_hashicorp_vault_get"];
put?: never;
/**
* Update Hashicorp Vault Config
* @description Update Hashicorp Vault secret manager configuration.
* Sets environment variables, encrypts sensitive fields, and stores in DB.
* Reinitializes the secret manager on this pod.
*/
post: operations["update_hashicorp_vault_config_config_overrides_hashicorp_vault_post"];
/**
* Delete Hashicorp Vault Config
* @description Delete Hashicorp Vault configuration. Idempotent.
*/
delete: operations["delete_hashicorp_vault_config_config_overrides_hashicorp_vault_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config_overrides/hashicorp_vault/test_connection": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Hashicorp Vault Connection
* @description Test the connection to the currently configured Hashicorp Vault.
* Uses the already-initialized secret manager client. Does not modify any state.
*/
post: operations["test_hashicorp_vault_connection_config_overrides_hashicorp_vault_test_connection_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/containers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Containers
* @description Container list endpoint for retrieving a list of containers.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers?limit=20&order=desc" -H "Authorization: Bearer sk-1234"
* ```
*
* Or specify provider via header or query param:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers?custom_llm_provider=azure" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["list_containers_containers_get"];
put?: never;
/**
* Create Container
* @description Container creation endpoint for creating new containers.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "name": "My Container",
* "expires_after": {
* "anchor": "last_active_at",
* "minutes": 20
* }
* }'
* ```
*
* Or specify provider via header:
* ```bash
* curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure" -H "Content-Type: application/json" -d '{
* "name": "My Container"
* }'
* ```
*/
post: operations["create_container_containers_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/containers/{container_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Retrieve Container
* @description Container retrieve endpoint for getting details of a specific container.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"
* ```
*
* Or specify provider via header:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"
* ```
*/
get: operations["retrieve_container_containers__container_id__get"];
put?: never;
post?: never;
/**
* Delete Container
* @description Container delete endpoint for deleting a specific container.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"
* ```
*
* Or specify provider via header:
* ```bash
* curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"
* ```
*/
delete: operations["delete_container_containers__container_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/containers/{container_id}/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Handler Container Id */
get: operations["handler_container_id_containers__container_id__files_get"];
put?: never;
/** Handler Multipart Upload */
post: operations["handler_multipart_upload_containers__container_id__files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/containers/{container_id}/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Handler Container File */
get: operations["handler_container_file_containers__container_id__files__file_id__get"];
put?: never;
post?: never;
/** Handler Container File */
delete: operations["handler_container_file_containers__container_id__files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/containers/{container_id}/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Handler Binary Content */
get: operations["handler_binary_content_containers__container_id__files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cost/estimate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Estimate Cost
* @description Estimate cost for a given model and token counts.
*
* This endpoint uses the same cost calculation logic as actual requests,
* including any configured margins and discounts.
*
* Parameters:
* - model: Model name (e.g., "gpt-4", "claude-3-opus")
* - input_tokens: Expected input tokens per request
* - output_tokens: Expected output tokens per request
* - num_requests_per_day: Number of requests per day (optional)
* - num_requests_per_month: Number of requests per month (optional)
*
* Returns cost breakdown including:
* - Per-request costs (input, output, margin)
* - Daily costs (if num_requests_per_day provided)
* - Monthly costs (if num_requests_per_month provided)
*
* Example:
* ```json
* {
* "model": "gpt-4",
* "input_tokens": 1000,
* "output_tokens": 500,
* "num_requests_per_day": 100,
* "num_requests_per_month": 3000
* }
* ```
*/
post: operations["estimate_cost_cost_estimate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/credentials": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Credentials
* @description [BETA] endpoint. This might change unexpectedly.
*/
get: operations["get_credentials_credentials_get"];
put?: never;
/**
* Create Credential
* @description [BETA] endpoint. This might change unexpectedly.
* Stores credential in DB.
* Reloads credentials in memory.
*/
post: operations["create_credential_credentials_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/credentials/by_model/{model_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Credential By Model
* @description [BETA] endpoint. This might change unexpectedly.
*/
get: operations["get_credential_by_model_credentials_by_model__model_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/credentials/by_name/{credential_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Credential By Name
* @description [BETA] endpoint. This might change unexpectedly.
*/
get: operations["get_credential_by_name_credentials_by_name__credential_name__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/credentials/{credential_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Credential
* @description [BETA] endpoint. This might change unexpectedly.
*/
delete: operations["delete_credential_credentials__credential_name__delete"];
options?: never;
head?: never;
/**
* Update Credential
* @description [BETA] endpoint. This might change unexpectedly.
*/
patch: operations["update_credential_credentials__credential_name__patch"];
trace?: never;
};
"/cursor/chat/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cursor Chat Completions
* @description Cursor-specific endpoint that accepts Responses API input format but returns chat completions format.
*
* This endpoint handles requests from Cursor IDE which sends Responses API format (`input` field)
* but expects chat completions format response (`choices`, `messages`, etc.).
*
* ```bash
* curl -X POST http://localhost:4000/cursor/chat/completions -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": [{"role": "user", "content": "Hello"}]
* }'
* Responds back in chat completions format.
* ```
*/
post: operations["cursor_chat_completions_cursor_chat_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/cursor/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Cursor Proxy Route
* @description Pass-through endpoint for the Cursor Cloud Agents API.
*
* Supports all Cursor Cloud Agents endpoints:
* - GET /v0/agents — List agents
* - POST /v0/agents — Launch an agent
* - GET /v0/agents/{id} — Agent status
* - GET /v0/agents/{id}/conversation — Agent conversation
* - POST /v0/agents/{id}/followup — Add follow-up
* - POST /v0/agents/{id}/stop — Stop an agent
* - DELETE /v0/agents/{id} — Delete an agent
* - GET /v0/me — API key info
* - GET /v0/models — List models
* - GET /v0/repositories — List GitHub repositories
*
* Uses Basic Authentication (base64-encoded `API_KEY:`).
*
* Credential lookup order:
* 1. passthrough_endpoint_router (config.yaml deployments with use_in_pass_through)
* 2. litellm.credential_list (credentials added via UI)
* 3. CURSOR_API_KEY environment variable
*/
get: operations["cursor_proxy_route_cursor__endpoint__get"];
/**
* Cursor Proxy Route
* @description Pass-through endpoint for the Cursor Cloud Agents API.
*
* Supports all Cursor Cloud Agents endpoints:
* - GET /v0/agents — List agents
* - POST /v0/agents — Launch an agent
* - GET /v0/agents/{id} — Agent status
* - GET /v0/agents/{id}/conversation — Agent conversation
* - POST /v0/agents/{id}/followup — Add follow-up
* - POST /v0/agents/{id}/stop — Stop an agent
* - DELETE /v0/agents/{id} — Delete an agent
* - GET /v0/me — API key info
* - GET /v0/models — List models
* - GET /v0/repositories — List GitHub repositories
*
* Uses Basic Authentication (base64-encoded `API_KEY:`).
*
* Credential lookup order:
* 1. passthrough_endpoint_router (config.yaml deployments with use_in_pass_through)
* 2. litellm.credential_list (credentials added via UI)
* 3. CURSOR_API_KEY environment variable
*/
put: operations["cursor_proxy_route_cursor__endpoint__put"];
/**
* Cursor Proxy Route
* @description Pass-through endpoint for the Cursor Cloud Agents API.
*
* Supports all Cursor Cloud Agents endpoints:
* - GET /v0/agents — List agents
* - POST /v0/agents — Launch an agent
* - GET /v0/agents/{id} — Agent status
* - GET /v0/agents/{id}/conversation — Agent conversation
* - POST /v0/agents/{id}/followup — Add follow-up
* - POST /v0/agents/{id}/stop — Stop an agent
* - DELETE /v0/agents/{id} — Delete an agent
* - GET /v0/me — API key info
* - GET /v0/models — List models
* - GET /v0/repositories — List GitHub repositories
*
* Uses Basic Authentication (base64-encoded `API_KEY:`).
*
* Credential lookup order:
* 1. passthrough_endpoint_router (config.yaml deployments with use_in_pass_through)
* 2. litellm.credential_list (credentials added via UI)
* 3. CURSOR_API_KEY environment variable
*/
post: operations["cursor_proxy_route_cursor__endpoint__post"];
/**
* Cursor Proxy Route
* @description Pass-through endpoint for the Cursor Cloud Agents API.
*
* Supports all Cursor Cloud Agents endpoints:
* - GET /v0/agents — List agents
* - POST /v0/agents — Launch an agent
* - GET /v0/agents/{id} — Agent status
* - GET /v0/agents/{id}/conversation — Agent conversation
* - POST /v0/agents/{id}/followup — Add follow-up
* - POST /v0/agents/{id}/stop — Stop an agent
* - DELETE /v0/agents/{id} — Delete an agent
* - GET /v0/me — API key info
* - GET /v0/models — List models
* - GET /v0/repositories — List GitHub repositories
*
* Uses Basic Authentication (base64-encoded `API_KEY:`).
*
* Credential lookup order:
* 1. passthrough_endpoint_router (config.yaml deployments with use_in_pass_through)
* 2. litellm.credential_list (credentials added via UI)
* 3. CURSOR_API_KEY environment variable
*/
delete: operations["cursor_proxy_route_cursor__endpoint__delete"];
options?: never;
head?: never;
/**
* Cursor Proxy Route
* @description Pass-through endpoint for the Cursor Cloud Agents API.
*
* Supports all Cursor Cloud Agents endpoints:
* - GET /v0/agents — List agents
* - POST /v0/agents — Launch an agent
* - GET /v0/agents/{id} — Agent status
* - GET /v0/agents/{id}/conversation — Agent conversation
* - POST /v0/agents/{id}/followup — Add follow-up
* - POST /v0/agents/{id}/stop — Stop an agent
* - DELETE /v0/agents/{id} — Delete an agent
* - GET /v0/me — API key info
* - GET /v0/models — List models
* - GET /v0/repositories — List GitHub repositories
*
* Uses Basic Authentication (base64-encoded `API_KEY:`).
*
* Credential lookup order:
* 1. passthrough_endpoint_router (config.yaml deployments with use_in_pass_through)
* 2. litellm.credential_list (credentials added via UI)
* 3. CURSOR_API_KEY environment variable
*/
patch: operations["cursor_proxy_route_cursor__endpoint__patch"];
trace?: never;
};
"/customer/block": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Block User
* @description [BETA] Reject calls with this end-user id
*
* Parameters:
* - user_ids (List[str], required): The unique `user_id`s for the users to block
*
* (any /chat/completion call with this user={end-user-id} param, will be rejected.)
*
* ```
* curl -X POST "http://0.0.0.0:8000/user/block"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "user_ids": [<user_id>, ...]
* }'
* ```
*/
post: operations["block_user_customer_block_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Customer Daily Activity
* @description Get daily activity for specific organizations or all accessible organizations.
*/
get: operations["get_customer_daily_activity_customer_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete End User
* @description Delete multiple end-users.
*
* Parameters:
* - user_ids (List[str], required): The unique `user_id`s for the users to delete
*
* Example curl:
* ```
* curl --location 'http://0.0.0.0:4000/customer/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_ids" :["ishaan-jaff-5"]
* }'
*
* See below for all params
* ```
*/
post: operations["delete_end_user_customer_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* End User Info
* @description Get information about an end-user. An `end_user` is a customer (external user) of the proxy.
*
* Parameters:
* - end_user_id (str, required): The unique identifier for the end-user
*
* Example curl:
* ```
* curl -X GET 'http://localhost:4000/customer/info?end_user_id=test-litellm-user-4' -H 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["end_user_info_customer_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List End User
* @description [Admin-only] List all available customers
*
* Example curl:
* ```
* curl --location --request GET 'http://0.0.0.0:4000/customer/list' --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["list_end_user_customer_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New End User
* @description Allow creating a new Customer
*
*
* Parameters:
* - user_id: str - The unique identifier for the user.
* - alias: Optional[str] - A human-friendly alias for the user.
* - blocked: bool - Flag to allow or disallow requests for this end-user. Default is False.
* - max_budget: Optional[float] - The maximum budget allocated to the user. Either 'max_budget' or 'budget_id' should be provided, not both.
* - budget_id: Optional[str] - The identifier for an existing budget allocated to the user. Either 'max_budget' or 'budget_id' should be provided, not both.
* - allowed_model_region: Optional[Union[Literal["eu"], Literal["us"]]] - Require all user requests to use models in this specific region.
* - default_model: Optional[str] - If no equivalent model in the allowed region, default all requests to this model.
* - metadata: Optional[dict] = Metadata for customer, store information for customer. Example metadata = {"data_training_opt_out": True}
* - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
* - tpm_limit: Optional[int] - [Not Implemented Yet] Specify tpm limit for a given customer (Tokens per minute)
* - rpm_limit: Optional[int] - [Not Implemented Yet] Specify rpm limit for a given customer (Requests per minute)
* - model_max_budget: Optional[dict] - [Not Implemented Yet] Specify max budget for a given model. Example: {"openai/gpt-4o-mini": {"max_budget": 100.0, "budget_duration": "1d"}}
* - max_parallel_requests: Optional[int] - [Not Implemented Yet] Specify max parallel requests for a given customer.
* - soft_budget: Optional[float] - [Not Implemented Yet] Get alerts when customer crosses given budget, doesn't block requests.
* - spend: Optional[float] - Specify initial spend for a given customer.
* - budget_reset_at: Optional[str] - Specify the date and time when the budget should be reset.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - Customer-specific object permissions to control access to resources.
* Supported fields:
* * mcp_servers: List[str] - List of allowed MCP server IDs
* * mcp_access_groups: List[str] - List of MCP access group names
* * mcp_tool_permissions: Dict[str, List[str]] - Map of server ID to allowed tool names (e.g., {"server_1": ["tool_a", "tool_b"]})
* * vector_stores: List[str] - List of allowed vector store IDs
* * agents: List[str] - List of allowed agent IDs
* * agent_access_groups: List[str] - List of agent access group names
* Example: {"mcp_servers": ["server_1", "server_2"], "vector_stores": ["vector_store_1"], "agents": ["agent_1"]}
* IF null or {} then no object-level restrictions apply.
*
*
* - Allow specifying allowed regions
* - Allow specifying default model
*
* Example curl:
* ```
* curl --location 'http://0.0.0.0:4000/customer/new' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id" : "ishaan-jaff-3",
* "allowed_region": "eu",
* "budget_id": "free_tier",
* "default_model": "azure/gpt-3.5-turbo-eu"
* }'
*
* # With object permissions
* curl -L -X POST 'http://localhost:4000/customer/new' -H 'Authorization: Bearer sk-1234' -H 'Content-Type: application/json' -d '{
* "user_id": "user_1",
* "object_permission": {
* "mcp_servers": ["server_1"],
* "mcp_access_groups": ["public_group"],
* "vector_stores": ["vector_store_1"]
* }
* }'
*
* # return end-user object
* ```
*
* NOTE: This used to be called `/end_user/new`, we will still be maintaining compatibility for /end_user/XXX for these endpoints
*/
post: operations["new_end_user_customer_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/unblock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Unblock User
* @description [BETA] Unblock calls with this user id
*
* Example
* ```
* curl -X POST "http://0.0.0.0:8000/user/unblock"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "user_ids": [<user_id>, ...]
* }'
* ```
*/
post: operations["unblock_user_customer_unblock_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/customer/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update End User
* @description Example curl
*
* Parameters:
* - user_id: str
* - alias: Optional[str] = None # human-friendly alias
* - blocked: bool = False # allow/disallow requests for this end-user
* - max_budget: Optional[float] = None
* - budget_id: Optional[str] = None # give either a budget_id or max_budget
* - allowed_model_region: Optional[AllowedModelRegion] = (
* None # require all user requests to use models in this specific region
* )
* - default_model: Optional[str] = (
* None # if no equivalent model in allowed region - default all requests to this model
* )
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - Customer-specific object permissions to control access to resources.
* Supported fields:
* * mcp_servers: List[str] - List of allowed MCP server IDs
* * mcp_access_groups: List[str] - List of MCP access group names
* * mcp_tool_permissions: Dict[str, List[str]] - Map of server ID to allowed tool names
* * vector_stores: List[str] - List of allowed vector store IDs
* * agents: List[str] - List of allowed agent IDs
* * agent_access_groups: List[str] - List of agent access group names
* Example: {"mcp_servers": ["server_1"], "vector_stores": ["vector_store_1"]}
* IF null or {} then no object-level restrictions apply.
*
* Example curl:
* ```
* curl --location 'http://0.0.0.0:4000/customer/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id": "test-litellm-user-4",
* "budget_id": "paid_tier"
* }'
*
* # Updating object permissions
* curl -L -X POST 'http://localhost:4000/customer/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id": "user_1",
* "object_permission": {
* "mcp_servers": ["server_3"],
* "vector_stores": ["vector_store_2", "vector_store_3"]
* }
* }'
*
* See below for all params
* ```
*/
post: operations["update_end_user_customer_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/debug/asyncio-tasks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Active Tasks Stats
* @description Returns:
* total_active_tasks: int
* by_name: { coroutine_name: count }
*/
get: operations["get_active_tasks_stats_debug_asyncio_tasks_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/debug/memory/details": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Memory Details
* @description Get detailed memory diagnostics for deep debugging.
*
* Returns:
* - worker_pid: Process ID
* - process_memory: RAM usage, virtual memory, file handles, threads
* - garbage_collector: GC thresholds, counts, collection history
* - objects: Total tracked objects and top object types
* - uncollectable: Objects that can't be garbage collected (potential leaks)
* - cache_memory: Memory usage of user_api_key, router, and logging caches
* - router_memory: Memory usage of router components (model_list, deployment_names, etc.)
*
* Query Parameters:
* - top_n: Number of top object types to return (default: 20)
* - include_process_info: Include process-level memory info using psutil (default: true)
*
* Example usage:
* curl "http://localhost:4000/debug/memory/details?top_n=30" -H "Authorization: Bearer sk-1234"
*
* All memory sizes are reported in both bytes and MB.
*/
get: operations["get_memory_details_debug_memory_details_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/debug/memory/gc/configure": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Configure Gc Thresholds Endpoint
* @description Configure Python garbage collection thresholds.
*
* Lower thresholds mean more frequent GC cycles (less memory, more CPU overhead).
* Higher thresholds mean less frequent GC cycles (more memory, less CPU overhead).
*
* Returns:
* - message: Confirmation message
* - previous_thresholds: Old threshold values
* - new_thresholds: New threshold values
* - objects_awaiting_collection: Current object count in gen-0
* - tip: Hint about when next collection will occur
*
* Query Parameters:
* - generation_0: Number of allocations before gen-0 collection (default: 700)
* - generation_1: Number of gen-0 collections before gen-1 collection (default: 10)
* - generation_2: Number of gen-1 collections before gen-2 collection (default: 10)
*
* Example for more aggressive collection:
* curl -X POST "http://localhost:4000/debug/memory/gc/configure?generation_0=500" -H "Authorization: Bearer sk-1234"
*
* Example for less aggressive collection:
* curl -X POST "http://localhost:4000/debug/memory/gc/configure?generation_0=1000" -H "Authorization: Bearer sk-1234"
*
* Monitor memory usage with GET /debug/memory/summary after changes.
*/
post: operations["configure_gc_thresholds_endpoint_debug_memory_gc_configure_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/debug/memory/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Memory Summary
* @description Get simplified memory usage summary for the proxy.
*
* Returns:
* - worker_pid: Process ID
* - status: Overall health based on memory usage
* - memory: Process memory usage and RAM info
* - caches: Cache item counts and descriptions
* - garbage_collector: GC status and pending object counts
*
* Example usage:
* curl http://localhost:4000/debug/memory/summary -H "Authorization: Bearer sk-1234"
*
* For detailed analysis, call GET /debug/memory/details
* For cache management, use the cache management endpoints
*/
get: operations["get_memory_summary_debug_memory_summary_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/delete/allowed_ip": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Delete Allowed Ip */
post: operations["delete_allowed_ip_delete_allowed_ip_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/email/event_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Email Event Settings
* @description Get all email event settings
*/
get: operations["get_email_event_settings_email_event_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Event Settings
* @description Update the settings for email events
*/
patch: operations["update_event_settings_email_event_settings_patch"];
trace?: never;
};
"/email/event_settings/reset": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reset Event Settings
* @description Reset all email event settings to default (new user invitations on, virtual key creation off)
*/
post: operations["reset_event_settings_email_event_settings_reset_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/embeddings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Embeddings
* @description Follows the exact same API spec as `OpenAI's Embeddings API https://platform.openai.com/docs/api-reference/embeddings`
*
* ```bash
* curl -X POST http://localhost:4000/v1/embeddings
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "text-embedding-ada-002",
* "input": "The quick brown fox jumps over the lazy dog"
* }'
* ```
*/
post: operations["embeddings_embeddings_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/block": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Block User
* @description [BETA] Reject calls with this end-user id
*
* Parameters:
* - user_ids (List[str], required): The unique `user_id`s for the users to block
*
* (any /chat/completion call with this user={end-user-id} param, will be rejected.)
*
* ```
* curl -X POST "http://0.0.0.0:8000/user/block"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "user_ids": [<user_id>, ...]
* }'
* ```
*/
post: operations["block_user_end_user_block_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Customer Daily Activity
* @description Get daily activity for specific organizations or all accessible organizations.
*/
get: operations["get_customer_daily_activity_end_user_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete End User
* @description Delete multiple end-users.
*
* Parameters:
* - user_ids (List[str], required): The unique `user_id`s for the users to delete
*
* Example curl:
* ```
* curl --location 'http://0.0.0.0:4000/customer/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_ids" :["ishaan-jaff-5"]
* }'
*
* See below for all params
* ```
*/
post: operations["delete_end_user_end_user_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* End User Info
* @description Get information about an end-user. An `end_user` is a customer (external user) of the proxy.
*
* Parameters:
* - end_user_id (str, required): The unique identifier for the end-user
*
* Example curl:
* ```
* curl -X GET 'http://localhost:4000/customer/info?end_user_id=test-litellm-user-4' -H 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["end_user_info_end_user_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List End User
* @description [Admin-only] List all available customers
*
* Example curl:
* ```
* curl --location --request GET 'http://0.0.0.0:4000/customer/list' --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["list_end_user_end_user_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New End User
* @description Allow creating a new Customer
*
*
* Parameters:
* - user_id: str - The unique identifier for the user.
* - alias: Optional[str] - A human-friendly alias for the user.
* - blocked: bool - Flag to allow or disallow requests for this end-user. Default is False.
* - max_budget: Optional[float] - The maximum budget allocated to the user. Either 'max_budget' or 'budget_id' should be provided, not both.
* - budget_id: Optional[str] - The identifier for an existing budget allocated to the user. Either 'max_budget' or 'budget_id' should be provided, not both.
* - allowed_model_region: Optional[Union[Literal["eu"], Literal["us"]]] - Require all user requests to use models in this specific region.
* - default_model: Optional[str] - If no equivalent model in the allowed region, default all requests to this model.
* - metadata: Optional[dict] = Metadata for customer, store information for customer. Example metadata = {"data_training_opt_out": True}
* - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
* - tpm_limit: Optional[int] - [Not Implemented Yet] Specify tpm limit for a given customer (Tokens per minute)
* - rpm_limit: Optional[int] - [Not Implemented Yet] Specify rpm limit for a given customer (Requests per minute)
* - model_max_budget: Optional[dict] - [Not Implemented Yet] Specify max budget for a given model. Example: {"openai/gpt-4o-mini": {"max_budget": 100.0, "budget_duration": "1d"}}
* - max_parallel_requests: Optional[int] - [Not Implemented Yet] Specify max parallel requests for a given customer.
* - soft_budget: Optional[float] - [Not Implemented Yet] Get alerts when customer crosses given budget, doesn't block requests.
* - spend: Optional[float] - Specify initial spend for a given customer.
* - budget_reset_at: Optional[str] - Specify the date and time when the budget should be reset.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - Customer-specific object permissions to control access to resources.
* Supported fields:
* * mcp_servers: List[str] - List of allowed MCP server IDs
* * mcp_access_groups: List[str] - List of MCP access group names
* * mcp_tool_permissions: Dict[str, List[str]] - Map of server ID to allowed tool names (e.g., {"server_1": ["tool_a", "tool_b"]})
* * vector_stores: List[str] - List of allowed vector store IDs
* * agents: List[str] - List of allowed agent IDs
* * agent_access_groups: List[str] - List of agent access group names
* Example: {"mcp_servers": ["server_1", "server_2"], "vector_stores": ["vector_store_1"], "agents": ["agent_1"]}
* IF null or {} then no object-level restrictions apply.
*
*
* - Allow specifying allowed regions
* - Allow specifying default model
*
* Example curl:
* ```
* curl --location 'http://0.0.0.0:4000/customer/new' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id" : "ishaan-jaff-3",
* "allowed_region": "eu",
* "budget_id": "free_tier",
* "default_model": "azure/gpt-3.5-turbo-eu"
* }'
*
* # With object permissions
* curl -L -X POST 'http://localhost:4000/customer/new' -H 'Authorization: Bearer sk-1234' -H 'Content-Type: application/json' -d '{
* "user_id": "user_1",
* "object_permission": {
* "mcp_servers": ["server_1"],
* "mcp_access_groups": ["public_group"],
* "vector_stores": ["vector_store_1"]
* }
* }'
*
* # return end-user object
* ```
*
* NOTE: This used to be called `/end_user/new`, we will still be maintaining compatibility for /end_user/XXX for these endpoints
*/
post: operations["new_end_user_end_user_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/unblock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Unblock User
* @description [BETA] Unblock calls with this user id
*
* Example
* ```
* curl -X POST "http://0.0.0.0:8000/user/unblock"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "user_ids": [<user_id>, ...]
* }'
* ```
*/
post: operations["unblock_user_end_user_unblock_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/end_user/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update End User
* @description Example curl
*
* Parameters:
* - user_id: str
* - alias: Optional[str] = None # human-friendly alias
* - blocked: bool = False # allow/disallow requests for this end-user
* - max_budget: Optional[float] = None
* - budget_id: Optional[str] = None # give either a budget_id or max_budget
* - allowed_model_region: Optional[AllowedModelRegion] = (
* None # require all user requests to use models in this specific region
* )
* - default_model: Optional[str] = (
* None # if no equivalent model in allowed region - default all requests to this model
* )
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - Customer-specific object permissions to control access to resources.
* Supported fields:
* * mcp_servers: List[str] - List of allowed MCP server IDs
* * mcp_access_groups: List[str] - List of MCP access group names
* * mcp_tool_permissions: Dict[str, List[str]] - Map of server ID to allowed tool names
* * vector_stores: List[str] - List of allowed vector store IDs
* * agents: List[str] - List of allowed agent IDs
* * agent_access_groups: List[str] - List of agent access group names
* Example: {"mcp_servers": ["server_1"], "vector_stores": ["vector_store_1"]}
* IF null or {} then no object-level restrictions apply.
*
* Example curl:
* ```
* curl --location 'http://0.0.0.0:4000/customer/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id": "test-litellm-user-4",
* "budget_id": "paid_tier"
* }'
*
* # Updating object permissions
* curl -L -X POST 'http://localhost:4000/customer/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id": "user_1",
* "object_permission": {
* "mcp_servers": ["server_3"],
* "vector_stores": ["vector_store_2", "vector_store_3"]
* }
* }'
*
* See below for all params
* ```
*/
post: operations["update_end_user_end_user_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/engines/{model}/chat/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Chat Completion
* @description Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`
*
* ```bash
* curl -X POST http://localhost:4000/v1/chat/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-4o",
* "messages": [
* {
* "role": "user",
* "content": "Hello!"
* }
* ]
* }'
* ```
*/
post: operations["chat_completion_engines__model__chat_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/engines/{model}/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Completion
* @description Follows the exact same API spec as `OpenAI's Completions API https://platform.openai.com/docs/api-reference/completions`
*
* ```bash
* curl -X POST http://localhost:4000/v1/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-3.5-turbo-instruct",
* "prompt": "Once upon a time",
* "max_tokens": 50,
* "temperature": 0.7
* }'
* ```
*/
post: operations["completion_engines__model__completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/engines/{model}/embeddings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Embeddings
* @description Follows the exact same API spec as `OpenAI's Embeddings API https://platform.openai.com/docs/api-reference/embeddings`
*
* ```bash
* curl -X POST http://localhost:4000/v1/embeddings
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "text-embedding-ada-002",
* "input": "The quick brown fox jumps over the lazy dog"
* }'
* ```
*/
post: operations["embeddings_engines__model__embeddings_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/eu.assemblyai/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Assemblyai Proxy Route */
get: operations["assemblyai_proxy_route_eu_assemblyai__endpoint__get"];
/** Assemblyai Proxy Route */
put: operations["assemblyai_proxy_route_eu_assemblyai__endpoint__put"];
/** Assemblyai Proxy Route */
post: operations["assemblyai_proxy_route_eu_assemblyai__endpoint__post"];
/** Assemblyai Proxy Route */
delete: operations["assemblyai_proxy_route_eu_assemblyai__endpoint__delete"];
options?: never;
head?: never;
/** Assemblyai Proxy Route */
patch: operations["assemblyai_proxy_route_eu_assemblyai__endpoint__patch"];
trace?: never;
};
"/fallback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Fallback
* @description Create or update fallbacks for a specific model.
*
* This endpoint allows you to configure fallback models separately from the general config.
* Fallbacks are triggered when a model call fails after retries.
*
* **Example Request:**
* ```json
* {
* "model": "gpt-3.5-turbo",
* "fallback_models": ["gpt-4", "claude-3-haiku"],
* "fallback_type": "general"
* }
* ```
*
* **Fallback Types:**
* - `general`: Standard fallbacks for any error (default)
* - `context_window`: Fallbacks specifically for context window exceeded errors
* - `content_policy`: Fallbacks specifically for content policy violations
*/
post: operations["create_fallback_fallback_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/fallback/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fallback Login
* @description Create Proxy API Keys using Google Workspace SSO. Requires setting PROXY_BASE_URL in .env
* PROXY_BASE_URL should be the your deployed proxy endpoint, e.g. PROXY_BASE_URL="https://litellm-production-7002.up.railway.app/"
* Example:
*/
get: operations["fallback_login_fallback_login_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/fallback/{model}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Fallback
* @description Get fallback configuration for a specific model.
*
* **Parameters:**
* - `model`: The model name to get fallbacks for
* - `fallback_type`: Type of fallback to retrieve (query parameter)
*
* **Example:**
* ```
* GET /fallback/gpt-3.5-turbo?fallback_type=general
* ```
*/
get: operations["get_fallback_fallback__model__get"];
put?: never;
post?: never;
/**
* Delete Fallback
* @description Delete fallback configuration for a specific model.
*
* **Parameters:**
* - `model`: The model name to delete fallbacks for
* - `fallback_type`: Type of fallback to delete (query parameter)
*
* **Example:**
* ```
* DELETE /fallback/gpt-3.5-turbo?fallback_type=general
* ```
*/
delete: operations["delete_fallback_fallback__model__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Files
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/list
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["list_files_files_get"];
put?: never;
/**
* Create File
* @description Upload a file that can be used across - Assistants API, Batch API
* This is the equivalent of POST https://api.openai.com/v1/files
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/create
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234" -F purpose="batch" -F file="@mydata.jsonl"
* -F expires_after[anchor]="created_at" -F expires_after[seconds]=2592000
* ```
*/
post: operations["create_file_files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get File
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/{file_id}
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123 -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["get_file_files__file_id__get"];
put?: never;
post?: never;
/**
* Delete File
* @description Deletes a specified file. that can be used across - Assistants API, Batch API
* This is the equivalent of DELETE https://api.openai.com/v1/files/{file_id}
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/delete
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123 -X DELETE -H "Authorization: Bearer $OPENAI_API_KEY"
*
* ```
*/
delete: operations["delete_file_files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get File Content
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/{file_id}/content
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve-contents
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123/content -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["get_file_content_files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/fine_tuning/jobs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* ✨ (Enterprise) List Fine-Tuning Jobs
* @description Lists fine-tuning jobs for the organization.
* This is the equivalent of GET https://api.openai.com/v1/fine_tuning/jobs
*
* Supported Query Params:
* - `custom_llm_provider`: Name of the LiteLLM provider
* - `after`: Identifier for the last job from the previous pagination request.
* - `limit`: Number of fine-tuning jobs to retrieve (default is 20).
*/
get: operations["list_fine_tuning_jobs_fine_tuning_jobs_get"];
put?: never;
/**
* ✨ (Enterprise) Create Fine-Tuning Job
* @description Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
* This is the equivalent of POST https://api.openai.com/v1/fine_tuning/jobs
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/fine-tuning/create
*
* Example Curl:
* ```
* curl http://localhost:4000/v1/fine_tuning/jobs -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-3.5-turbo",
* "training_file": "file-abc123",
* "hyperparameters": {
* "n_epochs": 4
* }
* }'
* ```
*/
post: operations["create_fine_tuning_job_fine_tuning_jobs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/fine_tuning/jobs/{fine_tuning_job_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* ✨ (Enterprise) Retrieve Fine-Tuning Job
* @description Retrieves a fine-tuning job.
* This is the equivalent of GET https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}
*
* Supported Query Params:
* - `custom_llm_provider`: Name of the LiteLLM provider
* - `fine_tuning_job_id`: The ID of the fine-tuning job to retrieve.
*/
get: operations["retrieve_fine_tuning_job_fine_tuning_jobs__fine_tuning_job_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/fine_tuning/jobs/{fine_tuning_job_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* ✨ (Enterprise) Cancel Fine-Tuning Jobs
* @description Cancel a fine-tuning job.
*
* This is the equivalent of POST https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel
*
* Supported Query Params:
* - `custom_llm_provider`: Name of the LiteLLM provider
* - `fine_tuning_job_id`: The ID of the fine-tuning job to cancel.
*/
post: operations["cancel_fine_tuning_job_fine_tuning_jobs__fine_tuning_job_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/gemini/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Gemini Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/google_ai_studio)
*/
get: operations["gemini_proxy_route_gemini__endpoint__get"];
/**
* Gemini Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/google_ai_studio)
*/
put: operations["gemini_proxy_route_gemini__endpoint__put"];
/**
* Gemini Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/google_ai_studio)
*/
post: operations["gemini_proxy_route_gemini__endpoint__post"];
/**
* Gemini Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/google_ai_studio)
*/
delete: operations["gemini_proxy_route_gemini__endpoint__delete"];
options?: never;
head?: never;
/**
* Gemini Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/google_ai_studio)
*/
patch: operations["gemini_proxy_route_gemini__endpoint__patch"];
trace?: never;
};
"/get/allowed_ips": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Allowed Ips */
get: operations["get_allowed_ips_get_allowed_ips_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/config/callbacks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Config
* @description For Admin UI - allows admin to view config via UI
* # return the callbacks and the env variables for the callback
*/
get: operations["get_config_get_config_callbacks_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/default_team_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Default Team Settings
* @description Get all SSO settings from the litellm_settings configuration.
* Returns a structured object with values and descriptions for UI display.
*/
get: operations["get_default_team_settings_get_default_team_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/internal_user_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Internal User Settings
* @description Get all SSO settings from the litellm_settings configuration.
* Returns a structured object with values and descriptions for UI display.
*/
get: operations["get_internal_user_settings_get_internal_user_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/mcp_semantic_filter_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Semantic Filter Settings
* @description Get MCP semantic filter configuration.
* Returns current settings for semantic tool filtering.
*/
get: operations["get_mcp_semantic_filter_settings_get_mcp_semantic_filter_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/sso_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Sso Settings
* @description Get all SSO configuration settings from the dedicated SSO table.
* Returns a structured object with values and descriptions for UI display.
*/
get: operations["get_sso_settings_get_sso_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/ui_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Ui Settings
* @description Get UI-specific configuration flags.
* All authenticated users can fetch these settings for client-side behavior.
*/
get: operations["get_ui_settings_get_ui_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get/ui_theme_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Ui Theme Settings
* @description Get UI theme configuration from the litellm_settings.
* Returns current logo settings for UI customization.
*
* Note: This endpoint is public (no authentication required) so all users can see custom branding.
* Only the /update/ui_theme_settings endpoint requires authentication for admins to change settings.
*/
get: operations["get_ui_theme_settings_get_ui_theme_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get_favicon": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Favicon
* @description Get custom favicon for the admin UI.
*/
get: operations["get_favicon_get_favicon_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get_image": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Image
* @description Get logo to show on admin UI
*/
get: operations["get_image_get_image_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/get_logo_url": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Logo Url
* @description Get the current logo URL from environment.
*
* Only HTTP(S) URLs are returned — those are intended to be loaded
* directly by the browser from a public/internal CDN. Local file
* paths set via ``UI_LOGO_PATH`` are NOT returned: they are admin-
* only filesystem details, the dashboard falls back to ``/get_image``
* which serves the file only when it is a supported image. Without
* this filter, the unauthenticated endpoint would disclose internal
* hostnames or filesystem paths to any caller.
*/
get: operations["get_logo_url_get_logo_url_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Activity
* @description Get number of API Requests, total tokens through proxy
*
* {
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* api_requests: 10,
* total_tokens: 2000
* },
* {
* date: 'Jan 23',
* api_requests: 10,
* total_tokens: 12
* },
* ],
* "sum_api_requests": 20,
* "sum_total_tokens": 2012
* }
*/
get: operations["get_global_activity_global_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/activity/cache_hits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Activity
* @description Get number of cache hits, vs misses
*
* {
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* cache_hits: 10,
* llm_api_calls: 2000
* },
* {
* date: 'Jan 23',
* cache_hits: 10,
* llm_api_calls: 12
* },
* ],
* "sum_cache_hits": 20,
* "sum_llm_api_calls": 2012
* }
*/
get: operations["get_global_activity_global_activity_cache_hits_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/activity/exceptions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Activity Exceptions
* @description Get number of API Requests, total tokens through proxy
*
* {
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* num_rate_limit_exceptions: 10,
* },
* {
* date: 'Jan 23',
* num_rate_limit_exceptions: 10,
* },
* ],
* "sum_api_exceptions": 20,
* }
*/
get: operations["get_global_activity_exceptions_global_activity_exceptions_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/activity/exceptions/deployment": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Activity Exceptions Per Deployment
* @description Get number of 429 errors - Grouped by deployment
*
* [
* {
* "deployment": "https://azure-us-east-1.openai.azure.com/",
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* num_rate_limit_exceptions: 10
* },
* {
* date: 'Jan 23',
* num_rate_limit_exceptions: 12
* },
* ],
* "sum_num_rate_limit_exceptions": 20,
*
* },
* {
* "deployment": "https://azure-us-east-1.openai.azure.com/",
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* num_rate_limit_exceptions: 10,
* },
* {
* date: 'Jan 23',
* num_rate_limit_exceptions: 12
* },
* ],
* "sum_num_rate_limit_exceptions": 20,
*
* },
* ]
*/
get: operations["get_global_activity_exceptions_per_deployment_global_activity_exceptions_deployment_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/activity/model": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Activity Model
* @description Get number of API Requests, total tokens through proxy - Grouped by MODEL
*
* [
* {
* "model": "gpt-4",
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* api_requests: 10,
* total_tokens: 2000
* },
* {
* date: 'Jan 23',
* api_requests: 10,
* total_tokens: 12
* },
* ],
* "sum_api_requests": 20,
* "sum_total_tokens": 2012
*
* },
* {
* "model": "azure/gpt-4-turbo",
* "daily_data": [
* const chartdata = [
* {
* date: 'Jan 22',
* api_requests: 10,
* total_tokens: 2000
* },
* {
* date: 'Jan 23',
* api_requests: 10,
* total_tokens: 12
* },
* ],
* "sum_api_requests": 20,
* "sum_total_tokens": 2012
*
* },
* ]
*/
get: operations["get_global_activity_model_global_activity_model_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/all_end_users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global View All End Users
* @description [BETA] This is a beta endpoint. It will change.
*
* Use this to just get all the unique `end_users`
*/
get: operations["global_view_all_end_users_global_all_end_users_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global Spend
* @description [BETA] This is a beta endpoint. It will change.
*
* View total spend across all proxy keys
*/
get: operations["global_spend_global_spend_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/all_tag_names": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Global Get All Tag Names */
get: operations["global_get_all_tag_names_global_spend_all_tag_names_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/end_users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Global Spend End Users
* @description [BETA] This is a beta endpoint. It will change.
*
* Use this to get the top 'n' keys with the highest spend, ordered by spend.
*/
post: operations["global_spend_end_users_global_spend_end_users_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/keys": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global Spend Keys
* @description [BETA] This is a beta endpoint. It will change.
*
* Use this to get the top 'n' keys with the highest spend, ordered by spend.
*/
get: operations["global_spend_keys_global_spend_keys_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global Spend Logs
* @description [BETA] This is a beta endpoint. It will change.
*
* Use this to get global spend (spend per day for last 30d). Admin-only endpoint
*
* More efficient implementation of /spend/logs, by creating a view over the spend logs table.
*/
get: operations["global_spend_logs_global_spend_logs_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/models": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global Spend Models
* @description [BETA] This is a beta endpoint. It will change.
*
* Use this to get the top 'n' models with the highest spend, ordered by spend.
*/
get: operations["global_spend_models_global_spend_models_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/provider": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Spend Provider
* @description Get breakdown of spend per provider
* [
* {
* "provider": "Azure OpenAI",
* "spend": 20
* },
* {
* "provider": "OpenAI",
* "spend": 10
* },
* {
* "provider": "VertexAI",
* "spend": 30
* }
* ]
*/
get: operations["get_global_spend_provider_global_spend_provider_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/refresh": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Global Spend Refresh
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Globally refresh spend MonthlyGlobalSpend view
*/
post: operations["global_spend_refresh_global_spend_refresh_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/report": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Global Spend Report
* @description Get Daily Spend per Team, based on specific startTime and endTime. Per team, view usage by each key, model
* [
* {
* "group-by-day": "2024-05-10",
* "teams": [
* {
* "team_name": "team-1"
* "spend": 10,
* "keys": [
* "key": "1213",
* "usage": {
* "model-1": {
* "cost": 12.50,
* "input_tokens": 1000,
* "output_tokens": 5000,
* "requests": 100
* },
* "audio-modelname1": {
* "cost": 25.50,
* "seconds": 25,
* "requests": 50
* },
* }
* }
* ]
* ]
* }
*/
get: operations["get_global_spend_report_global_spend_report_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/reset": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Global Spend Reset
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Globally reset spend for All API Keys and Teams, maintain LiteLLM_SpendLogs
*
* 1. LiteLLM_SpendLogs will maintain the logs on spend, no data gets deleted from there
* 2. LiteLLM_VerificationTokens spend will be set = 0
* 3. LiteLLM_TeamTable spend will be set = 0
*/
post: operations["global_spend_reset_global_spend_reset_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global View Spend Tags
* @description LiteLLM Enterprise - View Spend Per Request Tag. Used by LiteLLM UI
*
* Example Request:
* ```
* curl -X GET "http://0.0.0.0:4000/spend/tags" -H "Authorization: Bearer sk-1234"
* ```
*
* Spend with Start Date and End Date
* ```
* curl -X GET "http://0.0.0.0:4000/spend/tags?start_date=2022-01-01&end_date=2022-02-01" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["global_view_spend_tags_global_spend_tags_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/global/spend/teams": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Global Spend Per Team
* @description [BETA] This is a beta endpoint. It will change.
*
* Use this to get daily spend, grouped by `team_id` and `date`
*/
get: operations["global_spend_per_team_global_spend_teams_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Guardrail
* @description Create a new guardrail
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/guardrails" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "guardrail": {
* "guardrail_name": "my-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "DRAFT",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Bedrock content moderation guardrail"
* }
* }
* }'
* ```
*
* Example Response:
* ```json
* {
* "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
* "guardrail_name": "my-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "DRAFT",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Bedrock content moderation guardrail"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* }
* ```
*/
post: operations["create_guardrail_guardrails_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/apply_guardrail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Apply Guardrail
* @description Apply a guardrail to text input and return the processed result.
*
* This endpoint allows testing guardrails by applying them to custom text inputs.
*/
post: operations["apply_guardrail_guardrails_apply_guardrail_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Guardrails
* @description List the guardrails that are available on the proxy server
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/guardrails/list" -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "guardrails": [
* {
* "guardrail_name": "bedrock-pre-guard",
* "guardrail_info": {
* "params": [
* {
* "name": "toxicity_score",
* "type": "float",
* "description": "Score between 0-1 indicating content toxicity level"
* },
* {
* "name": "pii_detection",
* "type": "boolean"
* }
* ]
* }
* }
* ]
* }
* ```
*/
get: operations["list_guardrails_guardrails_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/register": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Register Guardrail
* @description Register a guardrail for onboarding (team submission).
*
* Accepts a guardrail config in the
* [Generic Guardrail API](https://docs.litellm.ai/docs/adding_provider/generic_guardrail_api) format.
* The submission is stored with status `pending_review` until an admin approves it.
*/
post: operations["register_guardrail_guardrails_register_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/submissions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Guardrail Submissions
* @description List team guardrail submissions. Returns only guardrails with a team_id.
*
* Admins see all submissions. Non-admin users see submissions for teams they are
* a member of.
*
* Status values: pending_review (team-registered, awaiting approval), active (approved), rejected.
*
* Optional filters:
* - status: pending_review | active | rejected
* - team_id: filter by specific team (non-admins must be a member of that team)
* - search: name/description
*/
get: operations["list_guardrail_submissions_guardrails_submissions_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/submissions/{guardrail_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Guardrail Submission
* @description Get a single guardrail submission by id. Non-admins may only access submissions for teams they belong to.
*/
get: operations["get_guardrail_submission_guardrails_submissions__guardrail_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/submissions/{guardrail_id}/approve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Approve Guardrail Submission
* @description Approve a pending guardrail submission: set status to active and initialize in memory (admin only).
*/
post: operations["approve_guardrail_submission_guardrails_submissions__guardrail_id__approve_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/submissions/{guardrail_id}/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reject Guardrail Submission
* @description Reject a guardrail submission (admin only).
*/
post: operations["reject_guardrail_submission_guardrails_submissions__guardrail_id__reject_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/test_custom_code": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Custom Code Guardrail
* @description Test custom code guardrail logic without creating a guardrail.
*
* This endpoint allows admins to experiment with custom code guardrails by:
* 1. Compiling the provided code in a sandbox
* 2. Executing the apply_guardrail function with test input
* 3. Returning the result (allow/block/modify)
*
* 👉 [Custom Code Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/custom_code_guardrail)
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/guardrails/test_custom_code" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "custom_code": "def apply_guardrail(inputs, request_data, input_type):\n for text in inputs[\"texts\"]:\n if regex_match(text, r\"\\d{3}-\\d{2}-\\d{4}\"):\n return block(\"SSN detected\")\n return allow()",
* "test_input": {
* "texts": ["My SSN is 123-45-6789"]
* },
* "input_type": "request"
* }'
* ```
*
* Example Success Response (blocked):
* ```json
* {
* "success": true,
* "result": {
* "action": "block",
* "reason": "SSN detected"
* },
* "error": null,
* "error_type": null
* }
* ```
*
* Example Success Response (allowed):
* ```json
* {
* "success": true,
* "result": {
* "action": "allow"
* },
* "error": null,
* "error_type": null
* }
* ```
*
* Example Success Response (modified):
* ```json
* {
* "success": true,
* "result": {
* "action": "modify",
* "texts": ["My SSN is [REDACTED]"]
* },
* "error": null,
* "error_type": null
* }
* ```
*
* Example Error Response (compilation error):
* ```json
* {
* "success": false,
* "result": null,
* "error": "Syntax error in custom code: invalid syntax (<guardrail>, line 1)",
* "error_type": "compilation"
* }
* ```
*/
post: operations["test_custom_code_guardrail_guardrails_test_custom_code_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/ui/add_guardrail_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Guardrail Ui Settings
* @description Get the UI settings for the guardrails
*
* Returns:
* - Supported entities for guardrails
* - Supported modes for guardrails
* - PII entity categories for UI organization
* - Content filter settings (patterns and categories)
*/
get: operations["get_guardrail_ui_settings_guardrails_ui_add_guardrail_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/ui/category_yaml/{category_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Category Yaml
* @description Get the YAML or JSON content for a specific content filter category.
*
* Args:
* category_name: The name of the category (e.g., "bias_gender", "harmful_self_harm")
*
* Returns:
* The raw YAML or JSON content of the category file with file type indicator
*/
get: operations["get_category_yaml_guardrails_ui_category_yaml__category_name__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/ui/major_airlines": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Major Airlines
* @description Get the major airlines list from IATA (competitor intent, airline type).
* Returns airline id, match variants (pipe-separated), and tags.
*/
get: operations["get_major_airlines_guardrails_ui_major_airlines_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/ui/provider_specific_params": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Provider Specific Params
* @description Get provider-specific parameters for different guardrail types.
*
* Returns a dictionary mapping guardrail providers to their specific parameters,
* including parameter names, descriptions, and whether they are required.
*
* Example Response:
* ```json
* {
* "bedrock": {
* "guardrailIdentifier": {
* "description": "The ID of your guardrail on Bedrock",
* "required": true,
* "type": null
* },
* "guardrailVersion": {
* "description": "The version of your Bedrock guardrail (e.g., DRAFT or version number)",
* "required": true,
* "type": null
* }
* },
* "azure_content_safety_text_moderation": {
* "api_key": {
* "description": "API key for the Azure Content Safety Text Moderation guardrail",
* "required": false,
* "type": null
* },
* "optional_params": {
* "description": "Optional parameters for the Azure Content Safety Text Moderation guardrail",
* "required": true,
* "type": "nested",
* "fields": {
* "severity_threshold": {
* "description": "Severity threshold for the Azure Content Safety Text Moderation guardrail across all categories",
* "required": false,
* "type": null
* },
* "categories": {
* "description": "Categories to scan for the Azure Content Safety Text Moderation guardrail",
* "required": false,
* "type": "multiselect",
* "options": ["Hate", "SelfHarm", "Sexual", "Violence"],
* "default_value": None
* }
* }
* }
* }
* }
* ```
*/
get: operations["get_provider_specific_params_guardrails_ui_provider_specific_params_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/usage/detail/{guardrail_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Guardrails Usage Detail
* @description Return single guardrail usage metrics and time series.
*/
get: operations["guardrails_usage_detail_guardrails_usage_detail__guardrail_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/usage/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Guardrails Usage Logs
* @description Return paginated run logs for a guardrail (or policy) from SpendLogs via index.
*/
get: operations["guardrails_usage_logs_guardrails_usage_logs_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/usage/overview": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Guardrails Usage Overview
* @description Return guardrail performance overview for the dashboard.
*/
get: operations["guardrails_usage_overview_guardrails_usage_overview_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/validate_blocked_words_file": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Validate Blocked Words File
* @description Validate a blocked_words YAML file content.
*
* Args:
* request: Dictionary with 'file_content' key containing the YAML string
*
* Returns:
* Dictionary with 'valid' boolean and either 'message'/'errors' depending on result
*
* Example Request:
* ```json
* {
* "file_content": "blocked_words:\n - keyword: \"test\"\n action: \"BLOCK\""
* }
* ```
*
* Example Success Response:
* ```json
* {
* "valid": true,
* "message": "Valid YAML file with 2 blocked words"
* }
* ```
*
* Example Error Response:
* ```json
* {
* "valid": false,
* "errors": ["Entry 0: missing 'action' field"]
* }
* ```
*/
post: operations["validate_blocked_words_file_guardrails_validate_blocked_words_file_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/guardrails/{guardrail_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Guardrail Info
* @description Get detailed information about a specific guardrail by ID
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000/info" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
* "guardrail_name": "my-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "DRAFT",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Bedrock content moderation guardrail"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* }
* ```
*/
get: operations["get_guardrail_info_guardrails__guardrail_id__get"];
/**
* Update Guardrail
* @description Update an existing guardrail
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X PUT "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "guardrail": {
* "guardrail_name": "updated-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "1.0",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Updated Bedrock content moderation guardrail"
* }
* }
* }'
* ```
*
* Example Response:
* ```json
* {
* "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
* "guardrail_name": "updated-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "1.0",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Updated Bedrock content moderation guardrail"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T13:45:12.345Z"
* }
* ```
*/
put: operations["update_guardrail_guardrails__guardrail_id__put"];
post?: never;
/**
* Delete Guardrail
* @description Delete a guardrail
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X DELETE "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "message": "Guardrail 123e4567-e89b-12d3-a456-426614174000 deleted successfully"
* }
* ```
*/
delete: operations["delete_guardrail_guardrails__guardrail_id__delete"];
options?: never;
head?: never;
/**
* Patch Guardrail
* @description Partially update an existing guardrail
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* This endpoint allows updating specific fields of a guardrail without sending the entire object.
* Only the following fields can be updated:
* - guardrail_name: The name of the guardrail
* - default_on: Whether the guardrail is enabled by default
* - guardrail_info: Additional information about the guardrail
*
* Example Request:
* ```bash
* curl -X PATCH "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "guardrail_name": "updated-name",
* "default_on": true,
* "guardrail_info": {
* "description": "Updated description"
* }
* }'
* ```
*
* Example Response:
* ```json
* {
* "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
* "guardrail_name": "updated-name",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "DRAFT",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Updated description"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T14:22:33.456Z"
* }
* ```
*/
patch: operations["patch_guardrail_guardrails__guardrail_id__patch"];
trace?: never;
};
"/guardrails/{guardrail_id}/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Guardrail Info
* @description Get detailed information about a specific guardrail by ID
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000/info" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
* "guardrail_name": "my-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "DRAFT",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Bedrock content moderation guardrail"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* }
* ```
*/
get: operations["get_guardrail_info_guardrails__guardrail_id__info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Endpoint
* @description 🚨 USE `/health/liveliness` to health check the proxy 🚨
*
* See more 👉 https://docs.litellm.ai/docs/proxy/health
*
*
* Check the health of all the endpoints in config.yaml
*
* To run health checks in the background, add this to config.yaml:
* ```
* general_settings:
* # ... other settings
* background_health_checks: True
* ```
* else, the health checks will be run on models when /health is called.
*
* To skip deployments that set ``model_info.disable_background_health_check: true``
* on ``GET /health`` as well as in the background loop, set
* ``general_settings.health_check_skip_disabled_background_models: true``.
*/
get: operations["health_endpoint_health_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/backlog": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Backlog
* @description Returns the number of HTTP requests currently in-flight on this uvicorn worker.
*
* Use this to measure per-pod queue depth. A high value means the worker is
* processing many concurrent requests — requests arriving now will have to wait
* for the event loop to get to them, adding latency before LiteLLM even starts
* its own timer.
*/
get: operations["health_backlog_health_backlog_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/drain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Drain
* @description Graceful-drain probe for Kubernetes ``preStop`` hooks.
*
* Disabled by default and returns 404 unless ``general_settings`` sets
* ``enable_drain_endpoint: true``. Calling it flips a process-wide
* shutting-down flag, so a successful call permanently takes the worker out
* of rotation until the pod restarts.
*
* Because the kubelet calls preStop hooks without proxy credentials, the
* endpoint does not require ``user_api_key_auth``. To prevent any
* pod-reachable caller from triggering shutdown, set
* ``general_settings.drain_endpoint_token`` (or the ``DRAIN_ENDPOINT_TOKEN``
* env var) and supply the same value on the ``X-Drain-Token`` header from
* the preStop hook. Calls without the header (or with a wrong value) get a
* 401 and have no side effect.
*
* When enabled, it marks the worker as shutting down (so /health/readiness
* and /health/liveliness immediately start returning 503, removing the pod
* from service) and blocks until the in-flight request counter drains to
* zero or ``GRACEFUL_SHUTDOWN_TIMEOUT`` elapses. Unlike a fixed ``sleep``,
* this returns as soon as real in-flight work is done.
*
* Wire it up as:
*
* ```yaml
* lifecycle:
* preStop:
* httpGet:
* path: /health/drain
* port: 4000
* httpHeaders:
* - name: X-Drain-Token
* value: <same value as drain_endpoint_token>
* ```
*/
get: operations["health_drain_health_drain_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/history": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Check History Endpoint
* @description Get health check history for models
*
* Returns historical health check data with optional filtering.
*/
get: operations["health_check_history_endpoint_health_history_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/latest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Latest Health Checks Endpoint
* @description Get the latest health check status for all models
*
* Returns the most recent health check result for each model.
*/
get: operations["latest_health_checks_endpoint_health_latest_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/license": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health License Endpoint
* @description Return metadata about the configured LiteLLM license without exposing the key.
*/
get: operations["health_license_endpoint_health_license_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/liveliness": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Liveliness
* @description Unprotected endpoint for checking if worker is alive.
*
* Returns 503 once graceful shutdown has begun so Kubernetes stops counting
* the draining pod as live and terminates it on schedule.
*/
get: operations["health_liveliness_health_liveliness_get"];
put?: never;
post?: never;
delete?: never;
/**
* Health Liveliness Options
* @description Options endpoint for health/liveliness check.
*/
options: operations["health_liveliness_options_health_liveliness_options"];
head?: never;
patch?: never;
trace?: never;
};
"/health/liveness": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Liveliness
* @description Unprotected endpoint for checking if worker is alive.
*
* Returns 503 once graceful shutdown has begun so Kubernetes stops counting
* the draining pod as live and terminates it on schedule.
*/
get: operations["health_liveliness_health_liveness_get"];
put?: never;
post?: never;
delete?: never;
/**
* Health Liveliness Options
* @description Options endpoint for health/liveliness check.
*/
options: operations["health_liveliness_options_health_liveness_options"];
head?: never;
patch?: never;
trace?: never;
};
"/health/readiness": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Readiness
* @description Public readiness probe. Returns a low-detail payload safe to expose to
* unauthenticated load balancers — `status` plus `db` so orchestrators and
* external probes can distinguish "healthy" from "DB unreachable" without a
* credential. Admins can opt into the legacy detailed payload with
* general_settings.allow_public_health_readiness_details.
*/
get: operations["health_readiness_health_readiness_get"];
put?: never;
post?: never;
delete?: never;
/**
* Health Readiness Options
* @description Options endpoint for health/readiness check.
*/
options: operations["health_readiness_options_health_readiness_options"];
head?: never;
patch?: never;
trace?: never;
};
"/health/readiness/details": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Readiness Details
* @description Authenticated readiness diagnostics with DB/cache/callback metadata.
*/
get: operations["health_readiness_details_health_readiness_details_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/services": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Services Endpoint
* @description Use this admin-only endpoint to check if the service is healthy.
*
* Example:
* ```
* curl -L -X GET 'http://0.0.0.0:4000/health/services?service=datadog' -H 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["health_services_endpoint_health_services_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/shared-status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Shared Health Check Status Endpoint
* @description Get the status of shared health check coordination across pods.
*
* Returns information about Redis connectivity, lock status, and cache status.
*/
get: operations["shared_health_check_status_endpoint_health_shared_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health/test_connection": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Model Connection
* @description Test a direct connection to a specific model.
*
* This endpoint allows you to verify if your proxy can successfully connect to a specific model.
* It's useful for troubleshooting model connectivity issues without going through the full proxy routing.
*
* Example:
* ```bash
* # If model is configured in proxy_config.yaml, you only need to specify the model name:
* curl -X POST 'http://localhost:4000/health/test_connection' \
* -H 'Authorization: Bearer sk-1234' \
* -H 'Content-Type: application/json' \
* -d '{
* "litellm_params": {
* "model": "gpt-4o"
* },
* "mode": "chat"
* }'
*
* # The endpoint will automatically use api_key, api_base, etc. from proxy_config.yaml
*
* # You can also override specific params or test with custom credentials:
* curl -X POST 'http://localhost:4000/health/test_connection' \
* -H 'Authorization: Bearer sk-1234' \
* -H 'Content-Type: application/json' \
* -d '{
* "litellm_params": {
* "model": "azure/gpt-4o",
* "api_key": "os.environ/AZURE_OPENAI_API_KEY",
* "api_base": "os.environ/AZURE_OPENAI_ENDPOINT",
* "api_version": "2024-10-21"
* },
* "mode": "chat"
* }'
* ```
*
* Note:
* - If the model is configured in proxy_config.yaml, credentials (api_key, api_base, etc.)
* will be automatically loaded from the config (with resolved environment variables).
* - You can override specific params by including them in the request.
* - You can use `os.environ/VARIABLE_NAME` syntax to reference environment variables,
* which will be resolved automatically (same as in proxy_config.yaml).
*
* Returns:
* dict: A dictionary containing the health check result with either success information or error details.
*/
post: operations["test_model_connection_health_test_connection_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/images/edits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Image Edit Api
* @description Follows the OpenAI Images API spec: https://platform.openai.com/docs/api-reference/images/create
*
* ```bash
* curl -s -D >(grep -i x-request-id >&2) -o >(jq -r '.data[0].b64_json' | base64 --decode > gift-basket.png) -X POST "http://localhost:4000/v1/images/edits" -H "Authorization: Bearer sk-1234" -F "model=gpt-image-1" -F "image[]=@soap.png" -F 'prompt=Create a studio ghibli image of this'
* ```
*/
post: operations["image_edit_api_images_edits_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/images/generations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Image Generation */
post: operations["image_generation_images_generations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/in_product_nudges": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get In Product Nudges
* @description Get in-product nudges configuration.
*/
get: operations["get_in_product_nudges_in_product_nudges_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/interactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Interaction
* @description Create a new interaction using Google's Interactions API.
*
* Per OpenAPI spec: POST /{api_version}/interactions
*
* Supports both model interactions and agent interactions:
* - Model: Provide `model` parameter (e.g., "gemini-2.5-flash")
* - Agent: Provide `agent` parameter (e.g., "deep-research-pro-preview-12-2025")
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1beta/interactions" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "model": "gemini/gemini-2.5-flash",
* "input": "Hello, how are you?"
* }'
* ```
*/
post: operations["create_interaction_interactions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/interactions/{interaction_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Interaction
* @description Get an interaction by ID.
*
* Per OpenAPI spec: GET /{api_version}/interactions/{interaction_id}
*/
get: operations["get_interaction_interactions__interaction_id__get"];
put?: never;
post?: never;
/**
* Delete Interaction
* @description Delete an interaction by ID.
*
* Per OpenAPI spec: DELETE /{api_version}/interactions/{interaction_id}
*/
delete: operations["delete_interaction_interactions__interaction_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/interactions/{interaction_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Interaction
* @description Cancel an interaction by ID.
*
* Per OpenAPI spec: POST /{api_version}/interactions/{interaction_id}:cancel
*/
post: operations["cancel_interaction_interactions__interaction_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/invitation/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Invitation Delete
* @description Delete invitation link
*
* ```
* curl -X POST 'http://localhost:4000/invitation/delete' -H 'Content-Type: application/json' -d '{
* "invitation_id": "1234" // 👈 id of invitation in 'LiteLLM_InvitationTable'
* }'
* ```
*/
post: operations["invitation_delete_invitation_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/invitation/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Invitation Info
* @description Allow admin to create invite links, to onboard new users to Admin UI.
*
* ```
* curl -X POST 'http://localhost:4000/invitation/new' -H 'Content-Type: application/json' -d '{
* "user_id": "1234" // 👈 id of user in 'LiteLLM_UserTable'
* }'
* ```
*/
get: operations["invitation_info_invitation_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/invitation/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New Invitation
* @description Allow admin to create invite links, to onboard new users to Admin UI.
*
* ```
* curl -X POST 'http://localhost:4000/invitation/new' -H 'Content-Type: application/json' -d '{
* "user_id": "1234" // 👈 id of user in 'LiteLLM_UserTable'
* }'
* ```
*/
post: operations["new_invitation_invitation_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/invitation/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Invitation Update
* @description Update when invitation is accepted
*
* ```
* curl -X POST 'http://localhost:4000/invitation/update' -H 'Content-Type: application/json' -d '{
* "invitation_id": "1234" // 👈 id of invitation in 'LiteLLM_InvitationTable'
* "is_accepted": True // when invitation is accepted
* }'
* ```
*/
post: operations["invitation_update_invitation_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/jwt/key/mapping/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Delete Jwt Key Mapping */
post: operations["delete_jwt_key_mapping_jwt_key_mapping_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/jwt/key/mapping/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Info Jwt Key Mapping */
get: operations["info_jwt_key_mapping_jwt_key_mapping_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/jwt/key/mapping/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Jwt Key Mappings */
get: operations["list_jwt_key_mappings_jwt_key_mapping_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/jwt/key/mapping/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Jwt Key Mapping */
post: operations["create_jwt_key_mapping_jwt_key_mapping_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/jwt/key/mapping/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Update Jwt Key Mapping */
post: operations["update_jwt_key_mapping_jwt_key_mapping_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/aliases": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Key Aliases
* @description Lists key aliases with pagination and optional search.
*
* Non-admin users only see aliases for keys they own or keys belonging to
* their teams.
*
* Returns:
* {
* "aliases": List[str],
* "total_count": int,
* "current_page": int,
* "total_pages": int,
* "size": int,
* }
*/
get: operations["key_aliases_key_aliases_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/block": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Block Key
* @description Block an Virtual key from making any requests.
*
* Parameters:
* - key: str - The key to block. Can be either the unhashed key (sk-...) or the hashed key value
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/key/block' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "key": "sk-Fn8Ej39NxjAXrvpUGKghGw"
* }'
* ```
*
* Note: This is an admin-only endpoint. Only proxy admins, team admins, or org admins can block keys.
*/
post: operations["block_key_key_block_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/bulk_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Update Keys
* @description Bulk update multiple keys at once.
*
* This endpoint allows updating multiple keys in a single request. Each key update
* is processed independently - if some updates fail, others will still succeed.
*
* Parameters:
* - keys: List[BulkUpdateKeyRequestItem] - List of key update requests, each containing:
* - key: str - The key identifier (token) to update
* - budget_id: Optional[str] - Budget ID associated with the key
* - max_budget: Optional[float] - Max budget for key
* - team_id: Optional[str] - Team ID associated with key
* - tags: Optional[List[str]] - Tags for organizing keys
*
* Returns:
* - total_requested: int - Total number of keys requested for update
* - successful_updates: List[SuccessfulKeyUpdate] - List of successfully updated keys with their updated info
* - failed_updates: List[FailedKeyUpdate] - List of failed updates with key_info and failed_reason
*
* Example request:
* ```bash
* curl --location 'http://0.0.0.0:4000/key/bulk_update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "keys": [
* {
* "key": "sk-1234",
* "max_budget": 100.0,
* "team_id": "team-123",
* "tags": ["production", "api"]
* },
* {
* "key": "sk-5678",
* "budget_id": "budget-456",
* "tags": ["staging"]
* }
* ]
* }'
* ```
*/
post: operations["bulk_update_keys_key_bulk_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Key Fn
* @description Delete a key from the key management system.
*
* Parameters::
* - keys (List[str]): A list of keys or hashed keys to delete. Example {"keys": ["sk-QWrxEynunsNpV1zT48HIrw", "837e17519f44683334df5291321d97b8bf1098cd490e49e215f6fea935aa28be"]}
* - key_aliases (List[str]): A list of key aliases to delete. Can be passed instead of `keys`.Example {"key_aliases": ["alias1", "alias2"]}
*
* Returns:
* - deleted_keys (List[str]): A list of deleted keys. Example {"deleted_keys": ["sk-QWrxEynunsNpV1zT48HIrw", "837e17519f44683334df5291321d97b8bf1098cd490e49e215f6fea935aa28be"]}
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/key/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "keys": ["sk-QWrxEynunsNpV1zT48HIrw"]
* }'
* ```
*
* Raises:
* HTTPException: If an error occurs during key deletion.
*/
post: operations["delete_key_fn_key_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/generate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Key Fn
* @description Generate an API key based on the provided data.
*
* Docs: https://docs.litellm.ai/docs/proxy/virtual_keys
*
* Parameters:
* - duration: Optional[str] - Specify the length of time the token is valid for. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
* - key_alias: Optional[str] - User defined key alias
* - key: Optional[str] - User defined key value. If not set, a 16-digit unique sk-key is created for you.
* - team_id: Optional[str] - The team id of the key
* - user_id: Optional[str] - The user id of the key
* - agent_id: Optional[str] - The agent id associated with the key.
* - organization_id: Optional[str] - The organization id of the key. If not set, and team_id is set, the organization id will be the same as the team id. If conflict, an error will be raised.
* - project_id: Optional[str] - The project id of the key. When set, models and max_budget are validated against the project's limits.
* - budget_id: Optional[str] - The budget id associated with the key. Created by calling `/budget/new`.
* - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)
* - aliases: Optional[dict] - Any alias mappings, on top of anything in the config.yaml model list. - https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---upgradedowngrade-models
* - config: Optional[dict] - any key-specific configs, overrides config in config.yaml
* - spend: Optional[int] - Amount spent by key. Default is 0. Will be updated by proxy whenever key is used. https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---tracking-spend
* - send_invite_email: Optional[bool] - Whether to send an invite email to the user_id, with the generate key
* - max_budget: Optional[float] - Specify max budget for a given key.
* - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
* - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.
* - metadata: Optional[dict] - Metadata for key, store information for key. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
* - guardrails: Optional[List[str]] - List of active guardrails for the key
* - policies: Optional[List[str]] - List of policy names to apply to the key. Policies define guardrails, conditions, and inheritance rules.
* - disable_global_guardrails: Optional[bool] - Whether to disable global guardrails for the key.
* - permissions: Optional[dict] - key-specific permissions. Currently just used for turning off pii masking (if connected). Example - {"pii": false}
* - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}}. IF null or {} then no model specific budget.
* - model_rpm_limit: Optional[dict] - key-specific model rpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific rpm limit.
* - model_tpm_limit: Optional[dict] - key-specific model tpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific tpm limit.
* - mcp_rpm_limit: Optional[dict] - key-specific per-MCP-server rpm limit, keyed by MCP server name (alias if set, else the configured name). Example - {"github": 100, "slack": 200}. IF null or {} then no MCP-specific rpm limit.
* - tpm_limit_type: Optional[str] - Type of tpm limit. Options: "best_effort_throughput" (no error if we're overallocating tpm), "guaranteed_throughput" (raise an error if we're overallocating tpm), "dynamic" (dynamically exceed limit when no 429 errors). Defaults to "best_effort_throughput".
* - rpm_limit_type: Optional[str] - Type of rpm limit. Options: "best_effort_throughput" (no error if we're overallocating rpm), "guaranteed_throughput" (raise an error if we're overallocating rpm), "dynamic" (dynamically exceed limit when no 429 errors). Defaults to "best_effort_throughput".
* - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request
* - blocked: Optional[bool] - Whether the key is blocked.
* - rpm_limit: Optional[int] - Specify rpm limit for a given key (Requests per minute)
* - tpm_limit: Optional[int] - Specify tpm limit for a given key (Tokens per minute)
* - soft_budget: Optional[float] - Specify soft budget for a given key. Will trigger a slack alert when this soft budget is reached.
* - tags: Optional[List[str]] - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing).
* - prompts: Optional[List[str]] - List of prompts that the key is allowed to use.
* - enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). [Docs](https://docs.litellm.ai/docs/proxy/enterprise#enforce-required-params-for-llm-requests)
* - prompts: Optional[List[str]] - List of prompts that the key is allowed to use.
* - allowed_routes: Optional[list] - List of allowed routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/chat/completions", "/embeddings", "/keys/*"]
* - allowed_passthrough_routes: Optional[list] - List of allowed pass through endpoints for the key. Store the actual endpoint or store a wildcard pattern for a set of endpoints. Example - ["/my-custom-endpoint"]. Use this instead of allowed_routes, if you just want to specify which pass through endpoints the key can access, without specifying the routes. If allowed_routes is specified, allowed_pass_through_endpoints is ignored.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission.
* - key_type: Optional[str] - Type of key that determines default allowed routes. Options: "llm_api" (can call LLM API routes), "management" (can call management routes), "read_only" (can only call info/read routes), "default" (uses default allowed routes). Defaults to "default".
* - prompts: Optional[List[str]] - List of allowed prompts for the key. If specified, the key will only be able to use these specific prompts.
* - auto_rotate: Optional[bool] - Whether this key should be automatically rotated (regenerated)
* - rotation_interval: Optional[str] - How often to auto-rotate this key (e.g., '30s', '30m', '30h', '30d'). Required if auto_rotate=True.
* - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint.
* - router_settings: Optional[UpdateRouterConfig] - key-specific router settings. Example - {"model_group_retry_policy": {"max_retries": 5}}. IF null or {} then no router settings.
* - access_group_ids: Optional[List[str]] - List of access group IDs to associate with the key. Access groups define which models a key can access. Example - ["access_group_1", "access_group_2"].
* - budget_limits: Optional[list] - List of concurrent budget windows for the key. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}].
*
* Examples:
*
* 1. Allow users to turn on/off pii masking
*
* ```bash
* curl --location 'http://0.0.0.0:4000/key/generate' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "permissions": {"allow_pii_controls": true}
* }'
* ```
*
* Returns:
* - key: (str) The generated api key
* - expires: (datetime) Datetime object for when key expires.
* - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id.
*/
post: operations["generate_key_fn_key_generate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/health": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Key Health
* @description Check the health of the key
*
* Checks:
* - If key based logging is configured correctly - sends a test log
*
* Usage
*
* Pass the key in the request header
*
* ```bash
* curl -X POST "http://localhost:4000/key/health" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*
* Response when logging callbacks are setup correctly:
*
* ```json
* {
* "key": "healthy",
* "logging_callbacks": {
* "callbacks": [
* "gcs_bucket"
* ],
* "status": "healthy",
* "details": "No logger exceptions triggered, system is healthy. Manually check if logs were sent to ['gcs_bucket']"
* }
* }
* ```
*
*
* Response when logging callbacks are not setup correctly:
* ```json
* {
* "key": "unhealthy",
* "logging_callbacks": {
* "callbacks": [
* "gcs_bucket"
* ],
* "status": "unhealthy",
* "details": "Logger exceptions triggered, system is unhealthy: Failed to load vertex credentials. Check to see if credentials containing partial/invalid information."
* }
* }
* ```
*/
post: operations["key_health_key_health_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Info Key Fn
* @description Retrieve information about a key.
* Parameters:
* key: Optional[str] = Query parameter representing the key in the request
* user_api_key_dict: UserAPIKeyAuth = Dependency representing the user's API key
* Returns:
* Dict containing the key and its associated information
*
* Example Curl:
* ```
* curl -X GET "http://0.0.0.0:4000/key/info?key=sk-test-example-key-123" -H "Authorization: Bearer sk-1234"
* ```
*
* Example Curl - if no key is passed, it will use the Key Passed in Authorization Header
* ```
* curl -X GET "http://0.0.0.0:4000/key/info" -H "Authorization: Bearer sk-test-example-key-123"
* ```
*/
get: operations["info_key_fn_key_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Keys
* @description List all keys for a given user / team / organization.
*
* Parameters:
* expand: Optional[List[str]] - Expand related objects (e.g. 'user' to include user information)
* status: Optional[str] - Filter by status. Currently supports "deleted" to query deleted keys.
*
* Returns:
* {
* "keys": List[str] or List[UserAPIKeyAuth],
* "total_count": int,
* "current_page": int,
* "total_pages": int,
* }
*
* When expand includes "user", each key object will include a "user" field with the associated user object.
* Note: When expand=user is specified, full key objects are returned regardless of the return_full_object parameter.
*/
get: operations["list_keys_key_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/regenerate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Regenerate Key Fn
* @description Regenerate an existing API key while optionally updating its parameters.
*
* Parameters:
* - key: str (path parameter) - The key to regenerate
* - data: Optional[RegenerateKeyRequest] - Request body containing optional parameters to update
* - key: Optional[str] - The key to regenerate.
* - new_master_key: Optional[str] - The new master key to use, if key is the master key.
* - new_key: Optional[str] - The new key to use, if key is not the master key. If both set, new_master_key will be used.
* - key_alias: Optional[str] - User-friendly key alias
* - user_id: Optional[str] - User ID associated with key
* - team_id: Optional[str] - Team ID associated with key
* - models: Optional[list] - Model_name's a user is allowed to call
* - tags: Optional[List[str]] - Tags for organizing keys (Enterprise only)
* - spend: Optional[float] - Amount spent by key
* - max_budget: Optional[float] - Max budget for key
* - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}
* - budget_duration: Optional[str] - Budget reset period ("30d", "1h", etc.)
* - soft_budget: Optional[float] - Soft budget limit (warning vs. hard stop). Will trigger a slack alert when this soft budget is reached.
* - max_parallel_requests: Optional[int] - Rate limit for parallel requests
* - metadata: Optional[dict] - Metadata for key. Example {"team": "core-infra", "app": "app2"}
* - tpm_limit: Optional[int] - Tokens per minute limit
* - rpm_limit: Optional[int] - Requests per minute limit
* - model_rpm_limit: Optional[dict] - Model-specific RPM limits {"gpt-4": 100, "claude-v1": 200}
* - model_tpm_limit: Optional[dict] - Model-specific TPM limits {"gpt-4": 100000, "claude-v1": 200000}
* - allowed_cache_controls: Optional[list] - List of allowed cache control values
* - duration: Optional[str] - Key validity duration ("30d", "1h", etc.)
* - permissions: Optional[dict] - Key-specific permissions
* - guardrails: Optional[List[str]] - List of active guardrails for the key
* - blocked: Optional[bool] - Whether the key is blocked
* - grace_period: Optional[str] - Duration to keep old key valid after rotation (e.g. "24h", "2d"). Omitted = immediate revoke. Env: LITELLM_KEY_ROTATION_GRACE_PERIOD
*
*
* Returns:
* - GenerateKeyResponse containing the new key and its updated parameters
*
* Example:
* ```bash
* curl --location --request POST 'http://localhost:4000/key/sk-1234/regenerate' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data-raw '{
* "max_budget": 100,
* "metadata": {"team": "core-infra"},
* "models": ["gpt-4", "gpt-3.5-turbo"]
* }'
* ```
*
* Note: This is an Enterprise feature. It requires a premium license to use.
*/
post: operations["regenerate_key_fn_key_regenerate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/service-account/generate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Generate Service Account Key Fn
* @description Generate a Service Account API key based on the provided data. This key does not belong to any user. It belongs to the team.
*
* Why use a service account key?
* - Prevent key from being deleted when user is deleted.
* - Apply team limits, not team member limits to key.
*
* Docs: https://docs.litellm.ai/docs/proxy/virtual_keys
*
* Parameters:
* - duration: Optional[str] - Specify the length of time the token is valid for. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
* - key_alias: Optional[str] - User defined key alias
* - key: Optional[str] - User defined key value. If not set, a 16-digit unique sk-key is created for you.
* - team_id: Optional[str] - The team id of the key
* - user_id: Optional[str] - [NON-FUNCTIONAL] THIS WILL BE IGNORED. The user id of the key
* - budget_id: Optional[str] - The budget id associated with the key. Created by calling `/budget/new`.
* - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)
* - aliases: Optional[dict] - Any alias mappings, on top of anything in the config.yaml model list. - https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---upgradedowngrade-models
* - config: Optional[dict] - any key-specific configs, overrides config in config.yaml
* - spend: Optional[int] - Amount spent by key. Default is 0. Will be updated by proxy whenever key is used. https://docs.litellm.ai/docs/proxy/virtual_keys#managing-auth---tracking-spend
* - send_invite_email: Optional[bool] - Whether to send an invite email to the user_id, with the generate key
* - max_budget: Optional[float] - Specify max budget for a given key.
* - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d").
* - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.
* - metadata: Optional[dict] - Metadata for key, store information for key. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
* - guardrails: Optional[List[str]] - List of active guardrails for the key
* - permissions: Optional[dict] - key-specific permissions. Currently just used for turning off pii masking (if connected). Example - {"pii": false}
* - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}}. IF null or {} then no model specific budget.
* - model_rpm_limit: Optional[dict] - key-specific model rpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific rpm limit.
* - model_tpm_limit: Optional[dict] - key-specific model tpm limit. Example - {"text-davinci-002": 1000, "gpt-3.5-turbo": 1000}. IF null or {} then no model specific tpm limit.
* - mcp_rpm_limit: Optional[dict] - key-specific per-MCP-server rpm limit, keyed by MCP server name (alias if set, else the configured name). Example - {"github": 100, "slack": 200}. IF null or {} then no MCP-specific rpm limit.
* - tpm_limit_type: Optional[str] - TPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic"
* - rpm_limit_type: Optional[str] - RPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic"
* - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request
* - blocked: Optional[bool] - Whether the key is blocked.
* - rpm_limit: Optional[int] - Specify rpm limit for a given key (Requests per minute)
* - tpm_limit: Optional[int] - Specify tpm limit for a given key (Tokens per minute)
* - soft_budget: Optional[float] - Specify soft budget for a given key. Will trigger a slack alert when this soft budget is reached.
* - tags: Optional[List[str]] - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing).
* - enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). [Docs](https://docs.litellm.ai/docs/proxy/enterprise#enforce-required-params-for-llm-requests)
* - allowed_routes: Optional[list] - List of allowed routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/chat/completions", "/embeddings", "/keys/*"]
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission.
* Examples:
* - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint.
*
*
* 1. Allow users to turn on/off pii masking
*
* ```bash
* curl --location 'http://0.0.0.0:4000/key/generate' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "permissions": {"allow_pii_controls": true}
* }'
* ```
*
* Returns:
* - key: (str) The generated api key
* - expires: (datetime) Datetime object for when key expires.
* - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id.
*/
post: operations["generate_service_account_key_fn_key_service_account_generate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/unblock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Unblock Key
* @description Unblock a Virtual key to allow it to make requests again.
*
* Parameters:
* - key: str - The key to unblock. Can be either the unhashed key (sk-...) or the hashed key value
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/key/unblock' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "key": "sk-Fn8Ej39NxjAXrvpUGKghGw"
* }'
* ```
*
* Note: This is an admin-only endpoint. Only proxy admins, team admins, or org admins can unblock keys.
*/
post: operations["unblock_key_key_unblock_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Key Fn
* @description Update an existing API key's parameters.
*
* Parameters:
* - key: str - The key to update
* - key_alias: Optional[str] - User-friendly key alias
* - user_id: Optional[str] - User ID associated with key
* - team_id: Optional[str] - Team ID associated with key
* - agent_id: Optional[str] - The agent id associated with the key.
* - organization_id: Optional[str] - The organization id of the key.
* - budget_id: Optional[str] - The budget id associated with the key. Created by calling `/budget/new`.
* - models: Optional[list] - Model_name's a user is allowed to call
* - tags: Optional[List[str]] - Tags for organizing keys (Enterprise only)
* - prompts: Optional[List[str]] - List of prompts that the key is allowed to use.
* - enforced_params: Optional[List[str]] - List of enforced params for the key (Enterprise only). [Docs](https://docs.litellm.ai/docs/proxy/enterprise#enforce-required-params-for-llm-requests)
* - spend: Optional[float] - Amount spent by key
* - max_budget: Optional[float] - Max budget for key
* - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}
* - budget_duration: Optional[str] - Budget reset period ("30d", "1h", etc.)
* - soft_budget: Optional[float] - [TODO] Soft budget limit (warning vs. hard stop). Will trigger a slack alert when this soft budget is reached.
* - max_parallel_requests: Optional[int] - Rate limit for parallel requests
* - metadata: Optional[dict] - Metadata for key. Example {"team": "core-infra", "app": "app2"}
* - tpm_limit: Optional[int] - Tokens per minute limit
* - rpm_limit: Optional[int] - Requests per minute limit
* - model_rpm_limit: Optional[dict] - Model-specific RPM limits {"gpt-4": 100, "claude-v1": 200}
* - mcp_rpm_limit: Optional[dict] - Per-MCP-server RPM limits, keyed by MCP server name {"github": 100, "slack": 200}
* - model_tpm_limit: Optional[dict] - Model-specific TPM limits {"gpt-4": 100000, "claude-v1": 200000}
* - tpm_limit_type: Optional[str] - TPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic"
* - rpm_limit_type: Optional[str] - RPM rate limit type - "best_effort_throughput", "guaranteed_throughput", or "dynamic"
* - allowed_cache_controls: Optional[list] - List of allowed cache control values
* - duration: Optional[str] - Key validity duration ("30d", "1h", etc.), null to never expire, or "-1" to never expire (deprecated, use null)
* - permissions: Optional[dict] - Key-specific permissions
* - send_invite_email: Optional[bool] - Send invite email to user_id
* - guardrails: Optional[List[str]] - List of active guardrails for the key
* - policies: Optional[List[str]] - List of policy names to apply to the key. Policies define guardrails, conditions, and inheritance rules.
* - disable_global_guardrails: Optional[bool] - Whether to disable global guardrails for the key.
* - prompts: Optional[List[str]] - List of prompts that the key is allowed to use.
* - blocked: Optional[bool] - Whether the key is blocked
* - aliases: Optional[dict] - Model aliases for the key - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases)
* - config: Optional[dict] - [DEPRECATED PARAM] Key-specific config.
* - temp_budget_increase: Optional[float] - Temporary budget increase for the key (Enterprise only).
* - temp_budget_expiry: Optional[str] - Expiry time for the temporary budget increase (Enterprise only).
* - allowed_routes: Optional[list] - List of allowed routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/chat/completions", "/embeddings", "/keys/*"]
* - allowed_passthrough_routes: Optional[list] - List of allowed pass through routes for the key. Store the actual route or store a wildcard pattern for a set of routes. Example - ["/my-custom-endpoint"]. Use this instead of allowed_routes, if you just want to specify which pass through routes the key can access, without specifying the routes. If allowed_routes is specified, allowed_passthrough_routes is ignored.
* - prompts: Optional[List[str]] - List of allowed prompts for the key. If specified, the key will only be able to use these specific prompts.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission.
* - auto_rotate: Optional[bool] - Whether this key should be automatically rotated
* - rotation_interval: Optional[str] - How often to rotate this key (e.g., '30d', '90d'). Required if auto_rotate=True
* - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint.
* - router_settings: Optional[UpdateRouterConfig] - key-specific router settings. Example - {"model_group_retry_policy": {"max_retries": 5}}. IF null or {} then no router settings.
* - access_group_ids: Optional[List[str]] - List of access group IDs to associate with the key. Access groups define which models a key can access. Example - ["access_group_1", "access_group_2"].
* - budget_limits: Optional[list] - List of concurrent budget windows for the key. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}].
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/key/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "key": "sk-1234",
* "key_alias": "my-key",
* "user_id": "user-1234",
* "team_id": "team-1234",
* "max_budget": 100,
* "metadata": {"any_key": "any-val"},
* }'
* ```
*/
post: operations["update_key_fn_key_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/{key}/regenerate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Regenerate Key Fn
* @description Regenerate an existing API key while optionally updating its parameters.
*
* Parameters:
* - key: str (path parameter) - The key to regenerate
* - data: Optional[RegenerateKeyRequest] - Request body containing optional parameters to update
* - key: Optional[str] - The key to regenerate.
* - new_master_key: Optional[str] - The new master key to use, if key is the master key.
* - new_key: Optional[str] - The new key to use, if key is not the master key. If both set, new_master_key will be used.
* - key_alias: Optional[str] - User-friendly key alias
* - user_id: Optional[str] - User ID associated with key
* - team_id: Optional[str] - Team ID associated with key
* - models: Optional[list] - Model_name's a user is allowed to call
* - tags: Optional[List[str]] - Tags for organizing keys (Enterprise only)
* - spend: Optional[float] - Amount spent by key
* - max_budget: Optional[float] - Max budget for key
* - model_max_budget: Optional[Dict[str, BudgetConfig]] - Model-specific budgets {"gpt-4": {"budget_limit": 0.0005, "time_period": "30d"}}
* - budget_duration: Optional[str] - Budget reset period ("30d", "1h", etc.)
* - soft_budget: Optional[float] - Soft budget limit (warning vs. hard stop). Will trigger a slack alert when this soft budget is reached.
* - max_parallel_requests: Optional[int] - Rate limit for parallel requests
* - metadata: Optional[dict] - Metadata for key. Example {"team": "core-infra", "app": "app2"}
* - tpm_limit: Optional[int] - Tokens per minute limit
* - rpm_limit: Optional[int] - Requests per minute limit
* - model_rpm_limit: Optional[dict] - Model-specific RPM limits {"gpt-4": 100, "claude-v1": 200}
* - model_tpm_limit: Optional[dict] - Model-specific TPM limits {"gpt-4": 100000, "claude-v1": 200000}
* - allowed_cache_controls: Optional[list] - List of allowed cache control values
* - duration: Optional[str] - Key validity duration ("30d", "1h", etc.)
* - permissions: Optional[dict] - Key-specific permissions
* - guardrails: Optional[List[str]] - List of active guardrails for the key
* - blocked: Optional[bool] - Whether the key is blocked
* - grace_period: Optional[str] - Duration to keep old key valid after rotation (e.g. "24h", "2d"). Omitted = immediate revoke. Env: LITELLM_KEY_ROTATION_GRACE_PERIOD
*
*
* Returns:
* - GenerateKeyResponse containing the new key and its updated parameters
*
* Example:
* ```bash
* curl --location --request POST 'http://localhost:4000/key/sk-1234/regenerate' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data-raw '{
* "max_budget": 100,
* "metadata": {"team": "core-infra"},
* "models": ["gpt-4", "gpt-3.5-turbo"]
* }'
* ```
*
* Note: This is an Enterprise feature. It requires a premium license to use.
*/
post: operations["regenerate_key_fn_key__key__regenerate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/key/{key}/reset_spend": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Reset Key Spend Fn */
post: operations["reset_key_spend_fn_key__key__reset_spend_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/langfuse/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Langfuse Proxy Route
* @description Call Langfuse via LiteLLM proxy. Works with Langfuse SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/langfuse)
*/
get: operations["langfuse_proxy_route_langfuse__endpoint__get"];
/**
* Langfuse Proxy Route
* @description Call Langfuse via LiteLLM proxy. Works with Langfuse SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/langfuse)
*/
put: operations["langfuse_proxy_route_langfuse__endpoint__put"];
/**
* Langfuse Proxy Route
* @description Call Langfuse via LiteLLM proxy. Works with Langfuse SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/langfuse)
*/
post: operations["langfuse_proxy_route_langfuse__endpoint__post"];
/**
* Langfuse Proxy Route
* @description Call Langfuse via LiteLLM proxy. Works with Langfuse SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/langfuse)
*/
delete: operations["langfuse_proxy_route_langfuse__endpoint__delete"];
options?: never;
head?: never;
/**
* Langfuse Proxy Route
* @description Call Langfuse via LiteLLM proxy. Works with Langfuse SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/langfuse)
*/
patch: operations["langfuse_proxy_route_langfuse__endpoint__patch"];
trace?: never;
};
"/lazy/warm/{name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Warm */
post: operations["warm_lazy_warm__name__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/litellm/.well-known/litellm-ui-config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Ui Config */
get: operations["get_ui_config_litellm__well_known_litellm_ui_config_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Login */
post: operations["login_login_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/mcp-rest/test/connection": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Connection
* @description Test if we can connect to the provided MCP server before adding it
*/
post: operations["test_connection_mcp_rest_test_connection_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/mcp-rest/test/tools/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Tools List
* @description Preview tools available from MCP server before adding it
*/
post: operations["test_tools_list_mcp_rest_test_tools_list_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/mcp-rest/tools/call": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Call Tool Rest Api
* @description REST API to call a specific MCP tool with the provided arguments
*/
post: operations["call_tool_rest_api_mcp_rest_tools_call_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/mcp-rest/tools/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Tool Rest Api
* @description List all available tools with information about the server they belong to.
*
* Example response:
* {
* "tools": [
* {
* "name": "create_zap",
* "description": "Create a new zap",
* "inputSchema": "tool_input_schema",
* "mcp_info": {
* "server_name": "zapier",
* "logo_url": "https://www.zapier.com/logo.png",
* }
* }
* ],
* "error": null,
* "message": "Successfully retrieved tools"
* }
*/
get: operations["list_tool_rest_api_mcp_rest_tools_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/memory-usage-in-mem-cache": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Memory Usage In Mem Cache
* @description 1. user_api_key_cache
* 2. router_cache
* 3. proxy_logging_cache
* 4. internal_usage_cache
*/
get: operations["memory_usage_in_mem_cache_memory_usage_in_mem_cache_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/memory-usage-in-mem-cache-items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Memory Usage In Mem Cache Items
* @description 1. user_api_key_cache
* 2. router_cache
* 3. proxy_logging_cache
* 4. internal_usage_cache
*/
get: operations["memory_usage_in_mem_cache_items_memory_usage_in_mem_cache_items_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/milvus/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Milvus Proxy Route
* @description Enable using Milvus `/vectors` endpoint as a pass-through endpoint.
*/
get: operations["milvus_proxy_route_milvus__endpoint__get"];
/**
* Milvus Proxy Route
* @description Enable using Milvus `/vectors` endpoint as a pass-through endpoint.
*/
put: operations["milvus_proxy_route_milvus__endpoint__put"];
/**
* Milvus Proxy Route
* @description Enable using Milvus `/vectors` endpoint as a pass-through endpoint.
*/
post: operations["milvus_proxy_route_milvus__endpoint__post"];
/**
* Milvus Proxy Route
* @description Enable using Milvus `/vectors` endpoint as a pass-through endpoint.
*/
delete: operations["milvus_proxy_route_milvus__endpoint__delete"];
options?: never;
head?: never;
/**
* Milvus Proxy Route
* @description Enable using Milvus `/vectors` endpoint as a pass-through endpoint.
*/
patch: operations["milvus_proxy_route_milvus__endpoint__patch"];
trace?: never;
};
"/mistral/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Mistral Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/mistral)
*/
get: operations["mistral_proxy_route_mistral__endpoint__get"];
/**
* Mistral Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/mistral)
*/
put: operations["mistral_proxy_route_mistral__endpoint__put"];
/**
* Mistral Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/mistral)
*/
post: operations["mistral_proxy_route_mistral__endpoint__post"];
/**
* Mistral Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/mistral)
*/
delete: operations["mistral_proxy_route_mistral__endpoint__delete"];
options?: never;
head?: never;
/**
* Mistral Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/mistral)
*/
patch: operations["mistral_proxy_route_mistral__endpoint__patch"];
trace?: never;
};
"/model/cost_map/source": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Model Cost Map Source
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Returns information about where the current model cost/pricing data was loaded from.
*
* Response fields:
* - source: "local" (bundled backup) or "remote" (fetched from URL)
* - url: the remote URL that was attempted (null when env-forced local)
* - is_env_forced: true if LITELLM_LOCAL_MODEL_COST_MAP=True forced local usage
* - fallback_reason: human-readable reason why remote failed (null on success)
* - model_count: number of models in the currently loaded cost map
*/
get: operations["get_model_cost_map_source_model_cost_map_source_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Model
* @description Allows deleting models in the model list in the config.yaml
*/
post: operations["delete_model_model_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Info V1
* @description Provides more info about each model in /models, including config.yaml descriptions (except api key and api base)
*
* Parameters:
* litellm_model_id: Optional[str] = None (this is the value of `x-litellm-model-id` returned in response headers)
*
* - When litellm_model_id is passed, it will return the info for that specific model
* - When litellm_model_id is not passed, it will return the info for all models
*
* Returns:
* Returns a dictionary containing information about each model.
*
* Example Response:
* ```json
* {
* "data": [
* {
* "model_name": "fake-openai-endpoint",
* "litellm_params": {
* "api_base": "https://exampleopenaiendpoint-production.up.railway.app/",
* "model": "openai/fake"
* },
* "model_info": {
* "id": "112f74fab24a7a5245d2ced3536dd8f5f9192c57ee6e332af0f0512e08bed5af",
* "db_model": false
* }
* }
* ]
* }
*
* ```
*/
get: operations["model_info_v1_model_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Metrics
* @description View number of requests & avg latency per model on config.yaml
*/
get: operations["model_metrics_model_metrics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/metrics/exceptions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Metrics Exceptions
* @description View number of failed requests per model on config.yaml
*/
get: operations["model_metrics_exceptions_model_metrics_exceptions_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/metrics/slow_responses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Metrics Slow Responses
* @description View number of hanging requests per model_group
*/
get: operations["model_metrics_slow_responses_model_metrics_slow_responses_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add New Model
* @description Allows adding new models to the model list in the config.yaml
*/
post: operations["add_new_model_model_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Settings
* @description Returns provider name, description, and required parameters for each provider
*/
get: operations["model_settings_model_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/streaming_metrics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Streaming Metrics
* @description View time to first token for models in spend logs
*/
get: operations["model_streaming_metrics_model_streaming_metrics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Model
* @description Edit existing model params
*/
post: operations["update_model_model_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model/{model_id}/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Patch Model
* @description PATCH Endpoint for partial model updates.
*
* Only updates the fields specified in the request while preserving other existing values.
* Follows proper PATCH semantics by only modifying provided fields.
*
* Args:
* model_id: The ID of the model to update
* patch_data: The fields to update and their new values
* user_api_key_dict: User authentication information
*
* Returns:
* Updated model information
*
* Raises:
* ProxyException: For various error conditions including authentication and database errors
*/
patch: operations["patch_model_model__model_id__update_patch"];
trace?: never;
};
"/model_group/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Group Info
* @description Get information about all the deployments on litellm proxy, including config.yaml descriptions (except api key and api base)
*
* - /model_group/info returns all model groups. End users of proxy should use /model_group/info since those models will be used for /chat/completions, /embeddings, etc.
* - /model_group/info?model_group=rerank-english-v3.0 returns all model groups for a specific model group (`model_name` in config.yaml)
*
*
*
* Example Request (All Models):
* ```shell
* curl -X 'GET' 'http://localhost:4000/model_group/info' -H 'accept: application/json' -H 'x-api-key: sk-1234'
* ```
*
* Example Request (Specific Model Group):
* ```shell
* curl -X 'GET' 'http://localhost:4000/model_group/info?model_group=rerank-english-v3.0' -H 'accept: application/json' -H 'Authorization: Bearer sk-1234'
* ```
*
* Example Request (Specific Wildcard Model Group): (e.g. `model_name: openai/*` on config.yaml)
* ```shell
* curl -X 'GET' 'http://localhost:4000/model_group/info?model_group=openai/tts-1'
* -H 'accept: application/json' -H 'Authorization: Bearersk-1234'
* ```
*
* Learn how to use and set wildcard models [here](https://docs.litellm.ai/docs/wildcard_routing)
*
* Example Response:
* ```json
* {
* "data": [
* {
* "model_group": "rerank-english-v3.0",
* "providers": [
* "cohere"
* ],
* "max_input_tokens": null,
* "max_output_tokens": null,
* "input_cost_per_token": 0.0,
* "output_cost_per_token": 0.0,
* "mode": null,
* "tpm": null,
* "rpm": null,
* "supports_parallel_function_calling": false,
* "supports_vision": false,
* "supports_function_calling": false,
* "supported_openai_params": [
* "stream",
* "temperature",
* "max_tokens",
* "logit_bias",
* "top_p",
* "frequency_penalty",
* "presence_penalty",
* "stop",
* "n",
* "extra_headers"
* ]
* },
* {
* "model_group": "gpt-3.5-turbo",
* "providers": [
* "openai"
* ],
* "max_input_tokens": 16385.0,
* "max_output_tokens": 4096.0,
* "input_cost_per_token": 1.5e-06,
* "output_cost_per_token": 2e-06,
* "mode": "chat",
* "tpm": null,
* "rpm": null,
* "supports_parallel_function_calling": false,
* "supports_vision": false,
* "supports_function_calling": true,
* "supported_openai_params": [
* "frequency_penalty",
* "logit_bias",
* "logprobs",
* "top_logprobs",
* "max_tokens",
* "max_completion_tokens",
* "n",
* "presence_penalty",
* "seed",
* "stop",
* "stream",
* "stream_options",
* "temperature",
* "top_p",
* "tools",
* "tool_choice",
* "function_call",
* "functions",
* "max_retries",
* "extra_headers",
* "parallel_tool_calls",
* "response_format"
* ]
* },
* {
* "model_group": "llava-hf",
* "providers": [
* "openai"
* ],
* "max_input_tokens": null,
* "max_output_tokens": null,
* "input_cost_per_token": 0.0,
* "output_cost_per_token": 0.0,
* "mode": null,
* "tpm": null,
* "rpm": null,
* "supports_parallel_function_calling": false,
* "supports_vision": true,
* "supports_function_calling": false,
* "supported_openai_params": [
* "frequency_penalty",
* "logit_bias",
* "logprobs",
* "top_logprobs",
* "max_tokens",
* "max_completion_tokens",
* "n",
* "presence_penalty",
* "seed",
* "stop",
* "stream",
* "stream_options",
* "temperature",
* "top_p",
* "tools",
* "tool_choice",
* "function_call",
* "functions",
* "max_retries",
* "extra_headers",
* "parallel_tool_calls",
* "response_format"
* ]
* }
* ]
* }
* ```
*/
get: operations["model_group_info_model_group_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model_group/make_public": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Public Model Groups
* @description Update which model groups are public
*/
post: operations["update_public_model_groups_model_group_make_public_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/model_hub/update_useful_links": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Useful Links
* @description Update useful links
*/
post: operations["update_useful_links_model_hub_update_useful_links_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/models": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model List
* @description Use `/model/info` - to get detailed model information, example - pricing, mode, etc.
*
* This is just for compatibility with openai projects like aider.
*
* Query Parameters:
* - include_metadata: Include additional metadata in the response with fallback information
* - fallback_type: Type of fallbacks to include ("general", "context_window", "content_policy")
* Defaults to "general" when include_metadata=true
* - scope: Optional scope parameter. Currently only accepts "expand".
* When scope=expand is passed, proxy admins, team admins, and org admins
* will receive all proxy models as if they are a proxy admin.
*/
get: operations["model_list_models_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/models/{model_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Info
* @description Retrieve information about a specific model accessible to your API key.
*
* Returns model details only if the model is available to your API key/team.
* Returns 404 if the model doesn't exist or is not accessible.
*
* Follows OpenAI API specification for individual model retrieval.
* https://platform.openai.com/docs/api-reference/models/retrieve
*/
get: operations["model_info_models__model_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/models/{model_name}:countTokens": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Google Count Tokens
* @description ```json
* return {
* "totalTokens": 31,
* "totalBillableCharacters": 96,
* "promptTokensDetails": [
* {
* "modality": "TEXT",
* "tokenCount": 31
* }
* ]
* }
* ```
*/
post: operations["google_count_tokens_models__model_name__countTokens_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/models/{model_name}:generateContent": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Google Generate Content */
post: operations["google_generate_content_models__model_name__generateContent_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/models/{model_name}:streamGenerateContent": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Google Stream Generate Content */
post: operations["google_stream_generate_content_models__model_name__streamGenerateContent_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/moderations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Moderations
* @description The moderations endpoint is a tool you can use to check whether content complies with an LLM Providers policies.
* Quick Start
* ```
* curl --location 'http://0.0.0.0:4000/moderations' --header 'Content-Type: application/json' --header 'Authorization: Bearer sk-1234' --data '{"input": "Sample text goes here", "model": "text-moderation-stable"}'
* ```
*/
post: operations["moderations_moderations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ocr": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Ocr
* @description OCR endpoint for extracting text from documents and images.
*
* Supports two input modes:
*
* **1. JSON body** (Mistral OCR API compatible):
* ```bash
* curl -X POST "http://localhost:4000/v1/ocr" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "model": "mistral-ocr",
* "document": {
* "type": "document_url",
* "document_url": "https://arxiv.org/pdf/2201.04234"
* }
* }'
* ```
*
* **2. Multipart form file upload**:
* ```bash
* curl -X POST "http://localhost:4000/v1/ocr" -H "Authorization: Bearer sk-1234" -F "model=mistral-ocr" -F "file=@document.pdf"
* ```
*/
post: operations["ocr_ocr_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/onboarding/claim_token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Claim Onboarding Link
* @description Special route. Allows UI link share user to update their password.
*
* - Get the invite link
* - Validate it's still 'valid'
* - Check if user within initial session (prevents abuse)
* - Get user from db
* - Update user password
*
* This route can only update user password.
*/
post: operations["claim_onboarding_link_onboarding_claim_token_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/onboarding/get_token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Onboarding
* @description - Get the invite link
* - Validate it's still 'valid'
* - Return a short-lived onboarding token
* - Get user from db
* - Pass in user_email if set
*/
get: operations["onboarding_onboarding_get_token_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/deployments/{model}/chat/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Chat Completion
* @description Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`
*
* ```bash
* curl -X POST http://localhost:4000/v1/chat/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-4o",
* "messages": [
* {
* "role": "user",
* "content": "Hello!"
* }
* ]
* }'
* ```
*/
post: operations["chat_completion_openai_deployments__model__chat_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/deployments/{model}/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Completion
* @description Follows the exact same API spec as `OpenAI's Completions API https://platform.openai.com/docs/api-reference/completions`
*
* ```bash
* curl -X POST http://localhost:4000/v1/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-3.5-turbo-instruct",
* "prompt": "Once upon a time",
* "max_tokens": 50,
* "temperature": 0.7
* }'
* ```
*/
post: operations["completion_openai_deployments__model__completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/deployments/{model}/embeddings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Embeddings
* @description Follows the exact same API spec as `OpenAI's Embeddings API https://platform.openai.com/docs/api-reference/embeddings`
*
* ```bash
* curl -X POST http://localhost:4000/v1/embeddings
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "text-embedding-ada-002",
* "input": "The quick brown fox jumps over the lazy dog"
* }'
* ```
*/
post: operations["embeddings_openai_deployments__model__embeddings_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/deployments/{model}/images/edits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Image Edit Api
* @description Follows the OpenAI Images API spec: https://platform.openai.com/docs/api-reference/images/create
*
* ```bash
* curl -s -D >(grep -i x-request-id >&2) -o >(jq -r '.data[0].b64_json' | base64 --decode > gift-basket.png) -X POST "http://localhost:4000/v1/images/edits" -H "Authorization: Bearer sk-1234" -F "model=gpt-image-1" -F "image[]=@soap.png" -F 'prompt=Create a studio ghibli image of this'
* ```
*/
post: operations["image_edit_api_openai_deployments__model__images_edits_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/deployments/{model}/images/generations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Image Generation */
post: operations["image_generation_openai_deployments__model__images_generations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/realtime": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* WebSocket: realtime_websocket_endpoint
* @description WebSocket connection endpoint
*/
get: operations["websocket_realtime_websocket_endpoint_get_3"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/realtime/calls": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Proxy Realtime Calls */
post: operations["proxy_realtime_calls_openai_v1_realtime_calls_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/realtime/client_secrets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Realtime Client Secret */
post: operations["create_realtime_client_secret_openai_v1_realtime_client_secrets_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/responses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Responses Api
* @description Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses
*
* Supports background mode with polling_via_cache for partial response retrieval.
* When background=true and polling_via_cache is enabled, returns a polling_id immediately
* and streams the response in the background, updating Redis cache.
*
* ```bash
* # Normal request
* curl -X POST http://localhost:4000/v1/responses -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": "Tell me about AI"
* }'
*
* # Background request with polling
* curl -X POST http://localhost:4000/v1/responses -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": "Tell me about AI",
* "background": true
* }'
* ```
*/
post: operations["responses_api_openai_v1_responses_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/responses/compact": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Compact Response
* @description Compact a response by running a compaction pass over a conversation.
*
* Returns encrypted, opaque items that can be used to reduce context size.
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/compact
*
* ```bash
* curl -X POST http://localhost:4000/v1/responses/compact -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": [{"role": "user", "content": "Hello"}]
* }'
* ```
*/
post: operations["compact_response_openai_v1_responses_compact_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/responses/{response_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Response
* @description Get a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Returns cumulative cached content from background responses
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/get
*
* ```bash
* # Get polling response
* curl -X GET http://localhost:4000/v1/responses/litellm_poll_abc123 -H "Authorization: Bearer sk-1234"
*
* # Get provider response
* curl -X GET http://localhost:4000/v1/responses/resp_abc123 -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["get_response_openai_v1_responses__response_id__get"];
put?: never;
post?: never;
/**
* Delete Response
* @description Delete a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Deletes from Redis cache
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/delete
*
* ```bash
* curl -X DELETE http://localhost:4000/v1/responses/resp_abc123 -H "Authorization: Bearer sk-1234"
* ```
*/
delete: operations["delete_response_openai_v1_responses__response_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/responses/{response_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Response
* @description Cancel a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Cancels background response and updates status in Redis
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/cancel
*
* ```bash
* # Cancel polling response
* curl -X POST http://localhost:4000/v1/responses/litellm_poll_abc123/cancel -H "Authorization: Bearer sk-1234"
*
* # Cancel provider response
* curl -X POST http://localhost:4000/v1/responses/resp_abc123/cancel -H "Authorization: Bearer sk-1234"
* ```
*/
post: operations["cancel_response_openai_v1_responses__response_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/v1/responses/{response_id}/input_items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Response Input Items
* @description List input items for a response.
*/
get: operations["get_response_input_items_openai_v1_responses__response_id__input_items_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/openai/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
get: operations["openai_proxy_route_openai__endpoint__get"];
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
put: operations["openai_proxy_route_openai__endpoint__put"];
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
post: operations["openai_proxy_route_openai__endpoint__post"];
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
delete: operations["openai_proxy_route_openai__endpoint__delete"];
options?: never;
head?: never;
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
patch: operations["openai_proxy_route_openai__endpoint__patch"];
trace?: never;
};
"/openai_passthrough/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
get: operations["openai_proxy_route_openai_passthrough__endpoint__get"];
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
put: operations["openai_proxy_route_openai_passthrough__endpoint__put"];
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
post: operations["openai_proxy_route_openai_passthrough__endpoint__post"];
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
delete: operations["openai_proxy_route_openai_passthrough__endpoint__delete"];
options?: never;
head?: never;
/**
* Openai Proxy Route
* @description Pass-through endpoint for OpenAI API calls.
*
* Available on both routes:
* - /openai/{endpoint:path} - Standard OpenAI passthrough route
* - /openai_passthrough/{endpoint:path} - Dedicated passthrough route (recommended for Responses API)
*
* Use /openai_passthrough/* when you need guaranteed passthrough to OpenAI without conflicts
* with LiteLLM's native implementations (e.g., for the Responses API at /v1/responses).
*
* Examples:
* Standard route:
* - /openai/v1/chat/completions
* - /openai/v1/assistants
* - /openai/v1/threads
*
* Dedicated passthrough (for Responses API):
* - /openai_passthrough/v1/responses
* - /openai_passthrough/v1/responses/{response_id}
* - /openai_passthrough/v1/responses/{response_id}/input_items
*
* [Docs](https://docs.litellm.ai/docs/pass_through/openai_passthrough)
*/
patch: operations["openai_proxy_route_openai_passthrough__endpoint__patch"];
trace?: never;
};
"/organization/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Organization Daily Activity
* @description Get daily activity for specific organizations or all accessible organizations.
*/
get: operations["get_organization_daily_activity_organization_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Organization
* @description Delete an organization
*
* # Parameters:
*
* - organization_ids: List[str] - The organization ids to delete.
*/
delete: operations["delete_organization_organization_delete_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Info Organization
* @description Get the org specific information
*/
get: operations["info_organization_organization_info_get"];
put?: never;
/**
* Deprecated Info Organization
* @description DEPRECATED: Use GET /organization/info instead
*/
post: operations["deprecated_info_organization_organization_info_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Organization
* @description Get a list of organizations with optional filtering.
*
* Parameters:
* org_id: Optional[str]
* Filter organizations by exact organization_id match
* org_alias: Optional[str]
* Filter organizations by partial organization_alias match (case-insensitive)
*
* Example:
* ```
* curl --location --request GET 'http://0.0.0.0:4000/organization/list?org_alias=my-org' --header 'Authorization: Bearer sk-1234'
* ```
*
* Example with org_id:
* ```
* curl --location --request GET 'http://0.0.0.0:4000/organization/list?org_id=123e4567-e89b-12d3-a456-426614174000' --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["list_organization_organization_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/member_add": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Organization Member Add
* @description [BETA]
*
* Add new members (either via user_email or user_id) to an organization
*
* If user doesn't exist, new user row will also be added to User Table
*
* Only proxy_admin or org_admin of organization, allowed to access this endpoint.
*
* # Parameters:
*
* - organization_id: str (required)
* - member: Union[List[Member], Member] (required)
* - role: Literal[LitellmUserRoles] (required)
* - user_id: Optional[str]
* - user_email: Optional[str]
*
* Note: Either user_id or user_email must be provided for each member.
*
* Example:
* ```
* curl -X POST 'http://0.0.0.0:4000/organization/member_add' -H 'Authorization: Bearer sk-1234' -H 'Content-Type: application/json' -d '{
* "organization_id": "45e3e396-ee08-4a61-a88e-16b3ce7e0849",
* "member": {
* "role": "internal_user",
* "user_id": "krrish247652@berri.ai"
* },
* "max_budget_in_organization": 100.0
* }'
* ```
*
* The following is executed in this function:
*
* 1. Check if organization exists
* 2. Creates a new Internal User if the user_id or user_email is not found in LiteLLM_UserTable
* 3. Add Internal User to the `LiteLLM_OrganizationMembership` table
*/
post: operations["organization_member_add_organization_member_add_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/member_delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Organization Member Delete
* @description Delete a member from an organization
*/
delete: operations["organization_member_delete_organization_member_delete_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/member_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Organization Member Update
* @description Update a member's role in an organization
*/
patch: operations["organization_member_update_organization_member_update_patch"];
trace?: never;
};
"/organization/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New Organization
* @description Allow orgs to own teams
*
* Set org level budgets + model access.
*
* Only admins can create orgs.
*
* # Parameters
*
* - organization_alias: *str* - The name of the organization.
* - models: *List* - The models the organization has access to.
* - budget_id: *Optional[str]* - The id for a budget (tpm/rpm/max budget) for the organization.
* ### IF NO BUDGET ID - CREATE ONE WITH THESE PARAMS ###
* - max_budget: *Optional[float]* - Max budget for org
* - tpm_limit: *Optional[int]* - Max tpm limit for org
* - rpm_limit: *Optional[int]* - Max rpm limit for org
* - model_rpm_limit: *Optional[Dict[str, int]]* - The RPM (Requests Per Minute) limit per model for this organization.
* - model_tpm_limit: *Optional[Dict[str, int]]* - The TPM (Tokens Per Minute) limit per model for this organization.
* - max_parallel_requests: *Optional[int]* - [Not Implemented Yet] Max parallel requests for org
* - soft_budget: *Optional[float]* - [Not Implemented Yet] Get a slack alert when this soft budget is reached. Don't block requests.
* - model_max_budget: *Optional[dict]* - Max budget for a specific model
* - budget_duration: *Optional[str]* - Frequency of reseting org budget
* - metadata: *Optional[dict]* - Metadata for organization, store information for organization. Example metadata - {"extra_info": "some info"}
* - blocked: *bool* - Flag indicating if the org is blocked or not - will stop all calls from keys with this org_id.
* - tags: *Optional[List[str]]* - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing).
* - organization_id: *Optional[str]* - The organization id of the team. Default is None. Create via `/organization/new`.
* - model_aliases: Optional[dict] - Model aliases for the team. [Docs](https://docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias)
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - organization-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"]}. IF null or {} then no object permission.
* - allowed_models: Optional[List[str]] - List of models the organization is allowed to access. If not set, defaults to the models field.
* Case 1: Create new org **without** a budget_id
*
* ```bash
* curl --location 'http://0.0.0.0:4000/organization/new'
* --header 'Authorization: Bearer sk-1234'
* --header 'Content-Type: application/json'
* --data '{
* "organization_alias": "my-secret-org",
* "models": ["model1", "model2"],
* "max_budget": 100
* }'
*
*
* ```
*
* Case 2: Create new org **with** a budget_id
*
* ```bash
* curl --location 'http://0.0.0.0:4000/organization/new'
* --header 'Authorization: Bearer sk-1234'
* --header 'Content-Type: application/json'
* --data '{
* "organization_alias": "my-secret-org",
* "models": ["model1", "model2"],
* "budget_id": "428eeaa8-f3ac-4e85-a8fb-7dc8d7aa8689"
* }'
* ```
*/
post: operations["new_organization_organization_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/organization/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Organization
* @description Update an organization
*/
patch: operations["update_organization_organization_update_patch"];
trace?: never;
};
"/otel-spans": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Otel Spans */
get: operations["get_otel_spans_otel_spans_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Policy
* @description Create a new policy.
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/policies" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "policy_name": "global-baseline",
* "description": "Base guardrails for all requests",
* "guardrails_add": ["pii_masking", "prompt_injection"],
* "guardrails_remove": []
* }'
* ```
*
* Example Response:
* ```json
* {
* "policy_id": "123e4567-e89b-12d3-a456-426614174000",
* "policy_name": "global-baseline",
* "inherit": null,
* "description": "Base guardrails for all requests",
* "guardrails_add": ["pii_masking", "prompt_injection"],
* "guardrails_remove": [],
* "condition": null,
* "created_at": "2024-01-01T00:00:00Z",
* "updated_at": "2024-01-01T00:00:00Z"
* }
* ```
*/
post: operations["create_policy_policies_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/attachments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Policy Attachment
* @description Create a new policy attachment.
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/policies/attachments" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "policy_name": "global-baseline",
* "scope": "*"
* }'
* ```
*
* Example with team-specific attachment:
* ```bash
* curl -X POST "http://localhost:4000/policies/attachments" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "policy_name": "healthcare-compliance",
* "teams": ["healthcare-team", "medical-research"]
* }'
* ```
*
* Example Response:
* ```json
* {
* "attachment_id": "123e4567-e89b-12d3-a456-426614174000",
* "policy_name": "global-baseline",
* "scope": "*",
* "teams": [],
* "keys": [],
* "models": [],
* "created_at": "2024-01-01T00:00:00Z",
* "updated_at": "2024-01-01T00:00:00Z"
* }
* ```
*/
post: operations["create_policy_attachment_policies_attachments_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/attachments/estimate-impact": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Estimate Attachment Impact
* @description Estimate how many keys and teams would be affected by a policy attachment.
*
* Use this before creating an attachment to preview the blast radius.
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/policies/attachments/estimate-impact" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "policy_name": "hipaa-compliance",
* "tags": ["healthcare", "health-*"]
* }'
* ```
*/
post: operations["estimate_attachment_impact_policies_attachments_estimate_impact_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/attachments/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Policy Attachments
* @description List all policy attachments from the database.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/policies/attachments/list" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "attachments": [
* {
* "attachment_id": "123e4567-e89b-12d3-a456-426614174000",
* "policy_name": "global-baseline",
* "scope": "*",
* "teams": [],
* "keys": [],
* "models": [],
* "created_at": "2024-01-01T00:00:00Z",
* "updated_at": "2024-01-01T00:00:00Z"
* }
* ],
* "total_count": 1
* }
* ```
*/
get: operations["list_policy_attachments_policies_attachments_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/attachments/{attachment_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Policy Attachment
* @description Get a policy attachment by ID.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/policies/attachments/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*/
get: operations["get_policy_attachment_policies_attachments__attachment_id__get"];
put?: never;
post?: never;
/**
* Delete Policy Attachment
* @description Delete a policy attachment.
*
* Example Request:
* ```bash
* curl -X DELETE "http://localhost:4000/policies/attachments/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "message": "Attachment 123e4567-e89b-12d3-a456-426614174000 deleted successfully"
* }
* ```
*/
delete: operations["delete_policy_attachment_policies_attachments__attachment_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/compare": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Compare Policy Versions
* @description Compare two policy versions. Query params: version_a, version_b (policy version IDs).
*/
get: operations["compare_policy_versions_policies_compare_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Policies
* @description List all policies from the database. Optionally filter by version_status.
*
* Query params:
* - version_status: Optional. One of "draft", "published", "production".
* If omitted, all versions are returned.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/policies/list" \
* -H "Authorization: Bearer <your_api_key>"
* curl -X GET "http://localhost:4000/policies/list?version_status=production" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "policies": [
* {
* "policy_id": "123e4567-e89b-12d3-a456-426614174000",
* "policy_name": "global-baseline",
* "version_number": 1,
* "version_status": "production",
* "inherit": null,
* "description": "Base guardrails for all requests",
* "guardrails_add": ["pii_masking"],
* "guardrails_remove": [],
* "condition": null,
* "created_at": "2024-01-01T00:00:00Z",
* "updated_at": "2024-01-01T00:00:00Z"
* }
* ],
* "total_count": 1
* }
* ```
*/
get: operations["list_policies_policies_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/name/{policy_name}/all-versions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete All Policy Versions
* @description Delete all versions of a policy. Also removes from in-memory registry.
*/
delete: operations["delete_all_policy_versions_policies_name__policy_name__all_versions_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/name/{policy_name}/versions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Policy Versions
* @description List all versions of a policy by name, ordered by version_number descending.
*/
get: operations["list_policy_versions_policies_name__policy_name__versions_get"];
put?: never;
/**
* Create Policy Version
* @description Create a new draft version of a policy. Copies all fields from the source.
* Source is current production if source_policy_id is not provided.
*/
post: operations["create_policy_version_policies_name__policy_name__versions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/resolve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Resolve Policies For Context
* @description Resolve which policies and guardrails apply for a given context.
*
* Use this endpoint to debug "what guardrails would apply to a request
* with this team/key/model/tags combination?"
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/policies/resolve" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "tags": ["healthcare"],
* "model": "gpt-4"
* }'
* ```
*/
post: operations["resolve_policies_for_context_policies_resolve_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/test-pipeline": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Pipeline
* @description Test a guardrail pipeline with sample messages.
*
* Executes the pipeline steps against the provided test messages and returns
* step-by-step results showing which guardrails passed/failed, actions taken,
* and timing information.
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/policies/test-pipeline" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "pipeline": {
* "mode": "pre_call",
* "steps": [
* {"guardrail": "pii-guard", "on_pass": "next", "on_fail": "block"}
* ]
* },
* "test_messages": [{"role": "user", "content": "My SSN is 123-45-6789"}]
* }'
* ```
*/
post: operations["test_pipeline_policies_test_pipeline_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/usage/overview": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Policies Usage Overview
* @description Return policy performance overview for the dashboard.
*/
get: operations["policies_usage_overview_policies_usage_overview_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/{policy_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Policy
* @description Get a policy by ID.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/policies/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*/
get: operations["get_policy_policies__policy_id__get"];
/**
* Update Policy
* @description Update an existing policy.
*
* Example Request:
* ```bash
* curl -X PUT "http://localhost:4000/policies/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "description": "Updated description",
* "guardrails_add": ["pii_masking", "toxicity_filter"]
* }'
* ```
*/
put: operations["update_policy_policies__policy_id__put"];
post?: never;
/**
* Delete Policy
* @description Delete a policy.
*
* Example Request:
* ```bash
* curl -X DELETE "http://localhost:4000/policies/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "message": "Policy 123e4567-e89b-12d3-a456-426614174000 deleted successfully"
* }
* ```
*/
delete: operations["delete_policy_policies__policy_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/{policy_id}/resolved-guardrails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Resolved Guardrails
* @description Get the resolved guardrails for a policy (including inherited guardrails).
*
* This endpoint resolves the full inheritance chain and returns the final
* set of guardrails that would be applied for this policy.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/policies/123e4567-e89b-12d3-a456-426614174000/resolved-guardrails" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "policy_id": "123e4567-e89b-12d3-a456-426614174000",
* "policy_name": "healthcare-compliance",
* "resolved_guardrails": ["pii_masking", "prompt_injection", "toxicity_filter"]
* }
* ```
*/
get: operations["get_resolved_guardrails_policies__policy_id__resolved_guardrails_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policies/{policy_id}/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update Policy Version Status
* @description Update a policy version's status. Valid transitions:
* - draft -> published
* - published -> production (demotes current production to published)
* - production -> published (demotes, policy becomes inactive)
*/
put: operations["update_policy_version_status_policies__policy_id__status_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/info/{policy_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Policy Info
* @description Get detailed information about a specific policy.
*
* Returns:
* - Policy configuration
* - Resolved guardrails (after inheritance)
* - Inheritance chain
*/
get: operations["get_policy_info_policy_info__policy_name__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Policies
* @description List all loaded policies with their resolved guardrails.
*
* Returns information about each policy including:
* - Inheritance configuration
* - Scope (teams, keys, models)
* - Guardrails to add/remove
* - Resolved guardrails (after inheritance)
* - Inheritance chain
*/
get: operations["list_policies_policy_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Policy Templates
* @description Get policy templates for the UI (pre-configured guardrail combinations).
*
* Fetches from GitHub with automatic fallback to local backup on failure.
* Set LITELLM_LOCAL_POLICY_TEMPLATES=true to skip GitHub and use local backup only.
*/
get: operations["get_policy_templates_policy_templates_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/templates/enrich": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Enrich Policy Template
* @description Enrich a policy template with LLM-discovered data (e.g. competitor names).
*
* Calls an onboarded LLM to discover competitors for the given brand name,
* then returns enriched guardrailDefinitions with the discovered data populated.
*/
post: operations["enrich_policy_template_policy_templates_enrich_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/templates/enrich/stream": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Enrich Policy Template Stream
* @description Stream competitor names as SSE events as the LLM generates them.
*
* Events:
* - data: {"type": "competitor", "name": "..."} — each competitor as discovered
* - data: {"type": "done", "competitors": [...], "competitor_variations": {...}, "guardrailDefinitions": [...]}
*/
post: operations["enrich_policy_template_stream_policy_templates_enrich_stream_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/templates/suggest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Suggest Policy Templates
* @description Use AI to suggest policy templates based on attack examples and descriptions.
*
* Calls an LLM with tool calling to match user requirements to available templates.
*/
post: operations["suggest_policy_templates_policy_templates_suggest_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/templates/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Policy Template
* @description Test a policy template's guardrails against a text input without creating them.
*
* Instantiates temporary guardrails from the template definitions, runs them
* against the provided text, and returns per-guardrail results so users can
* verify the template solves their problem before creating it.
*/
post: operations["test_policy_template_policy_templates_test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Policy Matching
* @description Test which policies would match a given request context.
*
* This is useful for debugging and understanding policy behavior.
*
* Request body:
* ```json
* {
* "team_alias": "healthcare-team",
* "key_alias": "my-api-key",
* "model": "gpt-4"
* }
* ```
*
* Returns:
* - matching_policies: List of policy names that match
* - resolved_guardrails: Final list of guardrails that would be applied
*/
post: operations["test_policy_matching_policy_test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/policy/validate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Validate Policy
* @description Validate a policy configuration before applying it.
*
* Checks:
* - All referenced guardrails exist in the guardrail registry
* - All non-wildcard team aliases exist in the database
* - All non-wildcard key aliases exist in the database
* - Inheritance chains are valid (no cycles, parents exist)
* - Scope patterns are syntactically valid
*
* Returns:
* - valid: True if the policy configuration is valid (no blocking errors)
* - errors: List of blocking validation errors
* - warnings: List of non-blocking validation warnings
*
* Example request:
* ```json
* {
* "policies": {
* "global-baseline": {
* "guardrails": {
* "add": ["pii_blocker", "phi_blocker"]
* },
* "scope": {
* "teams": ["*"],
* "keys": ["*"],
* "models": ["*"]
* }
* },
* "healthcare-compliance": {
* "inherit": "global-baseline",
* "guardrails": {
* "add": ["hipaa_audit"]
* },
* "scope": {
* "teams": ["healthcare-team"]
* }
* }
* }
* }
* ```
*/
post: operations["validate_policy_policy_validate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/project/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Project
* @description Delete projects
*
* Parameters:
* - project_ids: *List[str]* - List of project ids to delete
*
* Example:
* ```bash
* curl --location --request DELETE 'http://0.0.0.0:4000/project/delete' \
* --header 'Authorization: Bearer sk-1234' \
* --header 'Content-Type: application/json' \
* --data '{
* "project_ids": ["project-123", "project-456"]
* }'
* ```
*/
delete: operations["delete_project_project_delete_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/project/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Project Info
* @description Get information about a specific project
*
* Parameters:
* - project_id: *str* - The project id to fetch info for
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/project/info?project_id=project-123' \
* --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["project_info_project_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/project/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Projects
* @description List all projects that the user has access to
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/project/list' \
* --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["list_projects_project_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/project/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New Project
* @description Create a new project. Projects sit between teams and keys in the hierarchy.
*
* Only admins or team admins can create projects.
*
* # Parameters
*
* - project_alias: *Optional[str]* - The name of the project.
* - description: *Optional[str]* - Description of the project's purpose and use case.
* - team_id: *str* - The team id that this project belongs to. Required.
* - models: *List* - The models the project has access to.
* - budget_id: *Optional[str]* - The id for a budget (tpm/rpm/max budget) for the project.
* ### IF NO BUDGET ID - CREATE ONE WITH THESE PARAMS ###
* - max_budget: *Optional[float]* - Max budget for project
* - tpm_limit: *Optional[int]* - Max tpm limit for project
* - rpm_limit: *Optional[int]* - Max rpm limit for project
* - max_parallel_requests: *Optional[int]* - Max parallel requests for project
* - soft_budget: *Optional[float]* - Get a slack alert when this soft budget is reached. Don't block requests.
* - model_max_budget: *Optional[dict]* - Max budget for a specific model. Example: {"gpt-4": 100.0, "gpt-3.5-turbo": 50.0}
* - model_rpm_limit: *Optional[dict]* - RPM limits per model. Example: {"gpt-4": 1000, "gpt-3.5-turbo": 5000}
* - model_tpm_limit: *Optional[dict]* - TPM limits per model. Example: {"gpt-4": 50000, "gpt-3.5-turbo": 100000}
* - budget_duration: *Optional[str]* - Frequency of reseting project budget
* - metadata: *Optional[dict]* - Metadata for project, store information for project. Example metadata - {"use_case_id": "SNOW-12345", "responsible_ai_id": "RAI-67890"}
* - tags: *Optional[list]* - Tags for the project. Example: ["production", "api"]
* - blocked: *bool* - Flag indicating if the project is blocked or not - will stop all calls from keys with this project_id.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - project-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"]}. IF null or {} then no object permission.
*
* Example 1: Create new project **without** a budget_id, with model-specific limits
*
* ```bash
* curl --location 'http://0.0.0.0:4000/project/new' \
* --header 'Authorization: Bearer sk-1234' \
* --header 'Content-Type: application/json' \
* --data '{
* "project_alias": "flight-search-assistant",
* "description": "AI-powered flight search and booking assistant",
* "team_id": "team-123",
* "models": ["gpt-4", "gpt-3.5-turbo"],
* "max_budget": 100,
* "model_rpm_limit": {
* "gpt-4": 1000,
* "gpt-3.5-turbo": 5000
* },
* "model_tpm_limit": {
* "gpt-4": 50000,
* "gpt-3.5-turbo": 100000
* },
* "metadata": {
* "use_case_id": "SNOW-12345",
* "responsible_ai_id": "RAI-67890"
* }
* }'
* ```
*
* Example 2: Create new project **with** a budget_id
*
* ```bash
* curl --location 'http://0.0.0.0:4000/project/new' \
* --header 'Authorization: Bearer sk-1234' \
* --header 'Content-Type: application/json' \
* --data '{
* "project_alias": "hotel-recommendations",
* "description": "Personalized hotel recommendation engine",
* "team_id": "team-123",
* "models": ["claude-3-sonnet"],
* "budget_id": "428eeaa8-f3ac-4e85-a8fb-7dc8d7aa8689",
* "metadata": {
* "use_case_id": "SNOW-54321"
* }
* }'
* ```
*/
post: operations["new_project_project_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/project/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Project
* @description Update a project
*
* Parameters:
* - project_id: *str* - The project id to update. Required.
* - project_alias: *Optional[str]* - Updated name for the project
* - description: *Optional[str]* - Updated description for the project
* - team_id: *Optional[str]* - Updated team_id for the project
* - metadata: *Optional[dict]* - Updated metadata for project
* - models: *Optional[list]* - Updated list of models for the project
* - blocked: *Optional[bool]* - Updated blocked status
* - max_budget: *Optional[float]* - Updated max budget
* - tpm_limit: *Optional[int]* - Updated tpm limit
* - rpm_limit: *Optional[int]* - Updated rpm limit
* - model_rpm_limit: *Optional[dict]* - Updated RPM limits per model
* - model_tpm_limit: *Optional[dict]* - Updated TPM limits per model
* - budget_duration: *Optional[str]* - Updated budget duration
* - tags: *Optional[list]* - Updated list of tags for the project
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - Updated object permission
*
* Example:
* ```bash
* curl --location 'http://0.0.0.0:4000/project/update' \
* --header 'Authorization: Bearer sk-1234' \
* --header 'Content-Type: application/json' \
* --data '{
* "project_id": "project-123",
* "description": "Updated flight search system with enhanced capabilities",
* "max_budget": 200,
* "model_rpm_limit": {
* "gpt-4": 2000,
* "gpt-3.5-turbo": 10000
* },
* "metadata": {
* "use_case_id": "SNOW-12345",
* "status": "active"
* }
* }'
* ```
*/
post: operations["update_project_project_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/prompts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Prompt
* @description Create a new prompt
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/prompts" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "prompt_id": "my_prompt",
* "litellm_params": {
* "prompt_id": "json_prompt",
* "prompt_integration": "dotprompt",
* ### EITHER prompt_directory OR prompt_data MUST BE PROVIDED
* "prompt_directory": "/path/to/dotprompt/folder",
* "prompt_data": {"json_prompt": {"content": "This is a prompt", "metadata": {"model": "gpt-4"}}}
* },
* "prompt_info": {
* "prompt_type": "config"
* }
* }'
* ```
*/
post: operations["create_prompt_prompts_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/prompts/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Prompts
* @description List the prompts that are available on the proxy server
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/prompts/list" -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "prompts": [
* {
* "prompt_id": "my_prompt_id",
* "litellm_params": {
* "prompt_id": "my_prompt_id",
* "prompt_integration": "dotprompt",
* "prompt_directory": "/path/to/prompts"
* },
* "prompt_info": {
* "prompt_type": "config"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* }
* ]
* }
* ```
*/
get: operations["list_prompts_prompts_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/prompts/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Prompt
* @description Test a prompt by rendering it with variables and executing an LLM call.
*
* This endpoint allows testing prompts before saving them to the database.
* The response is always streamed.
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/prompts/test" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "dotprompt_content": "---\nmodel: gpt-4o\ntemperature: 0.7\n---\n\nUser: Hello {{name}}",
* "prompt_variables": {
* "name": "World"
* }
* }'
* ```
*/
post: operations["test_prompt_prompts_test_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/prompts/{prompt_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Prompt Info
* @description Get detailed information about a specific prompt by ID, including prompt content
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/prompts/my_prompt_id/info" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "prompt_id": "my_prompt_id",
* "litellm_params": {
* "prompt_id": "my_prompt_id",
* "prompt_integration": "dotprompt",
* "prompt_directory": "/path/to/prompts"
* },
* "prompt_info": {
* "prompt_type": "config"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z",
* "content": "System: You are a helpful assistant.
*
* User: {{user_message}}"
* }
* ```
*/
get: operations["get_prompt_info_prompts__prompt_id__get"];
/**
* Update Prompt
* @description Update an existing prompt
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X PUT "http://localhost:4000/prompts/my_prompt_id" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "prompt_id": "my_prompt",
* "litellm_params": {
* "prompt_id": "my_prompt",
* "prompt_integration": "dotprompt",
* "prompt_directory": "/path/to/prompts"
* },
* "prompt_info": {
* "prompt_type": "config"
* }
* }
* }'
* ```
*/
put: operations["update_prompt_prompts__prompt_id__put"];
post?: never;
/**
* Delete Prompt
* @description Delete a prompt
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X DELETE "http://localhost:4000/prompts/my_prompt_id" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "message": "Prompt my_prompt_id deleted successfully"
* }
* ```
*/
delete: operations["delete_prompt_prompts__prompt_id__delete"];
options?: never;
head?: never;
/**
* Patch Prompt
* @description Partially update an existing prompt
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* This endpoint allows updating specific fields of a prompt without sending the entire object.
* Only the following fields can be updated:
* - litellm_params: LiteLLM parameters for the prompt
* - prompt_info: Additional information about the prompt
*
* Example Request:
* ```bash
* curl -X PATCH "http://localhost:4000/prompts/my_prompt_id" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "prompt_info": {
* "prompt_type": "db"
* }
* }'
* ```
*/
patch: operations["patch_prompt_prompts__prompt_id__patch"];
trace?: never;
};
"/prompts/{prompt_id}/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Prompt Info
* @description Get detailed information about a specific prompt by ID, including prompt content
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/prompts/my_prompt_id/info" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "prompt_id": "my_prompt_id",
* "litellm_params": {
* "prompt_id": "my_prompt_id",
* "prompt_integration": "dotprompt",
* "prompt_directory": "/path/to/prompts"
* },
* "prompt_info": {
* "prompt_type": "config"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z",
* "content": "System: You are a helpful assistant.
*
* User: {{user_message}}"
* }
* ```
*/
get: operations["get_prompt_info_prompts__prompt_id__info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/prompts/{prompt_id}/versions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Prompt Versions
* @description Get all versions of a specific prompt by base prompt ID
*
* 👉 [Prompt docs](https://docs.litellm.ai/docs/proxy/prompt_management)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/prompts/jack_success/versions" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "prompts": [
* {
* "prompt_id": "jack_success.v1",
* "litellm_params": {...},
* "prompt_info": {"prompt_type": "db"},
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* },
* {
* "prompt_id": "jack_success.v2",
* "litellm_params": {...},
* "prompt_info": {"prompt_type": "db"},
* "created_at": "2023-11-09T13:45:12.345Z",
* "updated_at": "2023-11-09T13:45:12.345Z"
* }
* ]
* }
* ```
*/
get: operations["get_prompt_versions_prompts__prompt_id__versions_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/provider/budgets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Provider Budgets
* @description Provider Budget Routing - Get Budget, Spend Details https://docs.litellm.ai/docs/proxy/provider_budget_routing
*
* Use this endpoint to check current budget, spend and budget reset time for a provider
*
* Example Request
*
* ```bash
* curl -X GET http://localhost:4000/provider/budgets -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234"
* ```
*
* Example Response
*
* ```json
* {
* "providers": {
* "openai": {
* "budget_limit": 1e-12,
* "time_period": "1d",
* "spend": 0.0,
* "budget_reset_at": null
* },
* "azure": {
* "budget_limit": 100.0,
* "time_period": "1d",
* "spend": 0.0,
* "budget_reset_at": null
* },
* "anthropic": {
* "budget_limit": 100.0,
* "time_period": "10d",
* "spend": 0.0,
* "budget_reset_at": null
* },
* "vertex_ai": {
* "budget_limit": 100.0,
* "time_period": "12d",
* "spend": 0.0,
* "budget_reset_at": null
* }
* }
* }
* ```
*/
get: operations["provider_budgets_provider_budgets_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/agent_hub": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Agents */
get: operations["get_agents_public_agent_hub_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/agents/fields": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent Fields
* @description Return agent type metadata required by the dashboard create-agent flow.
*
* If an agent has `inherit_credentials_from_provider`, the provider's credential
* fields are automatically appended to the agent's credential_fields.
*/
get: operations["get_agent_fields_public_agents_fields_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/endpoints": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Endpoints
* @description Return the list of LiteLLM proxy endpoints and which providers support each one.
*
* Reads from the bundled local backup file. Result is cached in-process for
* the lifetime of the server process.
*/
get: operations["get_supported_endpoints_public_endpoints_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/litellm_blog_posts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Litellm Blog Posts
* @description Public endpoint to get the latest LiteLLM blog posts.
*
* Fetches from GitHub with a 1-hour in-process cache.
* Falls back to the bundled local backup on any failure.
*/
get: operations["get_litellm_blog_posts_public_litellm_blog_posts_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/litellm_model_cost_map": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Litellm Model Cost Map
* @description Public endpoint to get the LiteLLM model cost map.
* Returns pricing information for all supported models.
*/
get: operations["get_litellm_model_cost_map_public_litellm_model_cost_map_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/mcp_hub": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Mcp Servers */
get: operations["get_mcp_servers_public_mcp_hub_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/model_hub": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Public Model Hub */
get: operations["public_model_hub_public_model_hub_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/model_hub/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Public Model Hub Info */
get: operations["public_model_hub_info_public_model_hub_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/providers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Supported Providers
* @description Return a sorted list of all providers supported by LiteLLM.
*/
get: operations["get_supported_providers_public_providers_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/providers/fields": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Provider Fields
* @description Return provider metadata required by the dashboard create-model flow.
*/
get: operations["get_provider_fields_public_providers_fields_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/public/skill_hub": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Public Skill Hub
* @description Return enabled (public) Claude Code skills — no auth required.
*/
get: operations["public_skill_hub_public_skill_hub_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/queue/chat/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Async Queue Request */
post: operations["async_queue_request_queue_chat_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/rag/ingest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Rag Ingest
* @description RAG Ingest endpoint - all-in-one document ingestion pipeline.
*
* Supports form upload (for files) or JSON body (for URLs).
*
* ## Form upload (for files):
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/ingest" \
* -H "Authorization: Bearer sk-1234" \
* -F file="@document.pdf" \
* -F 'ingest_options={"vector_store": {"custom_llm_provider": "openai"}}'
* ```
*
* ## JSON body (for URLs):
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/ingest" \
* -H "Authorization: Bearer sk-1234" \
* -H "Content-Type: application/json" \
* -d '{
* "file_url": "https://example.com/document.pdf",
* "ingest_options": {"vector_store": {"custom_llm_provider": "openai"}}
* }'
* ```
*
* ## Bedrock:
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/ingest" \
* -H "Authorization: Bearer sk-1234" \
* -F file="@document.pdf" \
* -F 'ingest_options={"vector_store": {"custom_llm_provider": "bedrock"}}'
* ```
*/
post: operations["rag_ingest_rag_ingest_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/rag/query": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Rag Query
* @description RAG Query endpoint - search vector store, optionally rerank, and generate LLM response.
*
* This endpoint:
* 1. Extracts the query from the last user message
* 2. Searches the vector store for relevant context
* 3. Optionally reranks the results
* 4. Generates an LLM response with the retrieved context
*
* ## Example Request:
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/query" \
* -H "Authorization: Bearer sk-1234" \
* -H "Content-Type: application/json" \
* -d '{
* "model": "gpt-4o-mini",
* "messages": [{"role": "user", "content": "What is LiteLLM?"}],
* "retrieval_config": {
* "vector_store_id": "vs_abc123",
* "custom_llm_provider": "openai",
* "top_k": 5
* }
* }'
* ```
*
* ## With Reranking:
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/query" \
* -H "Authorization: Bearer sk-1234" \
* -H "Content-Type: application/json" \
* -d '{
* "model": "gpt-4o-mini",
* "messages": [{"role": "user", "content": "What is LiteLLM?"}],
* "retrieval_config": {
* "vector_store_id": "vs_abc123",
* "custom_llm_provider": "openai",
* "top_k": 10
* },
* "rerank": {
* "enabled": true,
* "model": "cohere/rerank-english-v3.0",
* "top_n": 3
* }
* }'
* ```
*/
post: operations["rag_query_rag_query_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/realtime": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* WebSocket: realtime_websocket_endpoint
* @description WebSocket connection endpoint
*/
get: operations["websocket_realtime_websocket_endpoint_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/realtime/calls": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Proxy Realtime Calls */
post: operations["proxy_realtime_calls_realtime_calls_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/realtime/client_secrets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Realtime Client Secret */
post: operations["create_realtime_client_secret_realtime_client_secrets_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reload/anthropic_beta_headers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reload Anthropic Beta Headers
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Manually reload the Anthropic beta headers configuration from the remote source.
* This will fetch fresh configuration from the anthropic_beta_headers_config.json file.
*/
post: operations["reload_anthropic_beta_headers_reload_anthropic_beta_headers_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reload/model_cost_map": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Reload Model Cost Map
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Manually reload the model cost map from the remote source.
* This will fetch fresh pricing data from the model_prices_and_context_window.json file.
*/
post: operations["reload_model_cost_map_reload_model_cost_map_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/rerank": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Rerank */
post: operations["rerank_rerank_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/responses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* WebSocket: responses_websocket_endpoint
* @description WebSocket connection endpoint
*/
get: operations["websocket_responses_websocket_endpoint_get"];
put?: never;
/**
* Responses Api
* @description Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses
*
* Supports background mode with polling_via_cache for partial response retrieval.
* When background=true and polling_via_cache is enabled, returns a polling_id immediately
* and streams the response in the background, updating Redis cache.
*
* ```bash
* # Normal request
* curl -X POST http://localhost:4000/v1/responses -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": "Tell me about AI"
* }'
*
* # Background request with polling
* curl -X POST http://localhost:4000/v1/responses -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": "Tell me about AI",
* "background": true
* }'
* ```
*/
post: operations["responses_api_responses_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/responses/compact": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Compact Response
* @description Compact a response by running a compaction pass over a conversation.
*
* Returns encrypted, opaque items that can be used to reduce context size.
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/compact
*
* ```bash
* curl -X POST http://localhost:4000/v1/responses/compact -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": [{"role": "user", "content": "Hello"}]
* }'
* ```
*/
post: operations["compact_response_responses_compact_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/responses/{response_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Response
* @description Get a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Returns cumulative cached content from background responses
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/get
*
* ```bash
* # Get polling response
* curl -X GET http://localhost:4000/v1/responses/litellm_poll_abc123 -H "Authorization: Bearer sk-1234"
*
* # Get provider response
* curl -X GET http://localhost:4000/v1/responses/resp_abc123 -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["get_response_responses__response_id__get"];
put?: never;
post?: never;
/**
* Delete Response
* @description Delete a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Deletes from Redis cache
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/delete
*
* ```bash
* curl -X DELETE http://localhost:4000/v1/responses/resp_abc123 -H "Authorization: Bearer sk-1234"
* ```
*/
delete: operations["delete_response_responses__response_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/responses/{response_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Response
* @description Cancel a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Cancels background response and updates status in Redis
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/cancel
*
* ```bash
* # Cancel polling response
* curl -X POST http://localhost:4000/v1/responses/litellm_poll_abc123/cancel -H "Authorization: Bearer sk-1234"
*
* # Cancel provider response
* curl -X POST http://localhost:4000/v1/responses/resp_abc123/cancel -H "Authorization: Bearer sk-1234"
* ```
*/
post: operations["cancel_response_responses__response_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/responses/{response_id}/input_items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Response Input Items
* @description List input items for a response.
*/
get: operations["get_response_input_items_responses__response_id__input_items_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/robots.txt": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Robots
* @description Block all web crawlers from indexing the proxy server endpoints
* This is useful for ensuring that the API endpoints aren't indexed by search engines
*/
get: operations["get_robots_robots_txt_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/router/fields": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Router Fields
* @description Get router settings field definitions without values.
*
* Returns only the field metadata (type, description, default, options) without
* populating field_value. This is useful for UI components that need to know
* what fields to render, but will get the actual values from a different endpoint.
*
* Returns:
* - fields: List of all configurable router settings with their metadata (type, description, default, options)
* The routing_strategy field includes available options extracted from the Router class
* Note: field_value will be None for all fields
* - routing_strategy_descriptions: Descriptions for each routing strategy option
*/
get: operations["get_router_fields_router_fields_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/router/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Router Settings
* @description Get router configuration and available settings.
*
* Returns:
* - fields: List of all configurable router settings with their metadata (type, description, default, options)
* The routing_strategy field includes available options extracted from the Router class
* - current_values: Current values of router settings from config
*/
get: operations["get_router_settings_router_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/routes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Routes
* @description Get a list of available routes in the FastAPI application.
*/
get: operations["get_routes_routes_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/schedule/anthropic_beta_headers_reload": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Schedule Anthropic Beta Headers Reload
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Schedule periodic reload of the Anthropic beta headers configuration.
* This will create a background job that reloads the configuration every specified hours.
*/
post: operations["schedule_anthropic_beta_headers_reload_schedule_anthropic_beta_headers_reload_post"];
/**
* Cancel Anthropic Beta Headers Reload
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Cancel the scheduled periodic reload of the Anthropic beta headers configuration.
*/
delete: operations["cancel_anthropic_beta_headers_reload_schedule_anthropic_beta_headers_reload_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/schedule/anthropic_beta_headers_reload/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Anthropic Beta Headers Reload Status
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Get the status of the scheduled Anthropic beta headers reload job.
*/
get: operations["get_anthropic_beta_headers_reload_status_schedule_anthropic_beta_headers_reload_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/schedule/model_cost_map_reload": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Schedule Model Cost Map Reload
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Schedule periodic reload of the model cost map.
* This will create a background job that reloads the model cost map every specified hours.
*/
post: operations["schedule_model_cost_map_reload_schedule_model_cost_map_reload_post"];
/**
* Cancel Model Cost Map Reload
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Cancel the scheduled periodic reload of the model cost map.
*/
delete: operations["cancel_model_cost_map_reload_schedule_model_cost_map_reload_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/schedule/model_cost_map_reload/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Model Cost Map Reload Status
* @description ADMIN ONLY / MASTER KEY Only Endpoint
*
* Get the status of the scheduled model cost map reload job.
*/
get: operations["get_model_cost_map_reload_status_schedule_model_cost_map_reload_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Scim Base
* @description Base SCIM v2 endpoint for resource discovery per RFC 7644 Section 4.
*
* Returns a ListResponse of ResourceTypes supported by this SCIM service provider.
* Identity providers (Okta, Azure AD, etc.) use this endpoint for resource discovery.
*/
get: operations["get_scim_base_scim_v2_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/Groups": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Groups
* @description Get a list of groups according to SCIM v2 protocol
*/
get: operations["get_groups_scim_v2_Groups_get"];
put?: never;
/**
* Create Group
* @description Create a group according to SCIM v2 protocol
*/
post: operations["create_group_scim_v2_Groups_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/Groups/{group_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Group
* @description Get a single group by ID according to SCIM v2 protocol
*/
get: operations["get_group_scim_v2_Groups__group_id__get"];
/**
* Update Group
* @description Update a group according to SCIM v2 protocol
*/
put: operations["update_group_scim_v2_Groups__group_id__put"];
post?: never;
/**
* Delete Group
* @description Delete a group according to SCIM v2 protocol
*/
delete: operations["delete_group_scim_v2_Groups__group_id__delete"];
options?: never;
head?: never;
/**
* Patch Group
* @description Patch a group according to SCIM v2 protocol
*/
patch: operations["patch_group_scim_v2_Groups__group_id__patch"];
trace?: never;
};
"/scim/v2/ResourceTypes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Resource Types
* @description SCIM ResourceTypes endpoint per RFC 7644 Section 4.
*
* Returns a ListResponse of all resource types supported by this service provider.
*/
get: operations["get_resource_types_scim_v2_ResourceTypes_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/ResourceTypes/{resource_type_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Resource Type
* @description Get a single ResourceType by ID per RFC 7644.
*/
get: operations["get_resource_type_scim_v2_ResourceTypes__resource_type_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/Schemas": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Schemas
* @description SCIM Schemas endpoint per RFC 7643 Section 7.
*
* Returns a ListResponse of all schemas supported by this service provider.
*/
get: operations["get_schemas_scim_v2_Schemas_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/Schemas/{schema_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Schema
* @description Get a single Schema by its URI per RFC 7643 Section 7.
*/
get: operations["get_schema_scim_v2_Schemas__schema_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/ServiceProviderConfig": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Service Provider Config
* @description Return SCIM Service Provider Configuration.
*/
get: operations["get_service_provider_config_scim_v2_ServiceProviderConfig_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/Users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Users
* @description Get a list of users according to SCIM v2 protocol
*/
get: operations["get_users_scim_v2_Users_get"];
put?: never;
/**
* Create User
* @description Create a user according to SCIM v2 protocol
*/
post: operations["create_user_scim_v2_Users_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/scim/v2/Users/{user_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get User
* @description Get a single user by ID according to SCIM v2 protocol
*/
get: operations["get_user_scim_v2_Users__user_id__get"];
/**
* Update User
* @description Update a user according to SCIM v2 protocol (full replacement)
*/
put: operations["update_user_scim_v2_Users__user_id__put"];
post?: never;
/**
* Delete User
* @description Delete a user according to SCIM v2 protocol
*/
delete: operations["delete_user_scim_v2_Users__user_id__delete"];
options?: never;
head?: never;
/**
* Patch User
* @description Patch a user according to SCIM v2 protocol
*/
patch: operations["patch_user_scim_v2_Users__user_id__patch"];
trace?: never;
};
"/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search
* @description Search endpoint for performing web searches.
*
* Follows the Perplexity Search API spec:
* https://docs.perplexity.ai/api-reference/search-post
*
* The search_tool_name can be passed either:
* 1. In the URL path: /v1/search/{search_tool_name}
* 2. In the request body: {"search_tool_name": "..."}
*
* Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible):
* ```bash
* curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Example with search_tool_name in body:
* ```bash
* curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "search_tool_name": "litellm-search",
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Request Body Parameters (when search_tool_name not in URL):
* - search_tool_name (str, required if not in URL): Name of the search tool configured in router
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* When using URL path parameter, only Perplexity-compatible parameters are needed in body:
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* Response follows Perplexity Search API format:
* ```json
* {
* "object": "search",
* "results": [
* {
* "title": "Result title",
* "url": "https://example.com",
* "snippet": "Result snippet...",
* "date": "2024-01-01",
* "last_updated": "2024-01-01"
* }
* ]
* }
* ```
*/
post: operations["search_search_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search/tools": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Search Tools
* @description List all available search tools configured in the router.
*
* This endpoint returns the search tools that are currently loaded and available
* for use with the /v1/search endpoint.
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/search/tools" -H "Authorization: Bearer sk-1234"
* ```
*
* Response:
* ```json
* {
* "object": "list",
* "data": [
* {
* "search_tool_name": "litellm-search",
* "search_provider": "perplexity",
* "description": "Perplexity search tool"
* }
* ]
* }
* ```
*/
get: operations["list_search_tools_search_tools_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search/{search_tool_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search
* @description Search endpoint for performing web searches.
*
* Follows the Perplexity Search API spec:
* https://docs.perplexity.ai/api-reference/search-post
*
* The search_tool_name can be passed either:
* 1. In the URL path: /v1/search/{search_tool_name}
* 2. In the request body: {"search_tool_name": "..."}
*
* Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible):
* ```bash
* curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Example with search_tool_name in body:
* ```bash
* curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "search_tool_name": "litellm-search",
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Request Body Parameters (when search_tool_name not in URL):
* - search_tool_name (str, required if not in URL): Name of the search tool configured in router
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* When using URL path parameter, only Perplexity-compatible parameters are needed in body:
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* Response follows Perplexity Search API format:
* ```json
* {
* "object": "search",
* "results": [
* {
* "title": "Result title",
* "url": "https://example.com",
* "snippet": "Result snippet...",
* "date": "2024-01-01",
* "last_updated": "2024-01-01"
* }
* ]
* }
* ```
*/
post: operations["search_search__search_tool_name__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search_tools": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Search Tool
* @description Create a new search tool.
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/search_tools" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "search_tool": {
* "search_tool_name": "litellm-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-..."
* },
* "search_tool_info": {
* "description": "Perplexity search tool"
* }
* }
* }'
* ```
*
* Example Response:
* ```json
* {
* "search_tool_id": "123e4567-e89b-12d3-a456-426614174000",
* "search_tool_name": "litellm-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-..."
* },
* "search_tool_info": {
* "description": "Perplexity search tool"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* }
* ```
*/
post: operations["create_search_tool_search_tools_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search_tools/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Search Tools
* @description List all search tools that are available in the database and config file.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/search_tools/list" -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "search_tools": [
* {
* "search_tool_id": "123e4567-e89b-12d3-a456-426614174000",
* "search_tool_name": "litellm-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-***",
* "api_base": "https://api.perplexity.ai"
* },
* "search_tool_info": {
* "description": "Perplexity search tool"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z",
* "is_from_config": false
* },
* {
* "search_tool_name": "config-search-tool",
* "litellm_params": {
* "search_provider": "tavily",
* "api_key": "tvly-***"
* },
* "is_from_config": true
* }
* ]
* }
* ```
*/
get: operations["list_search_tools_search_tools_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search_tools/test_connection": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Search Tool Connection
* @description Test connection to a search provider with the given configuration.
*
* Makes a simple test search query to verify the API key and configuration are valid.
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/search_tools/test_connection" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-..."
* }
* }'
* ```
*
* Example Response (Success):
* ```json
* {
* "status": "success",
* "message": "Successfully connected to perplexity search provider",
* "test_query": "test",
* "results_count": 5
* }
* ```
*
* Example Response (Failure):
* ```json
* {
* "status": "error",
* "message": "Authentication failed: Invalid API key",
* "error_type": "AuthenticationError"
* }
* ```
*/
post: operations["test_search_tool_connection_search_tools_test_connection_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search_tools/ui/available_providers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Available Search Providers
* @description Get the list of available search providers with their configuration fields.
*
* Auto-discovers search providers and their UI-friendly names from transformation configs.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/search_tools/ui/available_providers" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "providers": [
* {
* "provider_name": "perplexity",
* "ui_friendly_name": "Perplexity"
* },
* {
* "provider_name": "tavily",
* "ui_friendly_name": "Tavily"
* }
* ]
* }
* ```
*/
get: operations["get_available_search_providers_search_tools_ui_available_providers_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/search_tools/{search_tool_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Search Tool Info
* @description Get detailed information about a specific search tool by ID.
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/search_tools/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "search_tool_id": "123e4567-e89b-12d3-a456-426614174000",
* "search_tool_name": "litellm-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-***"
* },
* "search_tool_info": {
* "description": "Perplexity search tool"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T12:34:56.789Z"
* }
* ```
*/
get: operations["get_search_tool_info_search_tools__search_tool_id__get"];
/**
* Update Search Tool
* @description Update an existing search tool.
*
* Example Request:
* ```bash
* curl -X PUT "http://localhost:4000/search_tools/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "search_tool": {
* "search_tool_name": "updated-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-new-key"
* },
* "search_tool_info": {
* "description": "Updated search tool"
* }
* }
* }'
* ```
*
* Example Response:
* ```json
* {
* "search_tool_id": "123e4567-e89b-12d3-a456-426614174000",
* "search_tool_name": "updated-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-new-key"
* },
* "search_tool_info": {
* "description": "Updated search tool"
* },
* "created_at": "2023-11-09T12:34:56.789Z",
* "updated_at": "2023-11-09T13:45:12.345Z"
* }
* ```
*/
put: operations["update_search_tool_search_tools__search_tool_id__put"];
post?: never;
/**
* Delete Search Tool
* @description Delete a search tool.
*
* Example Request:
* ```bash
* curl -X DELETE "http://localhost:4000/search_tools/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "message": "Search tool 123e4567-e89b-12d3-a456-426614174000 deleted successfully",
* "search_tool_name": "litellm-search"
* }
* ```
*/
delete: operations["delete_search_tool_search_tools__search_tool_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Active Callbacks
* @description Returns a list of litellm level settings
*
* This is useful for debugging and ensuring the proxy server is configured correctly.
*
* Response schema:
* ```
* {
* "alerting": _alerting,
* "litellm.callbacks": litellm_callbacks,
* "litellm.input_callback": litellm_input_callbacks,
* "litellm.failure_callback": litellm_failure_callbacks,
* "litellm.success_callback": litellm_success_callbacks,
* "litellm._async_success_callback": litellm_async_success_callbacks,
* "litellm._async_failure_callback": litellm_async_failure_callbacks,
* "litellm._async_input_callback": litellm_async_input_callbacks,
* "all_litellm_callbacks": all_litellm_callbacks,
* "num_callbacks": len(all_litellm_callbacks),
* "num_alerting": _num_alerting,
* "litellm.request_timeout": litellm.request_timeout,
* }
* ```
*/
get: operations["active_callbacks_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/calculate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Calculate Spend
* @description Accepts all the params of completion_cost.
*
* Calculate spend **before** making call:
*
* Note: If you see a spend of $0.0 you need to set custom_pricing for your model: https://docs.litellm.ai/docs/proxy/custom_pricing
*
* ```
* curl --location 'http://localhost:4000/spend/calculate'
* --header 'Authorization: Bearer sk-1234'
* --header 'Content-Type: application/json'
* --data '{
* "model": "anthropic.claude-v2",
* "messages": [{"role": "user", "content": "Hey, how'''s it going?"}]
* }'
* ```
*
* Calculate spend **after** making call:
*
* ```
* curl --location 'http://localhost:4000/spend/calculate'
* --header 'Authorization: Bearer sk-1234'
* --header 'Content-Type: application/json'
* --data '{
* "completion_response": {
* "id": "chatcmpl-123",
* "object": "chat.completion",
* "created": 1677652288,
* "model": "gpt-3.5-turbo-0125",
* "system_fingerprint": "fp_44709d6fcb",
* "choices": [{
* "index": 0,
* "message": {
* "role": "assistant",
* "content": "Hello there, how may I assist you today?"
* },
* "logprobs": null,
* "finish_reason": "stop"
* }]
* "usage": {
* "prompt_tokens": 9,
* "completion_tokens": 12,
* "total_tokens": 21
* }
* }
* }'
* ```
*/
post: operations["calculate_spend_spend_calculate_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/keys": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Spend Key Fn
* @description View keys created, ordered by spend.
*
* - Admin callers (PROXY_ADMIN / PROXY_ADMIN_VIEW_ONLY) see every key in
* the database.
* - All other callers (INTERNAL_USER / INTERNAL_USER_VIEW_ONLY, etc.) are
* scoped to keys they own (``user_id == caller``). A caller with no
* ``user_id`` has no scope and receives an empty list rather than the
* full table.
*
* Example Request:
* ```
* curl -X GET "http://0.0.0.0:8000/spend/keys" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["spend_key_fn_spend_keys_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* View Spend Logs
* @description [DEPRECATED] This endpoint is not paginated and can cause performance issues.
* Please use `/spend/logs/v2` instead for paginated access to spend logs.
*
* View all spend logs, if request_id is provided, only logs for that request_id will be returned
*
* When start_date and end_date are provided:
* - summarize=true (default): Returns aggregated spend data grouped by date (maintains backward compatibility)
* - summarize=false: Returns filtered individual log entries within the date range
*
* Example Request for all logs
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs" -H "Authorization: Bearer sk-1234"
* ```
*
* Example Request for specific request_id
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs?request_id=chatcmpl-6dcb2540-d3d7-4e49-bb27-291f863f112e" -H "Authorization: Bearer sk-1234"
* ```
*
* Example Request for specific api_key
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs?api_key=sk-test-example-key-123" -H "Authorization: Bearer sk-1234"
* ```
*
* Example Request for specific user_id
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs?user_id=ishaan@berri.ai" -H "Authorization: Bearer sk-1234"
* ```
*
* Example Request for date range with individual logs (unsummarized)
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs?start_date=2024-01-01&end_date=2024-01-02&summarize=false" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["view_spend_logs_spend_logs_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/logs/session/ui": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui View Session Spend Logs
* @description Get paginated spend logs for a particular session.
*
* Returns:
* {
* "data": List[LiteLLM_SpendLogs],
* "total": int,
* "page": int,
* "page_size": int,
* "total_pages": int,
* }
*/
get: operations["ui_view_session_spend_logs_spend_logs_session_ui_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/logs/ui": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui View Spend Logs
* @description View spend logs with pagination support.
* Available at both `/spend/logs/v2` (public API) and `/spend/logs/ui` (internal UI).
*
* Returns paginated response with data, total, page, page_size, and total_pages.
*
* Example:
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs/v2?start_date=2025-11-25%2000:00:00&end_date=2025-11-26%2023:59:59&page=1&page_size=50" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["ui_view_spend_logs_spend_logs_ui_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/logs/ui/{request_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui View Request Response For Request Id
* @description View request / response for a specific request_id
*
* - goes through all callbacks, checks if any of them have a @property -> has_request_response_payload
* - if so, it will return the request and response payload
*/
get: operations["ui_view_request_response_for_request_id_spend_logs_ui__request_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/logs/v2": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui View Spend Logs
* @description View spend logs with pagination support.
* Available at both `/spend/logs/v2` (public API) and `/spend/logs/ui` (internal UI).
*
* Returns paginated response with data, total, page, page_size, and total_pages.
*
* Example:
* ```
* curl -X GET "http://0.0.0.0:8000/spend/logs/v2?start_date=2025-11-25%2000:00:00&end_date=2025-11-26%2023:59:59&page=1&page_size=50" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["ui_view_spend_logs_spend_logs_v2_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* View Spend Tags
* @description LiteLLM Enterprise - View Spend Per Request Tag
*
* Example Request:
* ```
* curl -X GET "http://0.0.0.0:8000/spend/tags" -H "Authorization: Bearer sk-1234"
* ```
*
* Spend with Start Date and End Date
* ```
* curl -X GET "http://0.0.0.0:8000/spend/tags?start_date=2022-01-01&end_date=2022-02-01" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["view_spend_tags_spend_tags_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/spend/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Spend User Fn
* @description View users created, ordered by spend.
*
* - Admin callers (PROXY_ADMIN / PROXY_ADMIN_VIEW_ONLY) see every user, or
* a specific user when ``user_id`` is supplied.
* - All other callers may only read their own row. If they supply a
* ``user_id`` query parameter that does not match their authenticated
* ``user_id`` the request is rejected with HTTP 403; supplying their
* own id (or none at all) returns just their row. A caller with no
* ``user_id`` on their key has no scope and receives an empty list
* rather than the full table.
*
* Example Request:
* ```
* curl -X GET "http://0.0.0.0:8000/spend/users" -H "Authorization: Bearer sk-1234"
* ```
*
* View User Table row for user_id
* ```
* curl -X GET "http://0.0.0.0:8000/spend/users?user_id=1234" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["spend_user_fn_spend_users_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Auth Callback
* @description Verify login
*/
get: operations["auth_callback_sso_callback_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/cli/complete/{login_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Cli Sso Complete */
post: operations["cli_sso_complete_sso_cli_complete__login_id__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/cli/poll/{key_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Cli Poll Key
* @description CLI polling endpoint - retrieves session from cache and generates JWT.
*
* Flow:
* 1. First poll (no team_id): Returns teams list without generating JWT
* 2. Second poll (with team_id): Generates JWT with selected team and deletes session
*
* Args:
* key_id: The CLI login session ID
* team_id: Optional team ID to assign to the JWT. If provided, must be one of user's teams.
*/
get: operations["cli_poll_key_sso_cli_poll__key_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/cli/start": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Cli Sso Start */
post: operations["cli_sso_start_sso_cli_start_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/debug/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Debug Sso Callback
* @description Returns the OpenID object returned by the SSO provider
*/
get: operations["debug_sso_callback_sso_debug_callback_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/debug/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Debug Sso Login
* @description Create Proxy API Keys using Google Workspace SSO. Requires setting PROXY_BASE_URL in .env
* PROXY_BASE_URL should be the your deployed proxy endpoint, e.g. PROXY_BASE_URL="https://litellm-production-7002.up.railway.app/"
* Example:
*/
get: operations["debug_sso_login_sso_debug_login_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/get/ui_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Ui Settings */
get: operations["get_ui_settings_sso_get_ui_settings_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/key/generate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Google Login
* @description Create Proxy API Keys using Google Workspace SSO. Requires setting PROXY_BASE_URL in .env
* PROXY_BASE_URL should be the your deployed proxy endpoint, e.g. PROXY_BASE_URL="https://litellm-production-7002.up.railway.app/"
* Example:
*/
get: operations["google_login_sso_key_generate_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/sso/readiness": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Sso Readiness
* @description Health endpoint for checking SSO readiness.
* Checks if the configured SSO provider has all required environment variables set in memory.
*/
get: operations["sso_readiness_sso_readiness_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tag Daily Activity
* @description Get daily activity for specific tags or all tags.
*
* Args:
* tags (Optional[str]): Comma-separated list of tags to filter by. If not provided, returns data for all tags.
* start_date (Optional[str]): Start date for the activity period (YYYY-MM-DD).
* end_date (Optional[str]): End date for the activity period (YYYY-MM-DD).
* model (Optional[str]): Filter by model name.
* api_key (Optional[str]): Filter by API key.
* page (int): Page number for pagination.
* page_size (int): Number of items per page.
*
* Returns:
* SpendAnalyticsPaginatedResponse: Paginated response containing daily activity data.
*/
get: operations["get_tag_daily_activity_tag_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/dau": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Daily Active Users
* @description Get Daily Active Users (DAU) by tags for the last {MAX_DAYS} days ending on UTC today + 1 day.
*
* This endpoint efficiently calculates unique users per tag for each of the last {MAX_DAYS} days
* using a single optimized SQL query, perfect for dashboard time series visualization.
*
* Args:
* tag_filter: Optional filter to specific tag (legacy)
* tag_filters: Optional filter to multiple specific tags (takes precedence over tag_filter)
*
* Returns:
* ActiveUsersAnalyticsResponse: DAU data by tag for each of the last {MAX_DAYS} days
*/
get: operations["get_daily_active_users_tag_dau_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Tag
* @description Delete a tag.
*
* Parameters:
* - name: str - The name of the tag to delete
*/
post: operations["delete_tag_tag_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/distinct": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Distinct User Agent Tags
* @description Get all distinct user agent tags up to a maximum of {MAX_TAGS} tags.
*
* This endpoint returns all unique user agent tags found in the database,
* sorted by frequency of usage.
*
* Returns:
* DistinctTagsResponse: List of distinct user agent tags
*/
get: operations["get_distinct_user_agent_tags_tag_distinct_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Info Tag
* @description Get information about specific tags.
*
* Parameters:
* - names: List[str] - List of tag names to get information for
*/
post: operations["info_tag_tag_info_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Tags
* @description List all available tags with their budget information.
*/
get: operations["list_tags_tag_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/mau": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Monthly Active Users
* @description Get Monthly Active Users (MAU) by tags for the last {MAX_MONTHS} months ending on UTC today + 1 day.
*
* Shows month-by-month breakdown:
* - Month 1 (Nov): Earliest month (7 months ago, 30-day period)
* - Month 2 (Dec): Next month (6 months ago)
* - Month 3 (Jan): Next month (5 months ago)
* - ... and so on for {MAX_MONTHS} months total
* - Month 7: Most recent month ending on UTC today + 1 day
*
* Args:
* tag_filter: Optional filter to specific tag (legacy)
* tag_filters: Optional filter to multiple specific tags (takes precedence over tag_filter)
*
* Returns:
* ActiveUsersAnalyticsResponse: MAU data by tag for each of the last {MAX_MONTHS} months with descriptive month labels (e.g., "Month 1 (Nov)")
*/
get: operations["get_monthly_active_users_tag_mau_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New Tag
* @description Create a new tag.
*
* Parameters:
* - name: str - The name of the tag
* - description: Optional[str] - Description of what this tag represents
* - models: List[str] - List of either 'model_id' or 'model_name' allowed for this tag
* - budget_id: Optional[str] - The id for a budget (tpm/rpm/max budget) for the tag
*
* ### IF NO BUDGET ID - CREATE ONE WITH THESE PARAMS ###
* - max_budget: Optional[float] - Max budget for tag
* - tpm_limit: Optional[int] - Max tpm limit for tag
* - rpm_limit: Optional[int] - Max rpm limit for tag
* - max_parallel_requests: Optional[int] - Max parallel requests for tag
* - soft_budget: Optional[float] - Get a slack alert when this soft budget is reached
* - model_max_budget: Optional[dict] - Max budget for a specific model
* - budget_duration: Optional[str] - Frequency of resetting tag budget
*/
post: operations["new_tag_tag_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tag Summary
* @description Get summary analytics for tags including unique users, requests, tokens, and spend.
*
* Args:
* start_date: Start date for the analytics period (YYYY-MM-DD)
* end_date: End date for the analytics period (YYYY-MM-DD)
* tag_filter: Optional filter to specific tag (legacy)
* tag_filters: Optional filter to multiple specific tags (takes precedence over tag_filter)
*
* Returns:
* TagSummaryResponse: Summary analytics data by tag
*/
get: operations["get_tag_summary_tag_summary_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Tag
* @description Update an existing tag.
*
* Parameters:
* - name: str - The name of the tag to update
* - description: Optional[str] - Updated description
* - models: List[str] - Updated list of allowed LLM models
* - budget_id: Optional[str] - The id for a budget to associate with the tag
*
* ### BUDGET UPDATE PARAMS ###
* - max_budget: Optional[float] - Max budget for tag
* - tpm_limit: Optional[int] - Max tpm limit for tag
* - rpm_limit: Optional[int] - Max rpm limit for tag
* - max_parallel_requests: Optional[int] - Max parallel requests for tag
* - soft_budget: Optional[float] - Get a slack alert when this soft budget is reached
* - model_max_budget: Optional[dict] - Max budget for a specific model
* - budget_duration: Optional[str] - Frequency of resetting tag budget
*/
post: operations["update_tag_tag_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/user-agent/per-user-analytics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Per User Analytics
* @description Get per-user analytics including successful requests, tokens, and spend by individual users.
*
* This endpoint provides usage metrics broken down by individual users based on their
* tag activity during the last 30 days ending on UTC today + 1 day.
*
* Args:
* tag_filter: Optional filter to specific tag (legacy)
* tag_filters: Optional filter to multiple specific tags (takes precedence over tag_filter)
* page: Page number for pagination
* page_size: Number of items per page
*
* Returns:
* PerUserAnalyticsResponse: Analytics data broken down by individual users for the last 30 days
*/
get: operations["get_per_user_analytics_tag_user_agent_per_user_analytics_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tag/wau": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Weekly Active Users
* @description Get Weekly Active Users (WAU) by tags for the last {MAX_WEEKS} weeks ending on UTC today + 1 day.
*
* Shows week-by-week breakdown:
* - Week 1 (Jan 1): Earliest week (7 weeks ago)
* - Week 2 (Jan 8): Next week (6 weeks ago)
* - Week 3 (Jan 15): Next week (5 weeks ago)
* - ... and so on for {MAX_WEEKS} weeks total
* - Week 7: Most recent week ending on UTC today + 1 day
*
* Args:
* tag_filter: Optional filter to specific tag (legacy)
* tag_filters: Optional filter to multiple specific tags (takes precedence over tag_filter)
*
* Returns:
* ActiveUsersAnalyticsResponse: WAU data by tag for each of the last {MAX_WEEKS} weeks with descriptive week labels (e.g., "Week 1 (Jan 1)")
*/
get: operations["get_weekly_active_users_tag_wau_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/available": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Available Teams */
get: operations["list_available_teams_team_available_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/block": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Block Team
* @description Blocks all calls from keys with this team id.
*
* Parameters:
* - team_id: str - Required. The unique identifier of the team to block.
*
* Example:
* ```
* curl --location 'http://0.0.0.0:4000/team/block' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_id": "team-1234"
* }'
* ```
*
* Returns:
* - The updated team record with blocked=True
*/
post: operations["block_team_team_block_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/bulk_member_add": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Team Member Add
* @description Bulk add multiple members to a team at once.
*
* This endpoint reuses the same logic as /team/member_add but provides a bulk-friendly response format.
*
* Parameters:
* - team_id: str - The ID of the team to add members to
* - members: List[Member] - List of members to add to the team
* - all_users: Optional[bool] - Flag to add all users on Proxy to the team
* - max_budget_in_team: Optional[float] - Maximum budget allocated to each user within the team
*
* Returns:
* - results: List of individual member addition results
* - total_requested: Total number of members requested for addition
* - successful_additions: Number of successful additions
* - failed_additions: Number of failed additions
* - updated_team: The updated team object
*
* Example request:
* ```bash
* curl --location 'http://0.0.0.0:4000/team/bulk_member_add' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_id": "team-1234",
* "members": [
* {
* "user_id": "user1",
* "role": "user"
* },
* {
* "user_email": "user2@example.com",
* "role": "admin"
* }
* ],
* "max_budget_in_team": 100.0
* }'
* ```
*/
post: operations["bulk_team_member_add_team_bulk_member_add_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Team Daily Activity
* @description Get daily activity for specific teams or all teams.
*
* Args:
* team_ids (Optional[str]): Comma-separated list of team IDs to filter by. If not provided, returns data for all teams.
* start_date (Optional[str]): Start date for the activity period (YYYY-MM-DD).
* end_date (Optional[str]): End date for the activity period (YYYY-MM-DD).
* model (Optional[str]): Filter by model name.
* api_key (Optional[str]): Filter by API key.
* page (int): Page number for pagination.
* page_size (int): Number of items per page.
* exclude_team_ids (Optional[str]): Comma-separated list of team IDs to exclude.
* Returns:
* SpendAnalyticsPaginatedResponse: Paginated response containing daily activity data.
*/
get: operations["get_team_daily_activity_team_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete Team
* @description delete team and associated team keys
*
* Parameters:
* - team_ids: List[str] - Required. List of team IDs to delete. Example: ["team-1234", "team-5678"]
*
* ```
* curl --location 'http://0.0.0.0:4000/team/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data-raw '{
* "team_ids": ["8d916b1c-510d-4894-a334-1c16a93344f5"]
* }'
* ```
*/
post: operations["delete_team_team_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/filter/ui": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui View Teams
* @description [PROXY-ADMIN ONLY] Filter teams based on partial match of team_id or team_alias with pagination.
*
* Args:
* user_id (Optional[str]): Partial user ID to search for
* user_email (Optional[str]): Partial email to search for
* page (int): Page number for pagination (starts at 1)
* page_size (int): Number of items per page (max 100)
* user_api_key_dict (UserAPIKeyAuth): User authentication information
*
* Returns:
* List[LiteLLM_SpendLogs]: Paginated list of matching user records
*/
get: operations["ui_view_teams_team_filter_ui_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Team Info
* @description get info on team + related keys
*
* Parameters:
* - team_id: str - Required. The unique identifier of the team to get info on.
*
* ```
* curl --location 'http://localhost:4000/team/info?team_id=your_team_id_here' --header 'Authorization: Bearer your_api_key_here'
* ```
*/
get: operations["team_info_team_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/key/bulk_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Update Team Keys
* @description Apply one update payload to many keys inside a single team.
*
* Pass `team_id` plus either `key_ids` or `all_keys_in_team=True`. The
* `update_fields` payload is broadcast to every selected key. Per-key
* failures are returned in `failed_updates` rather than aborting the batch.
*
* Callable by proxy admins, or by team admins with `KEY_UPDATE` permission.
*/
post: operations["bulk_update_team_keys_team_key_bulk_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Team
* @description ```
* curl --location --request GET 'http://0.0.0.0:4000/team/list' --header 'Authorization: Bearer sk-1234'
* ```
*
* Parameters:
* - user_id: str - Optional. If passed will only return teams that the user_id is a member of.
* - organization_id: str - Optional. If passed will only return teams that belong to the organization_id. Pass 'default_organization' to get all teams without organization_id.
*/
get: operations["list_team_team_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/member_add": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Team Member Add
* @description Add new members (either via user_email or user_id) to a team
*
* If user doesn't exist, new user row will also be added to User Table
*
* Only proxy_admin or admin of team, allowed to access this endpoint.
* ```
*
* curl -X POST 'http://0.0.0.0:4000/team/member_add' -H 'Authorization: Bearer sk-1234' -H 'Content-Type: application/json' -d '{"team_id": "45e3e396-ee08-4a61-a88e-16b3ce7e0849", "member": {"role": "user", "user_id": "krrish247652@berri.ai"}}'
*
* ```
*/
post: operations["team_member_add_team_member_add_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/member_delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Team Member Delete
* @description [BETA]
*
* delete members (either via user_email or user_id) from a team
*
* If user doesn't exist, an exception will be raised
* ```
* curl -X POST 'http://0.0.0.0:8000/team/member_delete'
* -H 'Authorization: Bearer sk-1234'
* -H 'Content-Type: application/json'
* -d '{
* "team_id": "45e3e396-ee08-4a61-a88e-16b3ce7e0849",
* "user_id": "krrish247652@berri.ai"
* }'
* ```
*/
post: operations["team_member_delete_team_member_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/member_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Team Member Update
* @description [BETA]
*
* Update team member budgets and team member role
*/
post: operations["team_member_update_team_member_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/model/add": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Team Model Add
* @description Add models to a team's allowed model list. Only proxy admin or team admin can add models.
*
* Parameters:
* - team_id: str - Required. The team to add models to
* - models: List[str] - Required. List of models to add to the team
*
* Example Request:
* ```
* curl --location 'http://0.0.0.0:4000/team/model/add' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_id": "team-1234",
* "models": ["gpt-4", "claude-2"]
* }'
* ```
*/
post: operations["team_model_add_team_model_add_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/model/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Team Model Delete
* @description Remove models from a team's allowed model list. Only proxy admin or team admin can remove models.
*
* Parameters:
* - team_id: str - Required. The team to remove models from
* - models: List[str] - Required. List of models to remove from the team
*
* Example Request:
* ```
* curl --location 'http://0.0.0.0:4000/team/model/delete' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_id": "team-1234",
* "models": ["gpt-4"]
* }'
* ```
*/
post: operations["team_model_delete_team_model_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New Team
* @description Allow users to create a new team. Apply user permissions to their team.
*
* 👉 [Detailed Doc on setting team budgets](https://docs.litellm.ai/docs/proxy/team_budgets)
*
*
* Parameters:
* - team_alias: Optional[str] - User defined team alias
* - team_id: Optional[str] - The team id of the user. If none passed, we'll generate it.
* - members_with_roles: List[{"role": "admin" or "user", "user_id": "<user-id>"}] - A list of users and their roles in the team. Get user_id when making a new user via `/user/new`.
* - team_member_permissions: Optional[List[str]] - A list of routes that non-admin team members can access. example: ["/key/generate", "/key/update", "/key/delete"]
* - metadata: Optional[dict] - Metadata for team, store information for team. Example metadata = {"extra_info": "some info"}
* - model_rpm_limit: Optional[Dict[str, int]] - The RPM (Requests Per Minute) limit for this team - applied across all keys for this team.
* - model_tpm_limit: Optional[Dict[str, int]] - The TPM (Tokens Per Minute) limit for this team - applied across all keys for this team.
* - mcp_rpm_limit: Optional[Dict[str, int]] - Per-MCP-server RPM limit for this team, keyed by MCP server name (alias if set, else the configured name). Example: {"github": 100, "slack": 200}. Applied across all keys for this team.
* - tpm_limit: Optional[int] - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit
* - rpm_limit: Optional[int] - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit
* - rpm_limit_type: Optional[Literal["guaranteed_throughput", "best_effort_throughput"]] - The type of RPM limit enforcement. Use "guaranteed_throughput" to raise an error if overallocating RPM, or "best_effort_throughput" for best effort enforcement.
* - tpm_limit_type: Optional[Literal["guaranteed_throughput", "best_effort_throughput"]] - The type of TPM limit enforcement. Use "guaranteed_throughput" to raise an error if overallocating TPM, or "best_effort_throughput" for best effort enforcement.
* - max_budget: Optional[float] - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget
* - soft_budget: Optional[float] - The soft budget threshold for the team. If max_budget is set, soft_budget must be strictly lower than max_budget. Can be set independently if max_budget is not set.
* - budget_duration: Optional[str] - The duration of the budget for the team. Doc [here](https://docs.litellm.ai/docs/proxy/team_budgets)
* - models: Optional[list] - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed.
* - blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id.
* - members: Optional[List] - Control team members via `/team/member/add` and `/team/member/delete`.
* - tags: Optional[List[str]] - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing).
* - prompts: Optional[List[str]] - List of prompts that the team is allowed to use.
* - organization_id: Optional[str] - The organization id of the team. Default is None. Create via `/organization/new`.
* - model_aliases: Optional[dict] - Model aliases for the team. [Docs](https://docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias)
* - guardrails: Optional[List[str]] - Guardrails for the team. [Docs](https://docs.litellm.ai/docs/proxy/guardrails)
* - policies: Optional[List[str]] - Policies for the team. [Docs](https://docs.litellm.ai/docs/proxy/guardrails/guardrail_policies)
* - disable_global_guardrails: Optional[bool] - Whether to disable global guardrails for the key.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - team-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission.
* - team_member_budget: Optional[float] - The maximum budget allocated to an individual team member.
* - team_member_budget_duration: Optional[str] - The duration of the budget for the team member. Doc [here](https://docs.litellm.ai/docs/proxy/team_budgets)
* - team_member_rpm_limit: Optional[int] - The RPM (Requests Per Minute) limit for individual team members.
* - team_member_tpm_limit: Optional[int] - The TPM (Tokens Per Minute) limit for individual team members.
* - team_member_key_duration: Optional[str] - The duration for a team member's key. e.g. "1d", "1w", "1mo"
* - allowed_passthrough_routes: Optional[List[str]] - List of allowed pass through routes for the team.
* - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint.
* - secret_manager_settings: Optional[dict] - Secret manager settings for the team. [Docs](https://docs.litellm.ai/docs/secret_managers/overview)
* - router_settings: Optional[UpdateRouterConfig] - team-specific router settings. Example - {"model_group_retry_policy": {"max_retries": 5}}. IF null or {} then no router settings.
* - access_group_ids: Optional[List[str]] - List of access group IDs to associate with the team. Access groups define which models the team can access. Example - ["access_group_1", "access_group_2"].
* - enforced_file_expires_after: Optional[dict] - Enforced file expiration policy for the team. Keys created under this team will inherit this policy for file uploads. Example - {"anchor": "created_at", "days": 30}.
* - enforced_batch_output_expires_after: Optional[dict] - Enforced batch output file expiration policy for the team. Keys created under this team will inherit this policy for batch output files. Example - {"anchor": "created_at", "days": 30}.
* - budget_limits: Optional[list] - List of concurrent budget windows for the team. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}].
* - default_team_member_models: Optional[List[str]] - Default models assigned to new team members when they join this team. Must be a subset of the team's models.
*
* Returns:
* - team_id: (str) Unique team id - used for tracking spend across multiple keys for same team id.
*
* _deprecated_params:
* - admins: list - A list of user_id's for the admin role
* - users: list - A list of user_id's for the user role
*
* Example Request:
* ```
* curl --location 'http://0.0.0.0:4000/team/new' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_alias": "my-new-team_2",
* "members_with_roles": [{"role": "admin", "user_id": "user-1234"},
* {"role": "user", "user_id": "user-2434"}]
* }'
*
* ```
*
* ```
* curl --location 'http://0.0.0.0:4000/team/new' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_alias": "QA Prod Bot",
* "max_budget": 0.000000001,
* "budget_duration": "1d"
* }'
* ```
*/
post: operations["new_team_team_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/permissions_bulk_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Update Team Member Permissions
* @description Append permissions to existing teams.
*
* Either pass team_ids to target specific teams, or set
* apply_to_all_teams=True to update every team. For each team,
* the provided permissions are merged with the team's existing
* permissions (duplicates are skipped).
*/
post: operations["bulk_update_team_member_permissions_team_permissions_bulk_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/permissions_list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Team Member Permissions
* @description Get the team member permissions for a team
*/
get: operations["team_member_permissions_team_permissions_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/permissions_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Team Member Permissions
* @description Update the team member permissions for a team
*/
post: operations["update_team_member_permissions_team_permissions_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/unblock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Unblock Team
* @description Unblocks a previously blocked team, re-enabling calls from keys with this team id.
*
* Parameters:
* - team_id: str - Required. The unique identifier of the team to unblock.
*
* Example:
* ```
* curl --location 'http://0.0.0.0:4000/team/unblock' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "team_id": "team-1234"
* }'
* ```
*/
post: operations["unblock_team_team_unblock_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Team
* @description Use `/team/member_add` AND `/team/member/delete` to add/remove new team members
*
* You can now update team budget / rate limits via /team/update
*
* Parameters:
* - team_id: str - The team id of the user. Required param.
* - team_alias: Optional[str] - User defined team alias
* - team_member_permissions: Optional[List[str]] - A list of routes that non-admin team members can access. example: ["/key/generate", "/key/update", "/key/delete"]
* - metadata: Optional[dict] - Metadata for team, store information for team. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
* - tpm_limit: Optional[int] - The TPM (Tokens Per Minute) limit for this team - all keys with this team_id will have at max this TPM limit
* - rpm_limit: Optional[int] - The RPM (Requests Per Minute) limit for this team - all keys associated with this team_id will have at max this RPM limit
* - max_budget: Optional[float] - The maximum budget allocated to the team - all keys for this team_id will have at max this max_budget
* - soft_budget: Optional[float] - The soft budget threshold for the team. If max_budget is set (either in the request or existing), soft_budget must be strictly lower than max_budget. Can be set independently if max_budget is not set.
* - budget_duration: Optional[str] - The duration of the budget for the team. Doc [here](https://docs.litellm.ai/docs/proxy/team_budgets)
* - models: Optional[list] - A list of models associated with the team - all keys for this team_id will have at most, these models. If empty, assumes all models are allowed.
* - prompts: Optional[List[str]] - List of prompts that the team is allowed to use.
* - blocked: bool - Flag indicating if the team is blocked or not - will stop all calls from keys with this team_id.
* - tags: Optional[List[str]] - Tags for [tracking spend](https://litellm.vercel.app/docs/proxy/enterprise#tracking-spend-for-custom-tags) and/or doing [tag-based routing](https://litellm.vercel.app/docs/proxy/tag_routing).
* - organization_id: Optional[str] - The organization id of the team. Default is None. Create via `/organization/new`.
* - model_aliases: Optional[dict] - Model aliases for the team. [Docs](https://docs.litellm.ai/docs/proxy/team_based_routing#create-team-with-model-alias)
* - guardrails: Optional[List[str]] - Guardrails for the team. [Docs](https://docs.litellm.ai/docs/proxy/guardrails)
* - policies: Optional[List[str]] - Policies for the team. [Docs](https://docs.litellm.ai/docs/proxy/guardrails/guardrail_policies)
* - disable_global_guardrails: Optional[bool] - Whether to disable global guardrails for the key.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - team-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"], "agents": ["agent_1", "agent_2"], "agent_access_groups": ["dev_group"]}. IF null or {} then no object permission.
* - team_member_budget: Optional[float] - The maximum budget allocated to an individual team member.
* - team_member_budget_duration: Optional[str] - The duration of the budget for the team member. Doc [here](https://docs.litellm.ai/docs/proxy/team_budgets)
* - team_member_rpm_limit: Optional[int] - The RPM (Requests Per Minute) limit for individual team members.
* - team_member_tpm_limit: Optional[int] - The TPM (Tokens Per Minute) limit for individual team members.
* - team_member_key_duration: Optional[str] - The duration for a team member's key. e.g. "1d", "1w", "1mo"
* - allowed_passthrough_routes: Optional[List[str]] - List of allowed pass through routes for the team.
* - model_rpm_limit: Optional[Dict[str, int]] - The RPM (Requests Per Minute) limit per model for this team. Example: {"gpt-4": 100, "gpt-3.5-turbo": 200}
* - model_tpm_limit: Optional[Dict[str, int]] - The TPM (Tokens Per Minute) limit per model for this team. Example: {"gpt-4": 10000, "gpt-3.5-turbo": 20000}
* Example - update team TPM Limit
* - allowed_vector_store_indexes: Optional[List[dict]] - List of allowed vector store indexes for the key. Example - [{"index_name": "my-index", "index_permissions": ["write", "read"]}]. If specified, the key will only be able to use these specific vector store indexes. Create index, using `/v1/indexes` endpoint.
* - secret_manager_settings: Optional[dict] - Secret manager settings for the team. [Docs](https://docs.litellm.ai/docs/secret_managers/overview)
* - router_settings: Optional[UpdateRouterConfig] - team-specific router settings. Example - {"model_group_retry_policy": {"max_retries": 5}}. IF null or {} then no router settings.
* - access_group_ids: Optional[List[str]] - List of access group IDs to associate with the team. Access groups define which models the team can access. Example - ["access_group_1", "access_group_2"].
* - enforced_file_expires_after: Optional[dict] - Enforced file expiration policy for the team. Keys created under this team will inherit this policy for file uploads. Example - {"anchor": "created_at", "days": 30}.
* - enforced_batch_output_expires_after: Optional[dict] - Enforced batch output file expiration policy for the team. Keys created under this team will inherit this policy for batch output files. Example - {"anchor": "created_at", "days": 30}.
* - budget_limits: Optional[list] - List of concurrent budget windows for the team. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}].
* - default_team_member_models: Optional[List[str]] - Default models assigned to new team members when they join this team. Must be a subset of the team's models.
*
* ```
* curl --location 'http://0.0.0.0:4000/team/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data-raw '{
* "team_id": "8d916b1c-510d-4894-a334-1c16a93344f5",
* "tpm_limit": 100
* }'
* ```
*
* Example - Update Team `max_budget` budget
* ```
* curl --location 'http://0.0.0.0:4000/team/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data-raw '{
* "team_id": "8d916b1c-510d-4894-a334-1c16a93344f5",
* "max_budget": 10
* }'
* ```
*/
post: operations["update_team_team_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/{team_id}/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Team Callbacks
* @description Get the success/failure callbacks and variables for a team
*
* Parameters:
* - team_id (str, required): The unique identifier for the team
*
* Example curl:
* ```
* curl -X GET 'http://localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/callback' -H 'Authorization: Bearer sk-1234'
* ```
*
* This will return the callback settings for the team with id dbe2f686-a686-4896-864a-4c3924458709
*
* Returns {
* "status": "success",
* "data": {
* "team_id": team_id,
* "success_callbacks": team_callback_settings_obj.success_callback,
* "failure_callbacks": team_callback_settings_obj.failure_callback,
* "callback_vars": team_callback_settings_obj.callback_vars,
* },
* }
*/
get: operations["get_team_callbacks_team__team_id__callback_get"];
put?: never;
/**
* Add Team Callbacks
* @description Add a success/failure callback to a team
*
* Use this if if you want different teams to have different success/failure callbacks
*
* Parameters:
* - callback_name (Literal["langfuse", "langsmith", "gcs"], required): The name of the callback to add
* - callback_type (Literal["success", "failure", "success_and_failure"], required): The type of callback to add. One of:
* - "success": Callback for successful LLM calls
* - "failure": Callback for failed LLM calls
* - "success_and_failure": Callback for both successful and failed LLM calls
* - callback_vars (StandardCallbackDynamicParams, required): A dictionary of variables to pass to the callback
* - langfuse_public_key: The public key for the Langfuse callback
* - langfuse_secret_key: The secret key for the Langfuse callback
* - langfuse_secret: The secret for the Langfuse callback
* - langfuse_host: The host for the Langfuse callback
* - gcs_bucket_name: The name of the GCS bucket
* - gcs_path_service_account: The path to the GCS service account
* - langsmith_api_key: The API key for the Langsmith callback
* - langsmith_project: The project for the Langsmith callback
* - langsmith_base_url: The base URL for the Langsmith callback
*
* Example curl:
* ```
* curl -X POST 'http:/localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/callback' -H 'Content-Type: application/json' -H 'Authorization: Bearer sk-1234' -d '{
* "callback_name": "langfuse",
* "callback_type": "success",
* "callback_vars": {"langfuse_public_key": "pk-lf-xxxx1", "langfuse_secret_key": "sk-xxxxx"}
*
* }'
* ```
*
* This means for the team where team_id = dbe2f686-a686-4896-864a-4c3924458709, all LLM calls will be logged to langfuse using the public key pk-lf-xxxx1 and the secret key sk-xxxxx
*/
post: operations["add_team_callbacks_team__team_id__callback_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/{team_id}/disable_logging": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Disable Team Logging
* @description Disable all logging callbacks for a team
*
* Parameters:
* - team_id (str, required): The unique identifier for the team
*
* Example curl:
* ```
* curl -X POST 'http://localhost:4000/team/dbe2f686-a686-4896-864a-4c3924458709/disable_logging' -H 'Authorization: Bearer sk-1234'
* ```
*/
post: operations["disable_team_logging_team__team_id__disable_logging_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/team/{team_id}/members/me": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Team Member Me
* @description Get the caller's own team-membership row for the given team.
*
* Used by internal users to view their own spend, budget, budget reset
* date, rate limits, and role within a team — without exposing other
* members' data. The caller is resolved from their API key; the path
* `/members/me` always refers to that caller.
*
* Returns 404 if the caller is not a member of the team.
*
* ```
* curl --location 'http://localhost:4000/team/your_team_id/members/me' --header 'Authorization: Bearer your_api_key_here'
* ```
*/
get: operations["team_member_me_team__team_id__members_me_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Test Endpoint
* @description [DEPRECATED] use `/health/liveliness` instead.
*
* A test endpoint that pings the proxy server to check if it's healthy.
*
* Parameters:
* request (Request): The incoming request.
*
* Returns:
* dict: A dictionary containing the route of the request URL.
*/
get: operations["test_endpoint_test_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/threads": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Threads
* @description Create a thread.
*
* API Reference - https://platform.openai.com/docs/api-reference/threads/createThread
*/
post: operations["create_threads_threads_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/threads/{thread_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Thread
* @description Retrieves a thread.
*
* API Reference - https://platform.openai.com/docs/api-reference/threads/getThread
*/
get: operations["get_thread_threads__thread_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/threads/{thread_id}/messages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Messages
* @description Returns a list of messages for a given thread.
*
* API Reference - https://platform.openai.com/docs/api-reference/messages/listMessages
*/
get: operations["get_messages_threads__thread_id__messages_get"];
put?: never;
/**
* Add Messages
* @description Create a message.
*
* API Reference - https://platform.openai.com/docs/api-reference/messages/createMessage
*/
post: operations["add_messages_threads__thread_id__messages_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/threads/{thread_id}/runs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Run Thread
* @description Create a run.
*
* API Reference: https://platform.openai.com/docs/api-reference/runs/createRun
*/
post: operations["run_thread_threads__thread_id__runs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/toolset/{toolset_name}/mcp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
get: operations["toolset_mcp_route_toolset__toolset_name__mcp_get"];
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
put: operations["toolset_mcp_route_toolset__toolset_name__mcp_put"];
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
post: operations["toolset_mcp_route_toolset__toolset_name__mcp_post"];
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
delete: operations["toolset_mcp_route_toolset__toolset_name__mcp_delete"];
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
options: operations["toolset_mcp_route_toolset__toolset_name__mcp_options"];
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
head: operations["toolset_mcp_route_toolset__toolset_name__mcp_head"];
/**
* Toolset Mcp Route
* @description Namespace a toolset as its own MCP endpoint.
*
* Connecting to /toolset/<name>/mcp exposes exactly the tools defined in
* the toolset. Access is enforced: non-admin API keys must have the toolset
* listed in their object_permission.mcp_toolsets grant list, or the request
* will be rejected with a 403.
*/
patch: operations["toolset_mcp_route_toolset__toolset_name__mcp_patch"];
trace?: never;
};
"/update/default_team_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Default Team Settings
* @description Update the default team parameters for SSO users.
* These settings will be applied to new teams created from SSO.
*/
patch: operations["update_default_team_settings_update_default_team_settings_patch"];
trace?: never;
};
"/update/internal_user_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Internal User Settings
* @description Update the default internal user parameters for SSO users.
* These settings will be applied to new users who sign in via SSO.
*/
patch: operations["update_internal_user_settings_update_internal_user_settings_patch"];
trace?: never;
};
"/update/mcp_semantic_filter_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Mcp Semantic Filter Settings
* @description Update MCP semantic filter settings in database.
* Settings will be picked up by all pods within approximately 10 seconds via background polling.
*/
patch: operations["update_mcp_semantic_filter_settings_update_mcp_semantic_filter_settings_patch"];
trace?: never;
};
"/update/sso_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Sso Settings
* @description Update SSO configuration by saving to the dedicated SSO table.
*/
patch: operations["update_sso_settings_update_sso_settings_patch"];
trace?: never;
};
"/update/ui_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Ui Settings
* @description Update UI-specific configuration flags.
* Only proxy admins are allowed to modify these settings.
*/
patch: operations["update_ui_settings_update_ui_settings_patch"];
trace?: never;
};
"/update/ui_theme_settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Ui Theme Settings
* @description Update UI theme configuration.
* Updates logo settings for the admin UI.
*/
patch: operations["update_ui_theme_settings_update_ui_theme_settings_patch"];
trace?: never;
};
"/upload/logo": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Upload Logo
* @description Upload a custom logo for the admin UI.
* Accepts image files (PNG, JPG, JPEG, SVG) and stores them for use in the UI.
*/
post: operations["upload_logo_upload_logo_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/usage/ai/chat": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Usage Ai Chat
* @description AI chat about usage data. Streams SSE events with the AI response.
* The AI agent has access to tools that query aggregated daily activity data.
*/
post: operations["usage_ai_chat_usage_ai_chat_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/available_roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui Get Available Role
* @description Endpoint used by Admin UI to show all available roles to assign a user
* return {
* "proxy_admin": {
* "description": "Proxy Admin role",
* "ui_label": "Admin"
* }
* }
*/
get: operations["ui_get_available_role_user_available_roles_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/available_users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Available Enterprise Users
* @description For keys with `max_users` set, return the list of users that are allowed to use the key.
*/
get: operations["available_enterprise_users_user_available_users_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/bulk_update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk User Update
* @description Bulk update multiple users at once.
*
* This endpoint allows updating multiple users in a single request. Each user update
* is processed independently - if some updates fail, others will still succeed.
*
* Parameters:
* - users: Optional[List[UpdateUserRequest]] - List of specific user update requests
* - all_users: Optional[bool] - Set to true to update all users in the system
* - user_updates: Optional[UpdateUserRequest] - Updates to apply when all_users=True
*
* Returns:
* - results: List of individual update results
* - total_requested: Total number of users requested for update
* - successful_updates: Number of successful updates
* - failed_updates: Number of failed updates
*
* Example request for specific users:
* ```bash
* curl --location 'http://0.0.0.0:4000/user/bulk_update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "users": [
* {
* "user_id": "user1",
* "user_role": "internal_user",
* "max_budget": 100.0
* },
* {
* "user_email": "user2@example.com",
* "user_role": "internal_user_viewer",
* "max_budget": 50.0
* }
* ]
* }'
* ```
*
* Example request for all users:
* ```bash
* curl --location 'http://0.0.0.0:4000/user/bulk_update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "all_users": true,
* "user_updates": {
* "user_role": "internal_user",
* "max_budget": 50.0
* }
* }'
* ```
*/
post: operations["bulk_user_update_user_bulk_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/daily/activity": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get User Daily Activity
* @description [BETA] This is a beta endpoint. It will change.
*
* Meant to optimize querying spend data for analytics for a user.
*
* Returns:
* (by date)
* - spend
* - prompt_tokens
* - completion_tokens
* - cache_read_input_tokens
* - cache_creation_input_tokens
* - total_tokens
* - api_requests
* - breakdown by model, api_key, provider
*/
get: operations["get_user_daily_activity_user_daily_activity_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/daily/activity/aggregated": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get User Daily Activity Aggregated
* @description Aggregated analytics for a user's daily activity without pagination.
* Returns the same response shape as the paginated endpoint with page metadata set to single-page.
*/
get: operations["get_user_daily_activity_aggregated_user_daily_activity_aggregated_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Delete User
* @description delete user and associated user keys
*
* ```
* curl --location 'http://0.0.0.0:4000/user/delete'
* --header 'Authorization: Bearer sk-1234'
* --header 'Content-Type: application/json'
* --data-raw '{
* "user_ids": ["45e3e396-ee08-4a61-a88e-16b3ce7e0849"]
* }'
* ```
*
* Parameters:
* - user_ids: List[str] - The list of user id's to be deleted.
*/
post: operations["delete_user_user_delete_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/filter/ui": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Ui View Users
* @description Filter users based on partial match of user_id or email with pagination.
*
* Behaviour depends on the ``scope_user_search_to_org`` UI-setting flag
* (stored in the ``litellm_uisettings`` table):
*
* * **Flag OFF (default):** any authenticated user can search all users.
* * **Flag ON:**
* - Proxy admins see all users.
* - Org admins see only users in their org(s).
* - Team admins for an org-bound team see users in that org.
* - Others receive a 403.
*/
get: operations["ui_view_users_user_filter_ui_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* User Info
* @description [10/07/2024]
* Note: To get all users (+pagination), use `/user/list` endpoint.
*
*
* Use this to get user information. (user row + all user key info)
*
* Example request
* ```
* curl -X GET 'http://localhost:4000/user/info?user_id=krrish7%40berri.ai' --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["user_info_user_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Users
* @description Get a paginated list of users with filtering and sorting options.
*
* Parameters:
* role: Optional[str]
* Filter users by role. Can be one of:
* - proxy_admin
* - proxy_admin_viewer
* - internal_user
* - internal_user_viewer
* user_ids: Optional[str]
* Get list of users by user_ids. Comma separated list of user_ids.
* sso_ids: Optional[str]
* Get list of users by sso_ids. Comma separated list of sso_ids.
* user_email: Optional[str]
* Filter users by partial email match
* team: Optional[str]
* Filter users by team id. Will match if user has this team in their teams array.
* page: int
* The page number to return
* page_size: int
* The number of items per page
* sort_by: Optional[str]
* Column to sort by (e.g. 'user_id', 'user_email', 'created_at', 'spend')
* sort_order: Optional[str]
* Sort order ('asc' or 'desc')
*/
get: operations["get_users_user_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* New User
* @description Use this to create a new INTERNAL user with a budget.
* Internal Users can access LiteLLM Admin UI to make keys, request access to models.
* This creates a new user and generates a new api key for the new user. The new api key is returned.
*
* Returns user id, budget + new key.
*
* Parameters:
* - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated.
* - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to.
* - teams: Optional[list] - specify a list of team id's a user belongs to.
* - user_email: Optional[str] - Specify a user email.
* - send_invite_email: Optional[bool] - Specify if an invite email should be sent.
* - user_role: Optional[str] - Specify a user role - "proxy_admin", "proxy_admin_viewer", "internal_user", "internal_user_viewer", "team", "customer". Info about each role here: `https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20`
* - max_budget: Optional[float] - Specify max budget for a given user.
* - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo").
* - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models). Set to ['no-default-models'] to block all model access. Restricting user to only team-based model access.
* - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute)
* - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute)
* - auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response
* - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases)
* - config: Optional[dict] - [DEPRECATED PARAM] User-specific config.
* - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request-
* - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked.
* - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user
* - policies: Optional[List[str]] - List of policy names to apply to the user. Policies define guardrails, conditions, and inheritance rules.
* - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking.
* - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
* - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.
* - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests.
* - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys)
* - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)
* - mcp_rpm_limit: Optional[dict] - Per-MCP-server rpm limit, keyed by MCP server name {"github": 100, "slack": 200}. Enforced for keys and teams only; values set on a user are stored but not enforced per user.
* - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)
* - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo").
* - agent_id: Optional[str] - The agent id associated with the user.
* - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.
* - duration: Optional[str] - Duration for the key auto-created on `/user/new`. Default is None.
* - key_alias: Optional[str] - Alias for the key auto-created on `/user/new`. Default is None.
* - sso_user_id: Optional[str] - The id of the user in the SSO provider.
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"]}. IF null or {} then no object permission.
* - prompts: Optional[List[str]] - List of allowed prompts for the user. If specified, the user will only be able to use these specific prompts.
* - organizations: List[str] - List of organization id's the user is a member of
* - budget_limits: Optional[list] - List of concurrent budget windows for the user. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}].
* Returns:
* - key: (str) The generated api key for the user
* - expires: (datetime) Datetime object for when key expires.
* - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id.
* - max_budget: (float|None) Max budget for given user.
*
* Usage Example
*
* ```shell
* curl -X POST "http://localhost:4000/user/new" -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "username": "new_user",
* "email": "new_user@example.com"
* }'
* ```
*/
post: operations["new_user_user_new_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/update": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* User Update
* @description Example curl
*
* ```
* curl --location 'http://0.0.0.0:4000/user/update' --header 'Authorization: Bearer sk-1234' --header 'Content-Type: application/json' --data '{
* "user_id": "test-litellm-user-4",
* "user_role": "proxy_admin_viewer"
* }'
* ```
*
* Parameters:
* - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated.
* - user_email: Optional[str] - Specify a user email.
* - password: Optional[str] - Specify a user password.
* - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to.
* - teams: Optional[list] - specify a list of team id's a user belongs to.
* - send_invite_email: Optional[bool] - Specify if an invite email should be sent.
* - user_role: Optional[str] - Specify a user role - "proxy_admin", "proxy_admin_viewer", "internal_user", "internal_user_viewer", "team", "customer". Info about each role here: `https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20`
* - max_budget: Optional[float] - Specify max budget for a given user.
* - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo").
* - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)
* - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute)
* - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute)
* - auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response
* - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases)
* - config: Optional[dict] - [DEPRECATED PARAM] User-specific config.
* - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - ["no-cache", "no-store"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request-
* - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked.
* - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user
* - policies: Optional[List[str]] - List of policy names to apply to the user. Policies define guardrails, conditions, and inheritance rules.
* - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking.
* - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {"team": "core-infra", "app": "app2", "email": "ishaan@berri.ai" }
* - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.
* - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests.
* - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys)
* - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)
* - mcp_rpm_limit: Optional[dict] - Per-MCP-server rpm limit, keyed by MCP server name {"github": 100, "slack": 200}. Enforced for keys and teams only; values set on a user are stored but not enforced per user.
* - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)
* - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds ("30s"), minutes ("30m"), hours ("30h"), days ("30d"), months ("1mo").
* - agent_id: Optional[str] - The agent id associated with the user.
* - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.
* - duration: Optional[str] - [NOT IMPLEMENTED].
* - key_alias: Optional[str] - [NOT IMPLEMENTED].
* - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {"vector_stores": ["vector_store_1", "vector_store_2"]}. IF null or {} then no object permission.
* - prompts: Optional[List[str]] - List of allowed prompts for the user. If specified, the user will only be able to use these specific prompts.
* - budget_limits: Optional[list] - List of concurrent budget windows for the user. Each window specifies a budget_limit, time_period, and optional budget_duration. Example - [{"budget_limit": 10.0, "time_period": "1d"}, {"budget_limit": 50.0, "time_period": "7d"}].
*/
post: operations["user_update_user_update_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/utils/dotprompt_json_converter": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Convert Prompt File To Json
* @description Convert a .prompt file to JSON format.
*
* This endpoint accepts a .prompt file upload and returns the equivalent JSON representation
* that can be stored in a database or used programmatically.
*
* Returns the JSON structure with 'content' and 'metadata' fields.
*/
post: operations["convert_prompt_file_to_json_utils_dotprompt_json_converter_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/utils/supported_openai_params": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Supported Openai Params
* @description Returns supported openai params for a given litellm model name
*
* e.g. `gpt-4` vs `gpt-3.5-turbo`
*
* Example curl:
* ```
* curl -X GET --location 'http://localhost:4000/utils/supported_openai_params?model=gpt-3.5-turbo-16k' --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["supported_openai_params_utils_supported_openai_params_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/utils/test_policies_and_guardrails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Test Policies And Guardrails
* @description Apply policies and/or guardrails to inputs (for compliance UI testing).
*
* Use inputs_list for batch testing: each input is processed as a separate call so
* per-input block/allow and errors are returned.
*
* Use inputs for a single call (legacy).
*/
post: operations["test_policies_and_guardrails_utils_test_policies_and_guardrails_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/utils/token_counter": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Token Counter
* @description Args:
* request: TokenCountRequest
* call_endpoint: bool - When set to "True" it will call the token counting endpoint - e.g Anthropic or Google AI Studio Token Counting APIs.
*
* Returns:
* TokenCountResponse
*/
post: operations["token_counter_utils_token_counter_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/utils/transform_request": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Transform Request */
post: operations["transform_request_utils_transform_request_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
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;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Invoke Agent A2A
* @description Invoke an agent using the A2A protocol (JSON-RPC 2.0).
*
* Supported methods:
* - message/send: Send a message and get a response
* - message/stream: Send a message and stream the response
*/
post: operations["invoke_agent_a2a_v1_a2a__agent_id__message_send_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/access_group": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Access Groups */
get: operations["list_access_groups_v1_access_group_get"];
put?: never;
/** Create Access Group */
post: operations["create_access_group_v1_access_group_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/access_group/{access_group_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Access Group */
get: operations["get_access_group_v1_access_group__access_group_id__get"];
/** Update Access Group */
put: operations["update_access_group_v1_access_group__access_group_id__put"];
post?: never;
/** Delete Access Group */
delete: operations["delete_access_group_v1_access_group__access_group_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/agents": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agents
* @description Example usage:
* ```
* curl -X GET "http://localhost:4000/v1/agents" -H "Content-Type: application/json" -H "Authorization: Bearer your-key" ```
*
* Pass `?health_check=true` to filter out agents whose URL is unreachable:
* ```
* curl -X GET "http://localhost:4000/v1/agents?health_check=true" -H "Content-Type: application/json" -H "Authorization: Bearer your-key" ```
*
* Returns: List[AgentResponse]
*/
get: operations["get_agents_v1_agents_get"];
put?: never;
/**
* Create Agent
* @description Create a new agent
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/v1/agents" \
* -H "Authorization: Bearer <your_api_key>" \
* -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"]
* }
* ]
* },
* "litellm_params": {
* "make_public": true
* }
* }'
* ```
*/
post: operations["create_agent_v1_agents_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/agents/make_public": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Make Agents Public
* @description Make multiple agents publicly discoverable
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/v1/agents/make_public" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json" \
* -d '{
* "agent_ids": ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"]
* }'
* ```
*
* Example Response:
* ```json
* {
* "agent_id": "123e4567-e89b-12d3-a456-426614174000",
* "agent_name": "my-custom-agent",
* "litellm_params": {
* "make_public": true
* },
* "agent_card_params": {...},
* "created_at": "2025-11-15T10:30:00Z",
* "updated_at": "2025-11-15T10:35:00Z",
* "created_by": "user123",
* "updated_by": "user123"
* }
* ```
*/
post: operations["make_agents_public_v1_agents_make_public_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/agents/{agent_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Agent By Id
* @description Get a specific agent by ID
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*/
get: operations["get_agent_by_id_v1_agents__agent_id__get"];
/**
* Update Agent
* @description Update an existing agent
*
* Example Request:
* ```bash
* curl -X PUT "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>" \
* -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": []
* },
* "litellm_params": {
* "make_public": false
* }
* }
* }'
* ```
*/
put: operations["update_agent_v1_agents__agent_id__put"];
post?: never;
/**
* Delete Agent
* @description Delete an agent
*
* Example Request:
* ```bash
* curl -X DELETE "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "message": "Agent 123e4567-e89b-12d3-a456-426614174000 deleted successfully"
* }
* ```
*/
delete: operations["delete_agent_v1_agents__agent_id__delete"];
options?: never;
head?: never;
/**
* Patch Agent
* @description Update an existing agent
*
* Example Request:
* ```bash
* curl -X PUT "http://localhost:4000/agents/123e4567-e89b-12d3-a456-426614174000" \
* -H "Authorization: Bearer <your_api_key>" \
* -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": []
* },
* "litellm_params": {
* "make_public": false
* }
* }
* }'
* ```
*/
patch: operations["patch_agent_v1_agents__agent_id__patch"];
trace?: never;
};
"/v1/agents/{agent_id}/make_public": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Make Agent Public
* @description Make an agent publicly discoverable
*
* Example Request:
* ```bash
* curl -X POST "http://localhost:4000/v1/agents/123e4567-e89b-12d3-a456-426614174000/make_public" \
* -H "Authorization: Bearer <your_api_key>" \
* -H "Content-Type: application/json"
* ```
*
* Example Response:
* ```json
* {
* "agent_id": "123e4567-e89b-12d3-a456-426614174000",
* "agent_name": "my-custom-agent",
* "litellm_params": {
* "make_public": true
* },
* "agent_card_params": {...},
* "created_at": "2025-11-15T10:30:00Z",
* "updated_at": "2025-11-15T10:35:00Z",
* "created_by": "user123",
* "updated_by": "user123"
* }
* ```
*/
post: operations["make_agent_public_v1_agents__agent_id__make_public_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/assistants": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Assistants
* @description Returns a list of assistants.
*
* API Reference docs - https://platform.openai.com/docs/api-reference/assistants/listAssistants
*/
get: operations["get_assistants_v1_assistants_get"];
put?: never;
/**
* Create Assistant
* @description Create assistant
*
* API Reference docs - https://platform.openai.com/docs/api-reference/assistants/createAssistant
*/
post: operations["create_assistant_v1_assistants_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/assistants/{assistant_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Assistant
* @description Delete assistant
*
* API Reference docs - https://platform.openai.com/docs/api-reference/assistants/createAssistant
*/
delete: operations["delete_assistant_v1_assistants__assistant_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/audio/speech": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Audio Speech
* @description Same params as:
*
* https://platform.openai.com/docs/api-reference/audio/createSpeech
*/
post: operations["audio_speech_v1_audio_speech_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/audio/transcriptions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Audio Transcriptions
* @description Same params as:
*
* https://platform.openai.com/docs/api-reference/audio/createTranscription?lang=curl
*/
post: operations["audio_transcriptions_v1_audio_transcriptions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/batches": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Batches
* @description Lists
* This is the equivalent of GET https://api.openai.com/v1/batches/
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches?limit=2 -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*/
get: operations["list_batches_v1_batches_get"];
put?: never;
/**
* Create Batch
* @description Create large batches of API requests for asynchronous processing.
* This is the equivalent of POST https://api.openai.com/v1/batch
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "input_file_id": "file-abc123",
* "endpoint": "/v1/chat/completions",
* "completion_window": "24h"
* }'
* ```
*/
post: operations["create_batch_v1_batches_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/batches/{batch_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Retrieve Batch
* @description Retrieves a batch.
* This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id}
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches/batch_abc123 -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*/
get: operations["retrieve_batch_v1_batches__batch_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/batches/{batch_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Batch
* @description Cancel a batch.
* This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches/batch_abc123/cancel -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -X POST
*
* ```
*/
post: operations["cancel_batch_v1_batches__batch_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/chat/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Chat Completion
* @description Follows the exact same API spec as `OpenAI's Chat API https://platform.openai.com/docs/api-reference/chat`
*
* ```bash
* curl -X POST http://localhost:4000/v1/chat/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-4o",
* "messages": [
* {
* "role": "user",
* "content": "Hello!"
* }
* ]
* }'
* ```
*/
post: operations["chat_completion_v1_chat_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/completions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Completion
* @description Follows the exact same API spec as `OpenAI's Completions API https://platform.openai.com/docs/api-reference/completions`
*
* ```bash
* curl -X POST http://localhost:4000/v1/completions
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "gpt-3.5-turbo-instruct",
* "prompt": "Once upon a time",
* "max_tokens": 50,
* "temperature": 0.7
* }'
* ```
*/
post: operations["completion_v1_completions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/containers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Containers
* @description Container list endpoint for retrieving a list of containers.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers?limit=20&order=desc" -H "Authorization: Bearer sk-1234"
* ```
*
* Or specify provider via header or query param:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers?custom_llm_provider=azure" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["list_containers_v1_containers_get"];
put?: never;
/**
* Create Container
* @description Container creation endpoint for creating new containers.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "name": "My Container",
* "expires_after": {
* "anchor": "last_active_at",
* "minutes": 20
* }
* }'
* ```
*
* Or specify provider via header:
* ```bash
* curl -X POST "http://localhost:4000/v1/containers" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure" -H "Content-Type: application/json" -d '{
* "name": "My Container"
* }'
* ```
*/
post: operations["create_container_v1_containers_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/containers/{container_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Retrieve Container
* @description Container retrieve endpoint for getting details of a specific container.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"
* ```
*
* Or specify provider via header:
* ```bash
* curl -X GET "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"
* ```
*/
get: operations["retrieve_container_v1_containers__container_id__get"];
put?: never;
post?: never;
/**
* Delete Container
* @description Container delete endpoint for deleting a specific container.
*
* Follows the OpenAI Containers API spec:
* https://platform.openai.com/docs/api-reference/containers
*
* Example:
* ```bash
* curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234"
* ```
*
* Or specify provider via header:
* ```bash
* curl -X DELETE "http://localhost:4000/v1/containers/cntr_123" -H "Authorization: Bearer sk-1234" -H "custom-llm-provider: azure"
* ```
*/
delete: operations["delete_container_v1_containers__container_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/containers/{container_id}/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Handler Container Id */
get: operations["handler_container_id_v1_containers__container_id__files_get"];
put?: never;
/** Handler Multipart Upload */
post: operations["handler_multipart_upload_v1_containers__container_id__files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/containers/{container_id}/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Handler Container File */
get: operations["handler_container_file_v1_containers__container_id__files__file_id__get"];
put?: never;
post?: never;
/** Handler Container File */
delete: operations["handler_container_file_v1_containers__container_id__files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/containers/{container_id}/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Handler Binary Content */
get: operations["handler_binary_content_v1_containers__container_id__files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/embeddings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Embeddings
* @description Follows the exact same API spec as `OpenAI's Embeddings API https://platform.openai.com/docs/api-reference/embeddings`
*
* ```bash
* curl -X POST http://localhost:4000/v1/embeddings
* -H "Content-Type: application/json"
* -H "Authorization: Bearer sk-1234"
* -d '{
* "model": "text-embedding-ada-002",
* "input": "The quick brown fox jumps over the lazy dog"
* }'
* ```
*/
post: operations["embeddings_v1_embeddings_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/evals": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Evals
* @description List evaluations with pagination.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
*
* Example usage:
* ```bash
* curl "http://localhost:4000/v1/evals?limit=10" -H "Authorization: Bearer your-key"
* ```
*
* Returns: ListEvalsResponse with list of evaluations
*/
get: operations["list_evals_v1_evals_get"];
put?: never;
/**
* Create Eval
* @description Create a new evaluation.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
*
* Example usage:
* ```bash
* curl -X POST "http://localhost:4000/v1/evals" -H "Authorization: Bearer your-key" -H "Content-Type: application/json" -d '{
* "name": "Test Eval",
* "data_source_config": {"type": "file", "file_id": "file-abc123"},
* "testing_criteria": {"graders": [{"type": "llm_as_judge"}]}
* }'
* ```
*
* Returns: Eval object with id, status, timestamps, etc.
*/
post: operations["create_eval_v1_evals_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/evals/{eval_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Eval
* @description Get a specific evaluation by ID.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
*
* Example usage:
* ```bash
* curl "http://localhost:4000/v1/evals/eval_123" -H "Authorization: Bearer your-key"
* ```
*
* Returns: Eval object
*/
get: operations["get_eval_v1_evals__eval_id__get"];
put?: never;
/**
* Update Eval
* @description Update an evaluation.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
*
* Example usage:
* ```bash
* curl -X POST "http://localhost:4000/v1/evals/eval_123" -H "Authorization: Bearer your-key" -H "Content-Type: application/json" -d '{"name": "Updated Name"}'
* ```
*
* Returns: Updated Eval object
*/
post: operations["update_eval_v1_evals__eval_id__post"];
/**
* Delete Eval
* @description Delete an evaluation.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
*
* Example usage:
* ```bash
* curl -X DELETE "http://localhost:4000/v1/evals/eval_123" -H "Authorization: Bearer your-key"
* ```
*
* Returns: DeleteEvalResponse with deletion confirmation
*/
delete: operations["delete_eval_v1_evals__eval_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/evals/{eval_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Eval
* @description Cancel a running evaluation.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
*
* Example usage:
* ```bash
* curl -X POST "http://localhost:4000/v1/evals/eval_123/cancel" -H "Authorization: Bearer your-key"
* ```
*
* Returns: CancelEvalResponse with cancellation confirmation
*/
post: operations["cancel_eval_v1_evals__eval_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/evals/{eval_id}/runs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Runs
* @description List all runs for an evaluation with pagination.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
*
* Example usage:
* ```bash
* curl "http://localhost:4000/v1/evals/eval_123/runs?limit=10" -H "Authorization: Bearer your-key"
* ```
*
* Returns: ListRunsResponse with list of runs
*/
get: operations["list_runs_v1_evals__eval_id__runs_get"];
put?: never;
/**
* Create Run
* @description Create a new run for an evaluation.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
* - Pass model via body: `{"model": "gpt-4-account-1"}`
* - Pass model via completion.model: `{"completion": {"model": "gpt-4-account-1"}}`
*
* Example usage:
* ```bash
* curl -X POST "http://localhost:4000/v1/evals/eval_123/runs" -H "Authorization: Bearer your-key" -H "Content-Type: application/json" -d '{
* "data_source": {"type": "dataset", "dataset_id": "dataset_123"},
* "completion": {"model": "gpt-4", "temperature": 0.7}
* }'
* ```
*
* Returns: Run object with id, status, timestamps, etc.
*/
post: operations["create_run_v1_evals__eval_id__runs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/evals/{eval_id}/runs/{run_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Run
* @description Get a specific run by ID.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
*
* Example usage:
* ```bash
* curl "http://localhost:4000/v1/evals/eval_123/runs/run_456" -H "Authorization: Bearer your-key"
* ```
*
* Returns: Run object with full details
*/
get: operations["get_run_v1_evals__eval_id__runs__run_id__get"];
put?: never;
/**
* Cancel Run
* @description Cancel a running run.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
*
* Example usage:
* ```bash
* curl -X POST "http://localhost:4000/v1/evals/eval_123/runs/run_456/cancel" -H "Authorization: Bearer your-key"
* ```
*
* Returns: CancelRunResponse with cancellation confirmation
*/
post: operations["cancel_run_v1_evals__eval_id__runs__run_id__post"];
/**
* Delete Run
* @description Delete a run.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: gpt-4-account-1`
* - Pass model via query: `?model=gpt-4-account-1`
*
* Example usage:
* ```bash
* curl -X DELETE "http://localhost:4000/v1/evals/eval_123/runs/run_456" -H "Authorization: Bearer your-key"
* ```
*
* Returns: RunDeleteResponse with deletion confirmation
*/
delete: operations["delete_run_v1_evals__eval_id__runs__run_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Files
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/list
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["list_files_v1_files_get"];
put?: never;
/**
* Create File
* @description Upload a file that can be used across - Assistants API, Batch API
* This is the equivalent of POST https://api.openai.com/v1/files
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/create
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234" -F purpose="batch" -F file="@mydata.jsonl"
* -F expires_after[anchor]="created_at" -F expires_after[seconds]=2592000
* ```
*/
post: operations["create_file_v1_files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get File
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/{file_id}
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123 -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["get_file_v1_files__file_id__get"];
put?: never;
post?: never;
/**
* Delete File
* @description Deletes a specified file. that can be used across - Assistants API, Batch API
* This is the equivalent of DELETE https://api.openai.com/v1/files/{file_id}
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/delete
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123 -X DELETE -H "Authorization: Bearer $OPENAI_API_KEY"
*
* ```
*/
delete: operations["delete_file_v1_files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get File Content
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/{file_id}/content
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve-contents
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123/content -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["get_file_content_v1_files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/fine_tuning/jobs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* ✨ (Enterprise) List Fine-Tuning Jobs
* @description Lists fine-tuning jobs for the organization.
* This is the equivalent of GET https://api.openai.com/v1/fine_tuning/jobs
*
* Supported Query Params:
* - `custom_llm_provider`: Name of the LiteLLM provider
* - `after`: Identifier for the last job from the previous pagination request.
* - `limit`: Number of fine-tuning jobs to retrieve (default is 20).
*/
get: operations["list_fine_tuning_jobs_v1_fine_tuning_jobs_get"];
put?: never;
/**
* ✨ (Enterprise) Create Fine-Tuning Job
* @description Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
* This is the equivalent of POST https://api.openai.com/v1/fine_tuning/jobs
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/fine-tuning/create
*
* Example Curl:
* ```
* curl http://localhost:4000/v1/fine_tuning/jobs -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-3.5-turbo",
* "training_file": "file-abc123",
* "hyperparameters": {
* "n_epochs": 4
* }
* }'
* ```
*/
post: operations["create_fine_tuning_job_v1_fine_tuning_jobs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/fine_tuning/jobs/{fine_tuning_job_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* ✨ (Enterprise) Retrieve Fine-Tuning Job
* @description Retrieves a fine-tuning job.
* This is the equivalent of GET https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}
*
* Supported Query Params:
* - `custom_llm_provider`: Name of the LiteLLM provider
* - `fine_tuning_job_id`: The ID of the fine-tuning job to retrieve.
*/
get: operations["retrieve_fine_tuning_job_v1_fine_tuning_jobs__fine_tuning_job_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* ✨ (Enterprise) Cancel Fine-Tuning Jobs
* @description Cancel a fine-tuning job.
*
* This is the equivalent of POST https://api.openai.com/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel
*
* Supported Query Params:
* - `custom_llm_provider`: Name of the LiteLLM provider
* - `fine_tuning_job_id`: The ID of the fine-tuning job to cancel.
*/
post: operations["cancel_fine_tuning_job_v1_fine_tuning_jobs__fine_tuning_job_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/images/edits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Image Edit Api
* @description Follows the OpenAI Images API spec: https://platform.openai.com/docs/api-reference/images/create
*
* ```bash
* curl -s -D >(grep -i x-request-id >&2) -o >(jq -r '.data[0].b64_json' | base64 --decode > gift-basket.png) -X POST "http://localhost:4000/v1/images/edits" -H "Authorization: Bearer sk-1234" -F "model=gpt-image-1" -F "image[]=@soap.png" -F 'prompt=Create a studio ghibli image of this'
* ```
*/
post: operations["image_edit_api_v1_images_edits_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/images/generations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Image Generation */
post: operations["image_generation_v1_images_generations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/indexes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Index Create
* @description Create an index. Just writes the index to the database.
*
* ```bash
* curl -L -X POST 'http://0.0.0.0:4000/indexes/create' -H 'Content-Type: application/json' -H 'Authorization: Bearer sk-1234' -H 'LiteLLM-Beta: indexes_beta=v1' -d '{
* "index_name": "dall-e-3",
* "vector_store_index": "real-index-name",
* "vector_store_name": "azure-ai-search"
* }'
* ```
*/
post: operations["index_create_v1_indexes_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/access_groups": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Access Groups
* @description Get all available MCP access groups from the database AND config
*/
get: operations["get_mcp_access_groups_v1_mcp_access_groups_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/discover": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Discover Mcp Servers
* @description Returns a curated list of well-known MCP servers for discovery UI
*/
get: operations["discover_mcp_servers_v1_mcp_discover_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/make_public": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Make Mcp Servers Public
* @description Allows making MCP servers public for AI Hub
*/
post: operations["make_mcp_servers_public_v1_mcp_make_public_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/network/client-ip": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Client Ip
* @description Returns the caller's IP address as seen by the proxy.
*/
get: operations["get_client_ip_v1_mcp_network_client_ip_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/openapi-registry": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Openapi Registry
* @description Returns well-known OpenAPI APIs with OAuth 2.0 metadata for the OpenAPI MCP picker
*/
get: operations["get_openapi_registry_v1_mcp_openapi_registry_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/registry.json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Registry
* @description MCP registry endpoint. Spec: https://github.com/modelcontextprotocol/registry
*/
get: operations["get_mcp_registry_v1_mcp_registry_json_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch All Mcp Servers
* @description Returns the mcp server list with associated teams
*/
get: operations["fetch_all_mcp_servers_v1_mcp_server_get"];
/**
* Edit Mcp Server
* @description Allows deleting mcp serves in the db
*/
put: operations["edit_mcp_server_v1_mcp_server_put"];
/**
* Add Mcp Server
* @description Allows creation of mcp servers
*/
post: operations["add_mcp_server_v1_mcp_server_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/health": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Health Check Servers
* @description Health check for MCP servers
*/
get: operations["health_check_servers_v1_mcp_server_health_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/oauth/session": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Add Session Mcp Server
* @description Temporarily cache an MCP server in memory without writing to the database
*/
post: operations["add_session_mcp_server_v1_mcp_server_oauth_session_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/register": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Register Mcp Server
* @description Submit a new MCP server for admin review (non-admin users). Mirrors POST /guardrails/register.
*/
post: operations["register_mcp_server_v1_mcp_server_register_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/submissions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Server Submissions
* @description Returns all MCP servers submitted by non-admin users (admin review queue). Mirrors GET /guardrails/submissions.
*/
get: operations["get_mcp_server_submissions_v1_mcp_server_submissions_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/{server_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch Mcp Server
* @description Returns the mcp server info
*/
get: operations["fetch_mcp_server_v1_mcp_server__server_id__get"];
put?: never;
post?: never;
/**
* Remove Mcp Server
* @description Allows deleting mcp serves in the db
*/
delete: operations["remove_mcp_server_v1_mcp_server__server_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/{server_id}/approve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Approve Mcp Server Submission
* @description Approve a pending MCP server submission (admin only). Mirrors PUT /guardrails/{id}/approve.
*/
put: operations["approve_mcp_server_submission_v1_mcp_server__server_id__approve_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/{server_id}/oauth-user-credential": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Store Mcp Oauth User Credential
* @description Store the calling user's OAuth2 token for an OpenAPI MCP server
*/
post: operations["store_mcp_oauth_user_credential_v1_mcp_server__server_id__oauth_user_credential_post"];
/**
* Delete Mcp Oauth User Credential
* @description Revoke the calling user's stored OAuth2 token for an MCP server
*/
delete: operations["delete_mcp_oauth_user_credential_v1_mcp_server__server_id__oauth_user_credential_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/{server_id}/oauth-user-credential/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Oauth User Credential Status
* @description Check whether the calling user has a stored OAuth2 credential for this MCP server
*/
get: operations["get_mcp_oauth_user_credential_status_v1_mcp_server__server_id__oauth_user_credential_status_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/{server_id}/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Reject Mcp Server Submission
* @description Reject a pending MCP server submission (admin only). Mirrors PUT /guardrails/{id}/reject.
*/
put: operations["reject_mcp_server_submission_v1_mcp_server__server_id__reject_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/server/{server_id}/user-credential": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Store Mcp User Credential
* @description Store or update the calling user's API key for a BYOK MCP server
*/
post: operations["store_mcp_user_credential_v1_mcp_server__server_id__user_credential_post"];
/**
* Delete Mcp User Credential
* @description Delete the calling user's stored API key for a BYOK MCP server
*/
delete: operations["delete_mcp_user_credential_v1_mcp_server__server_id__user_credential_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/tools": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Mcp Tools
* @description Get all MCP tools available for the current key, including those from access groups
*/
get: operations["get_mcp_tools_v1_mcp_tools_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/toolset": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch Mcp Toolsets
* @description List MCP toolsets accessible to the calling key
*/
get: operations["fetch_mcp_toolsets_v1_mcp_toolset_get"];
/**
* Edit Mcp Toolset
* @description Update an existing MCP toolset (admin only)
*/
put: operations["edit_mcp_toolset_v1_mcp_toolset_put"];
/**
* Add Mcp Toolset
* @description Create a new MCP toolset (admin only)
*/
post: operations["add_mcp_toolset_v1_mcp_toolset_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/toolset/{toolset_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Fetch Mcp Toolset
* @description Get a specific MCP toolset by ID
*/
get: operations["fetch_mcp_toolset_v1_mcp_toolset__toolset_id__get"];
put?: never;
post?: never;
/**
* Remove Mcp Toolset
* @description Delete an MCP toolset (admin only)
*/
delete: operations["remove_mcp_toolset_v1_mcp_toolset__toolset_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/mcp/user-credentials": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Mcp User Credentials
* @description List all OAuth2 MCP credentials stored for the calling user
*/
get: operations["list_mcp_user_credentials_v1_mcp_user_credentials_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/memory": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Memory
* @description List memory entries visible to the caller.
*/
get: operations["list_memory_v1_memory_get"];
put?: never;
/**
* Create Memory
* @description Create a new memory entry for the caller (or, for admins, any scope).
*/
post: operations["create_memory_v1_memory_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/memory/{key}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Memory
* @description Get a single memory entry by key, scoped to the caller.
*/
get: operations["get_memory_v1_memory__key__get"];
/**
* Upsert Memory
* @description Upsert a memory entry by key within the caller's scope.
*
* If no row exists for (key, caller.user_id, caller.team_id), create one.
* If one exists, update the value/metadata fields that were provided.
*/
put: operations["upsert_memory_v1_memory__key__put"];
post?: never;
/**
* Delete Memory
* @description Delete a memory entry by key, scoped to the caller.
*/
delete: operations["delete_memory_v1_memory__key__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/messages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Anthropic Response
* @description Use `{PROXY_BASE_URL}/anthropic/v1/messages` instead - [Docs](https://docs.litellm.ai/docs/pass_through/anthropic_completion).
*
* This was a BETA endpoint that calls 100+ LLMs in the anthropic format.
*/
post: operations["anthropic_response_v1_messages_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/messages/count_tokens": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Count Tokens
* @description Count tokens for Anthropic Messages API format.
*
* This endpoint follows the Anthropic Messages API token counting specification.
* It accepts the same parameters as the /v1/messages endpoint but returns
* token counts instead of generating a response.
*
* Example usage:
* ```
* curl -X POST "http://localhost:4000/v1/messages/count_tokens?beta=true" -H "Content-Type: application/json" -H "Authorization: Bearer your-key" -d '{
* "model": "claude-3-sonnet-20240229",
* "messages": [{"role": "user", "content": "Hello Claude!"}]
* }'
* ```
*
* Returns: {"input_tokens": <number>}
*/
post: operations["count_tokens_v1_messages_count_tokens_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/model/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Info V1
* @description Provides more info about each model in /models, including config.yaml descriptions (except api key and api base)
*
* Parameters:
* litellm_model_id: Optional[str] = None (this is the value of `x-litellm-model-id` returned in response headers)
*
* - When litellm_model_id is passed, it will return the info for that specific model
* - When litellm_model_id is not passed, it will return the info for all models
*
* Returns:
* Returns a dictionary containing information about each model.
*
* Example Response:
* ```json
* {
* "data": [
* {
* "model_name": "fake-openai-endpoint",
* "litellm_params": {
* "api_base": "https://exampleopenaiendpoint-production.up.railway.app/",
* "model": "openai/fake"
* },
* "model_info": {
* "id": "112f74fab24a7a5245d2ced3536dd8f5f9192c57ee6e332af0f0512e08bed5af",
* "db_model": false
* }
* }
* ]
* }
*
* ```
*/
get: operations["model_info_v1_v1_model_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/models": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model List
* @description Use `/model/info` - to get detailed model information, example - pricing, mode, etc.
*
* This is just for compatibility with openai projects like aider.
*
* Query Parameters:
* - include_metadata: Include additional metadata in the response with fallback information
* - fallback_type: Type of fallbacks to include ("general", "context_window", "content_policy")
* Defaults to "general" when include_metadata=true
* - scope: Optional scope parameter. Currently only accepts "expand".
* When scope=expand is passed, proxy admins, team admins, and org admins
* will receive all proxy models as if they are a proxy admin.
*/
get: operations["model_list_v1_models_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/models/{model_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Info
* @description Retrieve information about a specific model accessible to your API key.
*
* Returns model details only if the model is available to your API key/team.
* Returns 404 if the model doesn't exist or is not accessible.
*
* Follows OpenAI API specification for individual model retrieval.
* https://platform.openai.com/docs/api-reference/models/retrieve
*/
get: operations["model_info_v1_models__model_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/moderations": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Moderations
* @description The moderations endpoint is a tool you can use to check whether content complies with an LLM Providers policies.
* Quick Start
* ```
* curl --location 'http://0.0.0.0:4000/moderations' --header 'Content-Type: application/json' --header 'Authorization: Bearer sk-1234' --data '{"input": "Sample text goes here", "model": "text-moderation-stable"}'
* ```
*/
post: operations["moderations_v1_moderations_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/ocr": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Ocr
* @description OCR endpoint for extracting text from documents and images.
*
* Supports two input modes:
*
* **1. JSON body** (Mistral OCR API compatible):
* ```bash
* curl -X POST "http://localhost:4000/v1/ocr" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "model": "mistral-ocr",
* "document": {
* "type": "document_url",
* "document_url": "https://arxiv.org/pdf/2201.04234"
* }
* }'
* ```
*
* **2. Multipart form file upload**:
* ```bash
* curl -X POST "http://localhost:4000/v1/ocr" -H "Authorization: Bearer sk-1234" -F "model=mistral-ocr" -F "file=@document.pdf"
* ```
*/
post: operations["ocr_v1_ocr_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/rag/ingest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Rag Ingest
* @description RAG Ingest endpoint - all-in-one document ingestion pipeline.
*
* Supports form upload (for files) or JSON body (for URLs).
*
* ## Form upload (for files):
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/ingest" \
* -H "Authorization: Bearer sk-1234" \
* -F file="@document.pdf" \
* -F 'ingest_options={"vector_store": {"custom_llm_provider": "openai"}}'
* ```
*
* ## JSON body (for URLs):
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/ingest" \
* -H "Authorization: Bearer sk-1234" \
* -H "Content-Type: application/json" \
* -d '{
* "file_url": "https://example.com/document.pdf",
* "ingest_options": {"vector_store": {"custom_llm_provider": "openai"}}
* }'
* ```
*
* ## Bedrock:
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/ingest" \
* -H "Authorization: Bearer sk-1234" \
* -F file="@document.pdf" \
* -F 'ingest_options={"vector_store": {"custom_llm_provider": "bedrock"}}'
* ```
*/
post: operations["rag_ingest_v1_rag_ingest_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/rag/query": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Rag Query
* @description RAG Query endpoint - search vector store, optionally rerank, and generate LLM response.
*
* This endpoint:
* 1. Extracts the query from the last user message
* 2. Searches the vector store for relevant context
* 3. Optionally reranks the results
* 4. Generates an LLM response with the retrieved context
*
* ## Example Request:
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/query" \
* -H "Authorization: Bearer sk-1234" \
* -H "Content-Type: application/json" \
* -d '{
* "model": "gpt-4o-mini",
* "messages": [{"role": "user", "content": "What is LiteLLM?"}],
* "retrieval_config": {
* "vector_store_id": "vs_abc123",
* "custom_llm_provider": "openai",
* "top_k": 5
* }
* }'
* ```
*
* ## With Reranking:
* ```bash
* curl -X POST "http://localhost:4000/v1/rag/query" \
* -H "Authorization: Bearer sk-1234" \
* -H "Content-Type: application/json" \
* -d '{
* "model": "gpt-4o-mini",
* "messages": [{"role": "user", "content": "What is LiteLLM?"}],
* "retrieval_config": {
* "vector_store_id": "vs_abc123",
* "custom_llm_provider": "openai",
* "top_k": 10
* },
* "rerank": {
* "enabled": true,
* "model": "cohere/rerank-english-v3.0",
* "top_n": 3
* }
* }'
* ```
*/
post: operations["rag_query_v1_rag_query_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/realtime": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* WebSocket: realtime_websocket_endpoint
* @description WebSocket connection endpoint
*/
get: operations["websocket_realtime_websocket_endpoint_get_2"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/realtime/calls": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Proxy Realtime Calls */
post: operations["proxy_realtime_calls_v1_realtime_calls_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/realtime/client_secrets": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create Realtime Client Secret */
post: operations["create_realtime_client_secret_v1_realtime_client_secrets_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/rerank": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Rerank */
post: operations["rerank_v1_rerank_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/responses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* WebSocket: responses_websocket_endpoint
* @description WebSocket connection endpoint
*/
get: operations["websocket_responses_websocket_endpoint_get_2"];
put?: never;
/**
* Responses Api
* @description Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses
*
* Supports background mode with polling_via_cache for partial response retrieval.
* When background=true and polling_via_cache is enabled, returns a polling_id immediately
* and streams the response in the background, updating Redis cache.
*
* ```bash
* # Normal request
* curl -X POST http://localhost:4000/v1/responses -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": "Tell me about AI"
* }'
*
* # Background request with polling
* curl -X POST http://localhost:4000/v1/responses -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": "Tell me about AI",
* "background": true
* }'
* ```
*/
post: operations["responses_api_v1_responses_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/responses/compact": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Compact Response
* @description Compact a response by running a compaction pass over a conversation.
*
* Returns encrypted, opaque items that can be used to reduce context size.
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/compact
*
* ```bash
* curl -X POST http://localhost:4000/v1/responses/compact -H "Content-Type: application/json" -H "Authorization: Bearer sk-1234" -d '{
* "model": "gpt-4o",
* "input": [{"role": "user", "content": "Hello"}]
* }'
* ```
*/
post: operations["compact_response_v1_responses_compact_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/responses/{response_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Response
* @description Get a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Returns cumulative cached content from background responses
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/get
*
* ```bash
* # Get polling response
* curl -X GET http://localhost:4000/v1/responses/litellm_poll_abc123 -H "Authorization: Bearer sk-1234"
*
* # Get provider response
* curl -X GET http://localhost:4000/v1/responses/resp_abc123 -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["get_response_v1_responses__response_id__get"];
put?: never;
post?: never;
/**
* Delete Response
* @description Delete a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Deletes from Redis cache
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/delete
*
* ```bash
* curl -X DELETE http://localhost:4000/v1/responses/resp_abc123 -H "Authorization: Bearer sk-1234"
* ```
*/
delete: operations["delete_response_v1_responses__response_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/responses/{response_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Response
* @description Cancel a response by ID.
*
* Supports both:
* - Polling IDs (litellm_poll_*): Cancels background response and updates status in Redis
* - Provider response IDs: Passes through to provider API
*
* Follows the OpenAI Responses API spec: https://platform.openai.com/docs/api-reference/responses/cancel
*
* ```bash
* # Cancel polling response
* curl -X POST http://localhost:4000/v1/responses/litellm_poll_abc123/cancel -H "Authorization: Bearer sk-1234"
*
* # Cancel provider response
* curl -X POST http://localhost:4000/v1/responses/resp_abc123/cancel -H "Authorization: Bearer sk-1234"
* ```
*/
post: operations["cancel_response_v1_responses__response_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/responses/{response_id}/input_items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Response Input Items
* @description List input items for a response.
*/
get: operations["get_response_input_items_v1_responses__response_id__input_items_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search
* @description Search endpoint for performing web searches.
*
* Follows the Perplexity Search API spec:
* https://docs.perplexity.ai/api-reference/search-post
*
* The search_tool_name can be passed either:
* 1. In the URL path: /v1/search/{search_tool_name}
* 2. In the request body: {"search_tool_name": "..."}
*
* Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible):
* ```bash
* curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Example with search_tool_name in body:
* ```bash
* curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "search_tool_name": "litellm-search",
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Request Body Parameters (when search_tool_name not in URL):
* - search_tool_name (str, required if not in URL): Name of the search tool configured in router
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* When using URL path parameter, only Perplexity-compatible parameters are needed in body:
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* Response follows Perplexity Search API format:
* ```json
* {
* "object": "search",
* "results": [
* {
* "title": "Result title",
* "url": "https://example.com",
* "snippet": "Result snippet...",
* "date": "2024-01-01",
* "last_updated": "2024-01-01"
* }
* ]
* }
* ```
*/
post: operations["search_v1_search_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/search/tools": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Search Tools
* @description List all available search tools configured in the router.
*
* This endpoint returns the search tools that are currently loaded and available
* for use with the /v1/search endpoint.
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/search/tools" -H "Authorization: Bearer sk-1234"
* ```
*
* Response:
* ```json
* {
* "object": "list",
* "data": [
* {
* "search_tool_name": "litellm-search",
* "search_provider": "perplexity",
* "description": "Perplexity search tool"
* }
* ]
* }
* ```
*/
get: operations["list_search_tools_v1_search_tools_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/search/{search_tool_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Search
* @description Search endpoint for performing web searches.
*
* Follows the Perplexity Search API spec:
* https://docs.perplexity.ai/api-reference/search-post
*
* The search_tool_name can be passed either:
* 1. In the URL path: /v1/search/{search_tool_name}
* 2. In the request body: {"search_tool_name": "..."}
*
* Example with search_tool_name in URL (recommended - keeps body Perplexity-compatible):
* ```bash
* curl -X POST "http://localhost:4000/v1/search/litellm-search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Example with search_tool_name in body:
* ```bash
* curl -X POST "http://localhost:4000/v1/search" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "search_tool_name": "litellm-search",
* "query": "latest AI developments 2024",
* "max_results": 5,
* "search_domain_filter": ["arxiv.org", "nature.com"],
* "country": "US"
* }'
* ```
*
* Request Body Parameters (when search_tool_name not in URL):
* - search_tool_name (str, required if not in URL): Name of the search tool configured in router
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* When using URL path parameter, only Perplexity-compatible parameters are needed in body:
* - query (str or list[str], required): Search query
* - max_results (int, optional): Maximum number of results (1-20), default 10
* - search_domain_filter (list[str], optional): List of domains to filter (max 20)
* - max_tokens_per_page (int, optional): Max tokens per page, default 1024
* - country (str, optional): Country code filter (e.g., 'US', 'GB', 'DE')
*
* Response follows Perplexity Search API format:
* ```json
* {
* "object": "search",
* "results": [
* {
* "title": "Result title",
* "url": "https://example.com",
* "snippet": "Result snippet...",
* "date": "2024-01-01",
* "last_updated": "2024-01-01"
* }
* ]
* }
* ```
*/
post: operations["search_v1_search__search_tool_name__post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/skills": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Skills
* @description List skills on Anthropic.
*
* Requires `?beta=true` query parameter.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: claude-account-1`
* - Pass model via query: `?model=claude-account-1`
* - Pass model via body: `{"model": "claude-account-1"}`
*
* Example usage:
* ```bash
* # Basic usage
* curl "http://localhost:4000/v1/skills?beta=true&limit=10" -H "Authorization: Bearer your-key"
*
* # With model-based routing
* curl "http://localhost:4000/v1/skills?beta=true&limit=10" -H "Authorization: Bearer your-key" -H "x-litellm-model: claude-account-1"
* ```
*
* Returns: ListSkillsResponse with list of skills
*/
get: operations["list_skills_v1_skills_get"];
put?: never;
/**
* Create Skill
* @description Create a new skill on Anthropic.
*
* Requires `?beta=true` query parameter.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: claude-account-1`
* - Pass model via query: `?model=claude-account-1`
* - Pass model via form field: `model=claude-account-1`
*
* Example usage:
* ```bash
* # Basic usage
* curl -X POST "http://localhost:4000/v1/skills?beta=true" -H "Content-Type: multipart/form-data" -H "Authorization: Bearer your-key" -F "display_title=My Skill" -F "files[]=@skill.zip"
*
* # With model-based routing
* curl -X POST "http://localhost:4000/v1/skills?beta=true" -H "Content-Type: multipart/form-data" -H "Authorization: Bearer your-key" -H "x-litellm-model: claude-account-1" -F "display_title=My Skill" -F "files[]=@skill.zip"
* ```
*
* Returns: Skill object with id, display_title, etc.
*/
post: operations["create_skill_v1_skills_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/skills/{skill_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Skill
* @description Get a specific skill by ID from Anthropic.
*
* Requires `?beta=true` query parameter.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: claude-account-1`
* - Pass model via query: `?model=claude-account-1`
* - Pass model via body: `{"model": "claude-account-1"}`
*
* Example usage:
* ```bash
* # Basic usage
* curl "http://localhost:4000/v1/skills/skill_123?beta=true" -H "Authorization: Bearer your-key"
*
* # With model-based routing
* curl "http://localhost:4000/v1/skills/skill_123?beta=true" -H "Authorization: Bearer your-key" -H "x-litellm-model: claude-account-1"
* ```
*
* Returns: Skill object
*/
get: operations["get_skill_v1_skills__skill_id__get"];
put?: never;
post?: never;
/**
* Delete Skill
* @description Delete a skill by ID from Anthropic.
*
* Requires `?beta=true` query parameter.
*
* Note: Anthropic does not allow deleting skills with existing versions.
*
* Model-based routing (for multi-account support):
* - Pass model via header: `x-litellm-model: claude-account-1`
* - Pass model via query: `?model=claude-account-1`
* - Pass model via body: `{"model": "claude-account-1"}`
*
* Example usage:
* ```bash
* # Basic usage
* curl -X DELETE "http://localhost:4000/v1/skills/skill_123?beta=true" -H "Authorization: Bearer your-key"
*
* # With model-based routing
* curl -X DELETE "http://localhost:4000/v1/skills/skill_123?beta=true" -H "Authorization: Bearer your-key" -H "x-litellm-model: claude-account-1"
* ```
*
* Returns: DeleteSkillResponse with type="skill_deleted"
*/
delete: operations["delete_skill_v1_skills__skill_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/threads": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Threads
* @description Create a thread.
*
* API Reference - https://platform.openai.com/docs/api-reference/threads/createThread
*/
post: operations["create_threads_v1_threads_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/threads/{thread_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Thread
* @description Retrieves a thread.
*
* API Reference - https://platform.openai.com/docs/api-reference/threads/getThread
*/
get: operations["get_thread_v1_threads__thread_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/threads/{thread_id}/messages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Messages
* @description Returns a list of messages for a given thread.
*
* API Reference - https://platform.openai.com/docs/api-reference/messages/listMessages
*/
get: operations["get_messages_v1_threads__thread_id__messages_get"];
put?: never;
/**
* Add Messages
* @description Create a message.
*
* API Reference - https://platform.openai.com/docs/api-reference/messages/createMessage
*/
post: operations["add_messages_v1_threads__thread_id__messages_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/threads/{thread_id}/runs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Run Thread
* @description Create a run.
*
* API Reference: https://platform.openai.com/docs/api-reference/runs/createRun
*/
post: operations["run_thread_v1_threads__thread_id__runs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Tools
* @description List all auto-discovered tools and their policies.
*
* Parameters:
* - input_policy: Optional filter — one of "trusted", "untrusted", "blocked"
*/
get: operations["list_tools_v1_tool_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/policy": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Update Tool Policy
* @description Set the input_policy and/or output_policy for a tool (global), or block for a specific team/key (override).
*
* Parameters:
* - tool_name: str - The tool to update
* - input_policy: optional - "trusted" | "untrusted" | "blocked"
* - output_policy: optional - "trusted" | "untrusted"
* - team_id: optional - if set, create/update override for this team only
* - key_hash: optional - if set, create/update override for this key only
*/
post: operations["update_tool_policy_v1_tool_policy_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/policy/options": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tool Policy Options
* @description Return the available input and output policy options with descriptions.
* Static data — no DB call.
*/
get: operations["get_tool_policy_options_v1_tool_policy_options_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/{tool_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tool
* @description Get details for a single tool.
*/
get: operations["get_tool_v1_tool__tool_name__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/{tool_name}/detail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tool Detail
* @description Get a single tool with its policy overrides (for UI detail view).
*/
get: operations["get_tool_detail_v1_tool__tool_name__detail_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/{tool_name}/logs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tool Usage Logs
* @description Return paginated spend logs for requests that used this tool (from SpendLogToolIndex).
*/
get: operations["get_tool_usage_logs_v1_tool__tool_name__logs_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/tool/{tool_name}/overrides": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Tool Policy Override
* @description Remove a policy override for a tool. Specify the override by team_id or key_hash
* (exactly one required).
*/
delete: operations["delete_tool_policy_override_v1_tool__tool_name__overrides_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/unified_access_group": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Access Groups */
get: operations["list_access_groups_v1_unified_access_group_get"];
put?: never;
/** Create Access Group */
post: operations["create_access_group_v1_unified_access_group_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/unified_access_group/{access_group_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Access Group */
get: operations["get_access_group_v1_unified_access_group__access_group_id__get"];
/** Update Access Group */
put: operations["update_access_group_v1_unified_access_group__access_group_id__put"];
post?: never;
/** Delete Access Group */
delete: operations["delete_access_group_v1_unified_access_group__access_group_id__delete"];
options?: never;
head?: never;
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;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vector Store List
* @description List vector stores.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/list
*/
get: operations["vector_store_list_v1_vector_stores_get"];
put?: never;
/**
* Vector Store Create
* @description Create a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/create
*
* Supports target_model_names parameter for creating vector stores across multiple models:
* ```json
* {
* "name": "my-vector-store",
* "target_model_names": "gpt-4,gemini-2.0"
* }
* ```
*/
post: operations["vector_store_create_v1_vector_stores_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/vector_stores/{vector_store_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vector Store Retrieve
* @description Retrieve a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/retrieve
*/
get: operations["vector_store_retrieve_v1_vector_stores__vector_store_id__get"];
put?: never;
/**
* Vector Store Update
* @description Update a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/modify
*/
post: operations["vector_store_update_v1_vector_stores__vector_store_id__post"];
/**
* Vector Store Delete
* @description Delete a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/delete
*/
delete: operations["vector_store_delete_v1_vector_stores__vector_store_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/vector_stores/{vector_store_id}/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vector Store File List */
get: operations["vector_store_file_list_v1_vector_stores__vector_store_id__files_get"];
put?: never;
/** Vector Store File Create */
post: operations["vector_store_file_create_v1_vector_stores__vector_store_id__files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/vector_stores/{vector_store_id}/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vector Store File Retrieve */
get: operations["vector_store_file_retrieve_v1_vector_stores__vector_store_id__files__file_id__get"];
put?: never;
/** Vector Store File Update */
post: operations["vector_store_file_update_v1_vector_stores__vector_store_id__files__file_id__post"];
/** Vector Store File Delete */
delete: operations["vector_store_file_delete_v1_vector_stores__vector_store_id__files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/vector_stores/{vector_store_id}/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vector Store File Content */
get: operations["vector_store_file_content_v1_vector_stores__vector_store_id__files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/vector_stores/{vector_store_id}/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Vector Store Search
* @description Search a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/search
*/
post: operations["vector_store_search_v1_vector_stores__vector_store_id__search_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video List
* @description Video list endpoint for retrieving a list of videos.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["video_list_v1_videos_get"];
put?: never;
/**
* Video Generation
* @description Video generation endpoint for creating videos from text prompts.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "model": "sora-2",
* "prompt": "A beautiful sunset over the ocean"
* }'
* ```
*/
post: operations["video_generation_v1_videos_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/characters": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Create Character
* @description Create a character from an uploaded video file.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/create-character
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/characters" -H "Authorization: Bearer sk-1234" -F "video=@character_video.mp4" -F "name=my_character"
* ```
*/
post: operations["video_create_character_v1_videos_characters_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/characters/{character_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video Get Character
* @description Retrieve a character by ID.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/get-character
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos/characters/char_123" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["video_get_character_v1_videos_characters__character_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/edits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Edit
* @description Create a video edit job.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/create-edit
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/edits" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{"prompt": "Make it brighter", "video": {"id": "video_123"}}'
* ```
*/
post: operations["video_edit_v1_videos_edits_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/extensions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Extension
* @description Create a video extension.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/create-extension
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/extensions" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{"prompt": "Continue the scene", "seconds": "5", "video": {"id": "video_123"}}'
* ```
*/
post: operations["video_extension_v1_videos_extensions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/{video_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video Status
* @description Video status endpoint for retrieving video status and metadata.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos/video_123" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["video_status_v1_videos__video_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/{video_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video Content
* @description Video content endpoint for downloading video content.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos/{video_id}/content" -H "Authorization: Bearer sk-1234" --output video.mp4
* ```
*/
get: operations["video_content_v1_videos__video_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/videos/{video_id}/remix": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Remix
* @description Video remix endpoint for remixing existing videos with new prompts.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/video_123/remix" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "prompt": "A new version with different colors"
* }'
* ```
*/
post: operations["video_remix_v1_videos__video_id__remix_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/workflows/runs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Workflow Runs
* @description List workflow runs. Filter by workflow_type and/or status.
*
* Non-admin callers only see runs created by their own API key.
*/
get: operations["list_workflow_runs_v1_workflows_runs_get"];
put?: never;
/**
* Create Workflow Run
* @description Create a new workflow run. Returns run_id and session_id.
*
* The caller's API key token is stored as created_by so that non-admin keys
* can only see and modify their own runs.
*/
post: operations["create_workflow_run_v1_workflows_runs_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/workflows/runs/{run_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Workflow Run
* @description Get a workflow run with its most recent event.
*/
get: operations["get_workflow_run_v1_workflows_runs__run_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Update Workflow Run
* @description Update status, metadata, or output on a workflow run.
*/
patch: operations["update_workflow_run_v1_workflows_runs__run_id__patch"];
trace?: never;
};
"/v1/workflows/runs/{run_id}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Workflow Events
* @description Fetch event log for a run, ordered by sequence_number. Default limit 100, max 500.
*/
get: operations["list_workflow_events_v1_workflows_runs__run_id__events_get"];
put?: never;
/**
* Append Workflow Event
* @description Append an event to the run's event log. Also updates run.status if event_type maps to a status.
*
* Sequence numbers use optimistic concurrency: on a unique-constraint collision
* (concurrent append), retries up to _MAX_SEQUENCE_RETRIES times with a fresh MAX+1.
* The event+status update is atomic in a single DB transaction.
*/
post: operations["append_workflow_event_v1_workflows_runs__run_id__events_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/workflows/runs/{run_id}/messages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Workflow Messages
* @description Fetch conversation history for a run, ordered by sequence_number. Default limit 100, max 500.
*/
get: operations["list_workflow_messages_v1_workflows_runs__run_id__messages_get"];
put?: never;
/**
* Append Workflow Message
* @description Append a conversation message. Stores full content (not truncated).
*
* Uses optimistic concurrency for sequence numbers.
*/
post: operations["append_workflow_message_v1_workflows_runs__run_id__messages_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/agents": {
parameters: {
query?: never;
header?: never;
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;
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/interactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Interaction
* @description Create a new interaction using Google's Interactions API.
*
* Per OpenAPI spec: POST /{api_version}/interactions
*
* Supports both model interactions and agent interactions:
* - Model: Provide `model` parameter (e.g., "gemini-2.5-flash")
* - Agent: Provide `agent` parameter (e.g., "deep-research-pro-preview-12-2025")
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1beta/interactions" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "model": "gemini/gemini-2.5-flash",
* "input": "Hello, how are you?"
* }'
* ```
*/
post: operations["create_interaction_v1beta_interactions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/interactions/{interaction_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Interaction
* @description Get an interaction by ID.
*
* Per OpenAPI spec: GET /{api_version}/interactions/{interaction_id}
*/
get: operations["get_interaction_v1beta_interactions__interaction_id__get"];
put?: never;
post?: never;
/**
* Delete Interaction
* @description Delete an interaction by ID.
*
* Per OpenAPI spec: DELETE /{api_version}/interactions/{interaction_id}
*/
delete: operations["delete_interaction_v1beta_interactions__interaction_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/interactions/{interaction_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Interaction
* @description Cancel an interaction by ID.
*
* Per OpenAPI spec: POST /{api_version}/interactions/{interaction_id}:cancel
*/
post: operations["cancel_interaction_v1beta_interactions__interaction_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/models/{model_name}:countTokens": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Google Count Tokens
* @description ```json
* return {
* "totalTokens": 31,
* "totalBillableCharacters": 96,
* "promptTokensDetails": [
* {
* "modality": "TEXT",
* "tokenCount": 31
* }
* ]
* }
* ```
*/
post: operations["google_count_tokens_v1beta_models__model_name__countTokens_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/models/{model_name}:generateContent": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Google Generate Content */
post: operations["google_generate_content_v1beta_models__model_name__generateContent_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1beta/models/{model_name}:streamGenerateContent": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Google Stream Generate Content */
post: operations["google_stream_generate_content_v1beta_models__model_name__streamGenerateContent_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/guardrails/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Guardrails V2
* @description List the guardrails that are available in the database using GuardrailRegistry
*
* 👉 [Guardrail docs](https://docs.litellm.ai/docs/proxy/guardrails/quick_start)
*
* Example Request:
* ```bash
* curl -X GET "http://localhost:4000/v2/guardrails/list" -H "Authorization: Bearer <your_api_key>"
* ```
*
* Example Response:
* ```json
* {
* "guardrails": [
* {
* "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
* "guardrail_name": "my-bedrock-guard",
* "litellm_params": {
* "guardrail": "bedrock",
* "mode": "pre_call",
* "guardrailIdentifier": "ff6ujrregl1q",
* "guardrailVersion": "DRAFT",
* "default_on": true
* },
* "guardrail_info": {
* "description": "Bedrock content moderation guardrail"
* }
* }
* ]
* }
* ```
*/
get: operations["list_guardrails_v2_v2_guardrails_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/key/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Info Key Fn V2
* @description Retrieve information about a list of keys.
*
* **New endpoint**. Currently admin only.
* Parameters:
* keys: Optional[list] = body parameter representing the key(s) in the request
* user_api_key_dict: UserAPIKeyAuth = Dependency representing the user's API key
* Returns:
* Dict containing the key and its associated information
*
* Example Curl:
* ```
* curl -X GET "http://0.0.0.0:4000/key/info" -H "Authorization: Bearer sk-1234" -d {"keys": ["sk-1", "sk-2", "sk-3"]}
* ```
*/
post: operations["info_key_fn_v2_v2_key_info_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Login V2 */
post: operations["login_v2_v2_login_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/model/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Model Info V2
* @description Paginated model metadata for proxy deployments (pricing, provider, team access).
*
* Returns configured router deployments with enriched `model_info` (costs, provider,
* context window, etc.). Sensitive fields such as API keys and api_base are omitted.
*
* Query parameters:
* model: Filter to a single public `model_name`.
* user_models_only: When true, only return models created by the calling user.
* include_team_models: When true, populate `access_via_team_ids` and `direct_access`
* on each model and filter to deployments the caller can use.
* page / size: Pagination controls (defaults: page=1, size=50).
* search: Case-insensitive partial match on model name or team public name.
* modelId: Return a single deployment by LiteLLM model id.
* teamId: Filter to models with direct access or team membership for this team id.
* sortBy / sortOrder: Sort by model_name, created_at, updated_at, costs, or status.
*
* Example request:
* ```
* curl -X GET 'http://localhost:4000/v2/model/info?include_team_models=true&page=1&size=50' \
* --header 'Authorization: Bearer sk-1234'
* ```
*
* Example response:
* ```json
* {
* "data": [
* {
* "model_name": "gpt-4",
* "litellm_params": {"model": "openai/gpt-4.1"},
* "model_info": {
* "id": "abc123",
* "litellm_provider": "openai",
* "access_via_team_ids": ["team-1"],
* "direct_access": true
* }
* }
* ],
* "total_count": 1,
* "current_page": 1,
* "total_pages": 1,
* "size": 50
* }
* ```
*/
get: operations["model_info_v2_v2_model_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/rerank": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Rerank */
post: operations["rerank_v2_rerank_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/team/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Team V2
* @description Get a paginated list of teams with filtering and sorting options.
*
* Parameters:
* user_id: Optional[str]
* Only return teams which this user belongs to
* organization_id: Optional[str]
* Only return teams which belong to this organization
* team_id: Optional[str]
* Filter teams by exact team_id match
* team_alias: Optional[str]
* Filter teams by partial team_alias match
* page: int
* The page number to return
* page_size: int
* The number of items per page
* sort_by: Optional[str]
* Column to sort by (e.g. 'team_id', 'team_alias', 'created_at')
* sort_order: str
* Sort order ('asc' or 'desc')
* status: Optional[str]
* Filter by status. Currently supports "deleted" to query deleted teams.
*/
get: operations["list_team_v2_v2_team_list_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/user/info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* User Info V2
* @description Lightweight endpoint to get user info. Returns only the user object — no keys, no teams objects.
*
* This is the v2 replacement for /user/info, designed to avoid the "god endpoint" problem
* where the old endpoint loaded all keys and teams into memory.
*
* Access control:
* - Proxy admins can query any user
* - Team admins can query users within their teams
* - Internal users can only query themselves (omit user_id or pass own)
* - Returns 404 for non-existent users or unauthorized access
*
* Example request:
* ```
* curl -X GET 'http://localhost:4000/v2/user/info?user_id=user123' \
* --header 'Authorization: Bearer sk-1234'
* ```
*/
get: operations["user_info_v2_v2_user_info_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v3/login": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Login V3 */
post: operations["login_v3_v3_login_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v3/login/exchange": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Login V3 Exchange */
post: operations["login_v3_exchange_v3_login_exchange_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vantage/delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Vantage Settings
* @description Delete Vantage settings from the database.
*
* Only admin users can delete Vantage settings.
*/
delete: operations["delete_vantage_settings_vantage_delete_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vantage/dry-run": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Vantage Dry Run Export
* @description Perform a dry run export using the Vantage logger.
*
* Returns the data that would be exported without actually sending it to Vantage.
*
* Parameters:
* - limit: Limit on number of records to preview (default: 500)
*
* Only admin users can perform Vantage exports.
*/
post: operations["vantage_dry_run_export_vantage_dry_run_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vantage/export": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Vantage Export
* @description Perform an actual export using the Vantage logger.
*
* Exports usage data in FOCUS CSV format to the Vantage API.
*
* Parameters:
* - limit: Optional limit on number of records to export
* - start_time_utc: Optional start time for data export
* - end_time_utc: Optional end time for data export
*
* Only admin users can perform Vantage exports.
*/
post: operations["vantage_export_vantage_export_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vantage/init": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Init Vantage Settings
* @description Initialize Vantage settings and store in the database.
*
* Parameters:
* - api_key: Vantage API key for authentication
* - integration_token: Vantage integration token for the cost-import endpoint
* - base_url: Vantage API base URL (default: https://api.vantage.sh)
*
* Only admin users can configure Vantage settings.
*/
post: operations["init_vantage_settings_vantage_init_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vantage/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Vantage Settings
* @description View current Vantage settings.
*
* Returns the current Vantage configuration with the API key masked for security.
* Only admin users (Proxy Admin or Admin Viewer) can view Vantage settings.
*/
get: operations["get_vantage_settings_vantage_settings_get"];
/**
* Update Vantage Settings
* @description Update existing Vantage settings.
*
* Allows updating individual Vantage configuration fields without requiring all fields.
* Only admin users can update Vantage settings.
*/
put: operations["update_vantage_settings_vantage_settings_put"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vector_store/delete": {
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;
};
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;
options?: never;
head?: never;
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;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vector Store List
* @description List vector stores.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/list
*/
get: operations["vector_store_list_vector_stores_get"];
put?: never;
/**
* Vector Store Create
* @description Create a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/create
*
* Supports target_model_names parameter for creating vector stores across multiple models:
* ```json
* {
* "name": "my-vector-store",
* "target_model_names": "gpt-4,gemini-2.0"
* }
* ```
*/
post: operations["vector_store_create_vector_stores_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vector_stores/{vector_store_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vector Store Retrieve
* @description Retrieve a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/retrieve
*/
get: operations["vector_store_retrieve_vector_stores__vector_store_id__get"];
put?: never;
/**
* Vector Store Update
* @description Update a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/modify
*/
post: operations["vector_store_update_vector_stores__vector_store_id__post"];
/**
* Vector Store Delete
* @description Delete a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/delete
*/
delete: operations["vector_store_delete_vector_stores__vector_store_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vector_stores/{vector_store_id}/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vector Store File List */
get: operations["vector_store_file_list_vector_stores__vector_store_id__files_get"];
put?: never;
/** Vector Store File Create */
post: operations["vector_store_file_create_vector_stores__vector_store_id__files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vector_stores/{vector_store_id}/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vector Store File Retrieve */
get: operations["vector_store_file_retrieve_vector_stores__vector_store_id__files__file_id__get"];
put?: never;
/** Vector Store File Update */
post: operations["vector_store_file_update_vector_stores__vector_store_id__files__file_id__post"];
/** Vector Store File Delete */
delete: operations["vector_store_file_delete_vector_stores__vector_store_id__files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vector_stores/{vector_store_id}/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Vector Store File Content */
get: operations["vector_store_file_content_vector_stores__vector_store_id__files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vector_stores/{vector_store_id}/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Vector Store Search
* @description Search a vector store.
*
* API Reference:
* https://platform.openai.com/docs/api-reference/vector-stores/search
*/
post: operations["vector_store_search_vector_stores__vector_store_id__search_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vertex-ai/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
get: operations["vertex_proxy_route_vertex_ai__endpoint__get_2"];
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
put: operations["vertex_proxy_route_vertex_ai__endpoint__put_2"];
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
post: operations["vertex_proxy_route_vertex_ai__endpoint__post_2"];
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
delete: operations["vertex_proxy_route_vertex_ai__endpoint__delete_2"];
options?: never;
head?: never;
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
patch: operations["vertex_proxy_route_vertex_ai__endpoint__patch_2"];
trace?: never;
};
"/vertex_ai/discovery/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vertex Discovery Proxy Route
* @description Call any vertex discovery endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/vertex_ai/discovery/{endpoint:path}`
*
* Target url: `https://discoveryengine.googleapis.com`
*/
get: operations["vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__get"];
/**
* Vertex Discovery Proxy Route
* @description Call any vertex discovery endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/vertex_ai/discovery/{endpoint:path}`
*
* Target url: `https://discoveryengine.googleapis.com`
*/
put: operations["vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__put"];
/**
* Vertex Discovery Proxy Route
* @description Call any vertex discovery endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/vertex_ai/discovery/{endpoint:path}`
*
* Target url: `https://discoveryengine.googleapis.com`
*/
post: operations["vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__post"];
/**
* Vertex Discovery Proxy Route
* @description Call any vertex discovery endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/vertex_ai/discovery/{endpoint:path}`
*
* Target url: `https://discoveryengine.googleapis.com`
*/
delete: operations["vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__delete"];
options?: never;
head?: never;
/**
* Vertex Discovery Proxy Route
* @description Call any vertex discovery endpoint using the proxy.
*
* Just use `{PROXY_BASE_URL}/vertex_ai/discovery/{endpoint:path}`
*
* Target url: `https://discoveryengine.googleapis.com`
*/
patch: operations["vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__patch"];
trace?: never;
};
"/vertex_ai/live": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* WebSocket: vertex_ai_live_passthrough_endpoint
* @description WebSocket connection endpoint
*/
get: operations["websocket_vertex_ai_live_passthrough_endpoint"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vertex_ai/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
get: operations["vertex_proxy_route_vertex_ai__endpoint__get"];
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
put: operations["vertex_proxy_route_vertex_ai__endpoint__put"];
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
post: operations["vertex_proxy_route_vertex_ai__endpoint__post"];
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
delete: operations["vertex_proxy_route_vertex_ai__endpoint__delete"];
options?: never;
head?: never;
/**
* Vertex Proxy Route
* @description Call LiteLLM proxy via Vertex AI SDK.
*
* [Docs](https://docs.litellm.ai/docs/pass_through/vertex_ai)
*/
patch: operations["vertex_proxy_route_vertex_ai__endpoint__patch"];
trace?: never;
};
"/videos": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video List
* @description Video list endpoint for retrieving a list of videos.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["video_list_videos_get"];
put?: never;
/**
* Video Generation
* @description Video generation endpoint for creating videos from text prompts.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "model": "sora-2",
* "prompt": "A beautiful sunset over the ocean"
* }'
* ```
*/
post: operations["video_generation_videos_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/characters": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Create Character
* @description Create a character from an uploaded video file.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/create-character
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/characters" -H "Authorization: Bearer sk-1234" -F "video=@character_video.mp4" -F "name=my_character"
* ```
*/
post: operations["video_create_character_videos_characters_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/characters/{character_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video Get Character
* @description Retrieve a character by ID.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/get-character
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos/characters/char_123" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["video_get_character_videos_characters__character_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/edits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Edit
* @description Create a video edit job.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/create-edit
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/edits" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{"prompt": "Make it brighter", "video": {"id": "video_123"}}'
* ```
*/
post: operations["video_edit_videos_edits_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/extensions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Extension
* @description Create a video extension.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos/create-extension
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/extensions" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{"prompt": "Continue the scene", "seconds": "5", "video": {"id": "video_123"}}'
* ```
*/
post: operations["video_extension_videos_extensions_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/{video_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video Status
* @description Video status endpoint for retrieving video status and metadata.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos/video_123" -H "Authorization: Bearer sk-1234"
* ```
*/
get: operations["video_status_videos__video_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/{video_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Video Content
* @description Video content endpoint for downloading video content.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X GET "http://localhost:4000/v1/videos/{video_id}/content" -H "Authorization: Bearer sk-1234" --output video.mp4
* ```
*/
get: operations["video_content_videos__video_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/videos/{video_id}/remix": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Video Remix
* @description Video remix endpoint for remixing existing videos with new prompts.
*
* Follows the OpenAI Videos API spec:
* https://platform.openai.com/docs/api-reference/videos
*
* Example:
* ```bash
* curl -X POST "http://localhost:4000/v1/videos/video_123/remix" -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "prompt": "A new version with different colors"
* }'
* ```
*/
post: operations["video_remix_videos__video_id__remix_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/vllm/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Vllm Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/vllm)
*/
get: operations["vllm_proxy_route_vllm__endpoint__get"];
/**
* Vllm Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/vllm)
*/
put: operations["vllm_proxy_route_vllm__endpoint__put"];
/**
* Vllm Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/vllm)
*/
post: operations["vllm_proxy_route_vllm__endpoint__post"];
/**
* Vllm Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/vllm)
*/
delete: operations["vllm_proxy_route_vllm__endpoint__delete"];
options?: never;
head?: never;
/**
* Vllm Proxy Route
* @description [Docs](https://docs.litellm.ai/docs/pass_through/vllm)
*/
patch: operations["vllm_proxy_route_vllm__endpoint__patch"];
trace?: never;
};
"/watsonx/{endpoint}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Watsonx Proxy Route
* @description Watsonx pass-through endpoint.
* Allows using Watsonx APIs with automatic IAM token management and version parameter injection.
*
* Example:
* POST /watsonx/ml/v1/text/tokenization
* POST /watsonx/ml/v1/text/generation
*/
get: operations["watsonx_proxy_route_watsonx__endpoint__get"];
/**
* Watsonx Proxy Route
* @description Watsonx pass-through endpoint.
* Allows using Watsonx APIs with automatic IAM token management and version parameter injection.
*
* Example:
* POST /watsonx/ml/v1/text/tokenization
* POST /watsonx/ml/v1/text/generation
*/
put: operations["watsonx_proxy_route_watsonx__endpoint__put"];
/**
* Watsonx Proxy Route
* @description Watsonx pass-through endpoint.
* Allows using Watsonx APIs with automatic IAM token management and version parameter injection.
*
* Example:
* POST /watsonx/ml/v1/text/tokenization
* POST /watsonx/ml/v1/text/generation
*/
post: operations["watsonx_proxy_route_watsonx__endpoint__post"];
/**
* Watsonx Proxy Route
* @description Watsonx pass-through endpoint.
* Allows using Watsonx APIs with automatic IAM token management and version parameter injection.
*
* Example:
* POST /watsonx/ml/v1/text/tokenization
* POST /watsonx/ml/v1/text/generation
*/
delete: operations["watsonx_proxy_route_watsonx__endpoint__delete"];
options?: never;
head?: never;
/**
* Watsonx Proxy Route
* @description Watsonx pass-through endpoint.
* Allows using Watsonx APIs with automatic IAM token management and version parameter injection.
*
* Example:
* POST /watsonx/ml/v1/text/tokenization
* POST /watsonx/ml/v1/text/generation
*/
patch: operations["watsonx_proxy_route_watsonx__endpoint__patch"];
trace?: never;
};
"/{mcp_server_name}/mcp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
get: operations["dynamic_mcp_route__mcp_server_name__mcp_get"];
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
put: operations["dynamic_mcp_route__mcp_server_name__mcp_put"];
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
post: operations["dynamic_mcp_route__mcp_server_name__mcp_post"];
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
delete: operations["dynamic_mcp_route__mcp_server_name__mcp_delete"];
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
options: operations["dynamic_mcp_route__mcp_server_name__mcp_options"];
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
head: operations["dynamic_mcp_route__mcp_server_name__mcp_head"];
/**
* Dynamic Mcp Route
* @description Handle /{name}/mcp for MCP server aliases, toolsets, MCP access group tags, and comma-separated lists.
*
* Resolution order:
* 1. Registered MCP server alias / name
* 2. Comma-separated list (short-circuits before any DB call)
* 3. Toolset name (DB lookup, cached)
* 4. MCP access group tag (DB lookup, cached)
*/
patch: operations["dynamic_mcp_route__mcp_server_name__mcp_patch"];
trace?: never;
};
"/{provider}/v1/batches": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Batches
* @description Lists
* This is the equivalent of GET https://api.openai.com/v1/batches/
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/list
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches?limit=2 -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*/
get: operations["list_batches__provider__v1_batches_get"];
put?: never;
/**
* Create Batch
* @description Create large batches of API requests for asynchronous processing.
* This is the equivalent of POST https://api.openai.com/v1/batch
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -d '{
* "input_file_id": "file-abc123",
* "endpoint": "/v1/chat/completions",
* "completion_window": "24h"
* }'
* ```
*/
post: operations["create_batch__provider__v1_batches_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{provider}/v1/batches/{batch_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Retrieve Batch
* @description Retrieves a batch.
* This is the equivalent of GET https://api.openai.com/v1/batches/{batch_id}
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/retrieve
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches/batch_abc123 -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json"
* ```
*/
get: operations["retrieve_batch__provider__v1_batches__batch_id__get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{provider}/v1/batches/{batch_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Cancel Batch
* @description Cancel a batch.
* This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel
*
* Example Curl
* ```
* curl http://localhost:4000/v1/batches/batch_abc123/cancel -H "Authorization: Bearer sk-1234" -H "Content-Type: application/json" -X POST
*
* ```
*/
post: operations["cancel_batch__provider__v1_batches__batch_id__cancel_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{provider}/v1/files": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Files
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/list
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["list_files__provider__v1_files_get"];
put?: never;
/**
* Create File
* @description Upload a file that can be used across - Assistants API, Batch API
* This is the equivalent of POST https://api.openai.com/v1/files
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/create
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files -H "Authorization: Bearer sk-1234" -F purpose="batch" -F file="@mydata.jsonl"
* -F expires_after[anchor]="created_at" -F expires_after[seconds]=2592000
* ```
*/
post: operations["create_file__provider__v1_files_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{provider}/v1/files/{file_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get File
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/{file_id}
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123 -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["get_file__provider__v1_files__file_id__get"];
put?: never;
post?: never;
/**
* Delete File
* @description Deletes a specified file. that can be used across - Assistants API, Batch API
* This is the equivalent of DELETE https://api.openai.com/v1/files/{file_id}
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/delete
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123 -X DELETE -H "Authorization: Bearer $OPENAI_API_KEY"
*
* ```
*/
delete: operations["delete_file__provider__v1_files__file_id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/{provider}/v1/files/{file_id}/content": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get File Content
* @description Returns information about a specific file. that can be used across - Assistants API, Batch API
* This is the equivalent of GET https://api.openai.com/v1/files/{file_id}/content
*
* Supports Identical Params as: https://platform.openai.com/docs/api-reference/files/retrieve-contents
*
* Example Curl
* ```
* curl http://localhost:4000/v1/files/file-abc123/content -H "Authorization: Bearer sk-1234"
*
* ```
*/
get: operations["get_file_content__provider__v1_files__file_id__content_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/**
* APIKeySecurityScheme
* @description Defines a security scheme using an API key.
*/
APIKeySecurityScheme: {
/** Description */
description?: string | null;
/**
* In
* @enum {string}
*/
in_: "query" | "header" | "cookie";
/** Name */
name: string;
/**
* Type
* @constant
*/
type: "apiKey";
};
/**
* AccessControl_UI_AccessMode
* @description Model for Controlling UI Access Mode via SSO Groups
*/
AccessControl_UI_AccessMode: {
/** Restricted Sso Group */
restricted_sso_group: string;
/** Sso Group Jwt Field */
sso_group_jwt_field: string;
/**
* Type
* @constant
*/
type: "restricted_sso_group";
};
/** AccessGroupCreateRequest */
AccessGroupCreateRequest: {
/** Access Agent Ids */
access_agent_ids?: string[] | null;
/** Access Group Name */
access_group_name: string;
/** Access Mcp Server Ids */
access_mcp_server_ids?: string[] | null;
/** Access Model Names */
access_model_names?: string[] | null;
/** Assigned Key Ids */
assigned_key_ids?: string[] | null;
/** Assigned Team Ids */
assigned_team_ids?: string[] | null;
/** Description */
description?: string | null;
};
/** AccessGroupInfo */
AccessGroupInfo: {
/** Access Group */
access_group: string;
/** Deployment Count */
deployment_count: number;
/** Model Names */
model_names: string[];
};
/** AccessGroupResponse */
AccessGroupResponse: {
/** Access Agent Ids */
access_agent_ids: string[];
/** Access Group Id */
access_group_id: string;
/** Access Group Name */
access_group_name: string;
/** Access Mcp Server Ids */
access_mcp_server_ids: string[];
/** Access Model Names */
access_model_names: string[];
/** Assigned Key Ids */
assigned_key_ids: string[];
/** Assigned Team Ids */
assigned_team_ids: string[];
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Created By */
created_by?: string | null;
/** Description */
description?: string | null;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated By */
updated_by?: string | null;
};
/** AccessGroupUpdateRequest */
AccessGroupUpdateRequest: {
/** Access Agent Ids */
access_agent_ids?: string[] | null;
/** Access Group Name */
access_group_name?: string | null;
/** Access Mcp Server Ids */
access_mcp_server_ids?: string[] | null;
/** Access Model Names */
access_model_names?: string[] | null;
/** Assigned Key Ids */
assigned_key_ids?: string[] | null;
/** Assigned Team Ids */
assigned_team_ids?: string[] | null;
/** Description */
description?: string | null;
};
/**
* ActiveUsersAnalyticsResponse
* @description Response for active users analytics
*/
ActiveUsersAnalyticsResponse: {
/** Results */
results: components["schemas"]["TagActiveUsersResponse"][];
};
/** AddTeamCallback */
AddTeamCallback: {
/** Callback Name */
callback_name: string;
/**
* Callback Type
* @default success_and_failure
*/
callback_type: ("success" | "failure" | "success_and_failure") | null;
/** Callback Vars */
callback_vars: {
[key: string]: string;
};
};
/**
* AgentCapabilities
* @description Defines optional capabilities supported by an agent.
*/
AgentCapabilities: {
/** Extensions */
extensions?: components["schemas"]["AgentExtension"][] | null;
/** Pushnotifications */
pushNotifications?: boolean | null;
/** Statetransitionhistory */
stateTransitionHistory?: boolean | null;
/** Streaming */
streaming?: boolean | null;
};
/**
* AgentCard
* @description The AgentCard is a self-describing manifest for an agent.
* It provides essential metadata including the agent's identity, capabilities,
* skills, supported communication methods, and security requirements.
*/
AgentCard: {
/** Additionalinterfaces */
additionalInterfaces?: components["schemas"]["AgentInterface"][] | null;
capabilities?: components["schemas"]["AgentCapabilities"];
/** Defaultinputmodes */
defaultInputModes?: string[];
/** Defaultoutputmodes */
defaultOutputModes?: string[];
/** Description */
description?: string;
/** Documentationurl */
documentationUrl?: string | null;
/** Iconurl */
iconUrl?: string | null;
/** Name */
name?: string;
/** Preferredtransport */
preferredTransport?: string | null;
/** Protocolversion */
protocolVersion?: string;
provider?: components["schemas"]["AgentProvider"] | null;
/** Security */
security?: {
[key: string]: string[];
}[] | null;
/** Securityschemes */
securitySchemes?: {
[key: string]: components["schemas"]["APIKeySecurityScheme"] | components["schemas"]["HTTPAuthSecurityScheme"] | components["schemas"]["OAuth2SecurityScheme"] | components["schemas"]["OpenIdConnectSecurityScheme"] | components["schemas"]["MutualTLSSecurityScheme"];
} | null;
/** Signatures */
signatures?: components["schemas"]["AgentCardSignature"][] | null;
/** Skills */
skills?: components["schemas"]["AgentSkill"][];
/** Supportsauthenticatedextendedcard */
supportsAuthenticatedExtendedCard?: boolean | null;
/** Url */
url?: string;
/** Version */
version?: string;
};
/**
* AgentCardSignature
* @description Represents a JWS signature of an AgentCard.
*/
AgentCardSignature: {
/** Header */
header?: {
[key: string]: unknown;
} | null;
/** Protected */
protected?: string;
/** Signature */
signature?: string;
};
/** AgentConfig */
AgentConfig: {
agent_card_params: components["schemas"]["AgentCard"];
/** Agent Name */
agent_name: string;
/** Extra Headers */
extra_headers?: string[] | null;
/** Litellm Params */
litellm_params?: {
[key: string]: unknown;
};
object_permission?: components["schemas"]["AgentObjectPermission"];
/** Rpm Limit */
rpm_limit?: number | null;
/** Session Rpm Limit */
session_rpm_limit?: number | null;
/** Session Tpm Limit */
session_tpm_limit?: number | null;
/** Static Headers */
static_headers?: {
[key: string]: string;
} | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/** AgentCreateInfo */
AgentCreateInfo: {
/** Agent Type */
agent_type: string;
/** Agent Type Display Name */
agent_type_display_name: string;
/** Credential Fields */
credential_fields: components["schemas"]["AgentCredentialField"][];
/** Description */
description?: string | null;
/** Litellm Params Template */
litellm_params_template?: {
[key: string]: string;
} | null;
/** Logo Url */
logo_url?: string | null;
/** Model Template */
model_template?: string | null;
};
/** AgentCredentialField */
AgentCredentialField: {
/** Default Value */
default_value?: string | null;
/**
* Field Type
* @default text
* @enum {string}
*/
field_type: "text" | "password" | "select" | "upload" | "textarea";
/** Include In Litellm Params */
include_in_litellm_params?: boolean | null;
/** Key */
key: string;
/** Label */
label: string;
/** Options */
options?: string[] | null;
/** Placeholder */
placeholder?: string | null;
/**
* Required
* @default false
*/
required: boolean;
/** Tooltip */
tooltip?: string | null;
};
/**
* AgentExtension
* @description A declaration of a protocol extension supported by an Agent.
*/
AgentExtension: {
/** Description */
description?: string | null;
/** Params */
params?: {
[key: string]: unknown;
} | null;
/** Required */
required?: boolean | null;
/** Uri */
uri?: string;
};
/**
* AgentInterface
* @description Declares a combination of a target URL and a transport protocol.
*/
AgentInterface: {
/** Transport */
transport?: string;
/** Url */
url?: string;
};
/** AgentMakePublicResponse */
AgentMakePublicResponse: {
/** Message */
message: string;
/** Public Agent Groups */
public_agent_groups: string[];
/** Updated By */
updated_by: string;
};
/** AgentObjectPermission */
AgentObjectPermission: {
/** Agents */
agents?: string[] | null;
/** Mcp Access Groups */
mcp_access_groups?: string[] | null;
/** Mcp Servers */
mcp_servers?: string[] | null;
/** Mcp Tool Permissions */
mcp_tool_permissions?: {
[key: string]: string[];
} | null;
/** Models */
models?: string[] | null;
};
/**
* AgentProvider
* @description Represents the service provider of an agent.
*/
AgentProvider: {
/** Organization */
organization?: string;
/** Url */
url?: string;
};
/** AgentResponse */
AgentResponse: {
/** Agent Card Params */
agent_card_params: {
[key: string]: unknown;
};
/** Agent Id */
agent_id: string;
/** Agent Name */
agent_name: string;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Extra Headers */
extra_headers?: string[] | null;
/** Litellm Params */
litellm_params?: {
[key: string]: unknown;
} | null;
/** Object Permission */
object_permission?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Session Rpm Limit */
session_rpm_limit?: number | null;
/** Session Tpm Limit */
session_tpm_limit?: number | null;
/** Spend */
spend?: number | null;
/** Static Headers */
static_headers?: {
[key: string]: string;
} | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
};
/**
* AgentSkill
* @description Represents a distinct capability or function that an agent can perform.
*/
AgentSkill: {
/** Description */
description?: string;
/** Examples */
examples?: string[] | null;
/** Id */
id?: string;
/** Inputmodes */
inputModes?: string[] | null;
/** Name */
name?: string;
/** Outputmodes */
outputModes?: string[] | null;
/** Security */
security?: {
[key: string]: string[];
}[] | null;
/** Tags */
tags?: string[];
};
/**
* AlertType
* @description Enum for alert types and management event types
* @enum {string}
*/
AlertType: "llm_exceptions" | "llm_too_slow" | "llm_requests_hanging" | "budget_alerts" | "spend_reports" | "failed_tracking_spend" | "db_exceptions" | "daily_reports" | "cooldown_deployment" | "new_model_added" | "outage_alerts" | "region_outage_alerts" | "fallback_reports" | "new_virtual_key_created" | "virtual_key_updated" | "virtual_key_deleted" | "new_team_created" | "team_updated" | "team_deleted" | "new_internal_user_created" | "internal_user_updated" | "internal_user_deleted";
/** AllowedVectorStoreIndexItem */
AllowedVectorStoreIndexItem: {
/** Index Name */
index_name: string;
/** Index Permissions */
index_permissions: ("read" | "write")[];
};
/** ApplyGuardrailRequest */
ApplyGuardrailRequest: {
/** Entities */
entities?: components["schemas"]["PiiEntityType"][] | null;
/** Guardrail Name */
guardrail_name: string;
/**
* Input Type
* @default request
*/
input_type: string;
/** Language */
language?: string | null;
/** Messages */
messages?: {
[key: string]: unknown;
}[] | null;
/** Text */
text: string;
};
/** ApplyGuardrailResponse */
ApplyGuardrailResponse: {
/** Response Text */
response_text: string;
};
/**
* AttachmentImpactResponse
* @description Response for estimating the impact of a policy attachment.
*/
AttachmentImpactResponse: {
/**
* Affected Keys Count
* @description Number of keys that would be affected (named + unnamed).
* @default 0
*/
affected_keys_count: number;
/**
* Affected Teams Count
* @description Number of teams that would be affected (named + unnamed).
* @default 0
*/
affected_teams_count: number;
/**
* Sample Keys
* @description Sample of affected key aliases (up to 10).
*/
sample_keys?: string[];
/**
* Sample Teams
* @description Sample of affected team aliases (up to 10).
*/
sample_teams?: string[];
/**
* Unnamed Keys Count
* @description Number of affected keys without an alias.
* @default 0
*/
unnamed_keys_count: number;
/**
* Unnamed Teams Count
* @description Number of affected teams without an alias.
* @default 0
*/
unnamed_teams_count: number;
};
/**
* AuditLogResponse
* @description Response model for a single audit log entry
*/
AuditLogResponse: {
/** Action */
action: string;
/** Before Value */
before_value?: {
[key: string]: unknown;
} | null;
/** Changed By */
changed_by: string;
/** Changed By Api Key */
changed_by_api_key: string;
/** Id */
id: string;
/** Object Id */
object_id: string;
/** Table Name */
table_name: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated Values */
updated_values?: {
[key: string]: unknown;
} | null;
};
/** BaseLitellmParams */
"BaseLitellmParams-Input": {
/**
* 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
* @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;
/**
* Template Id
* @description The ID of your Model Armor template
*/
template_id?: string | 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
* @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;
/**
* Template Id
* @description The ID of your Model Armor template
*/
template_id?: string | 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;
};
/** BaseModel */
BaseModel: Record<string, never>;
/** BlockKeyRequest */
BlockKeyRequest: {
/** Key */
key: string;
};
/** BlockTeamRequest */
BlockTeamRequest: {
/** Team Id */
team_id: string;
};
/** BlockUsers */
BlockUsers: {
/** User Ids */
user_ids: string[];
};
/**
* BlockedWord
* @description Represents a blocked word with its action and optional description
*/
BlockedWord: {
/** @description Action to take when keyword is detected (BLOCK or MASK) */
action: components["schemas"]["ContentFilterAction"];
/**
* Description
* @description Optional description explaining why this keyword is sensitive
*/
description?: string | null;
/**
* Keyword
* @description The keyword to block or mask
*/
keyword: string;
};
/** BlogPost */
BlogPost: {
/** Date */
date: string;
/** Description */
description: string;
/** Title */
title: string;
/** Url */
url: string;
};
/** BlogPostsResponse */
BlogPostsResponse: {
/** Posts */
posts: components["schemas"]["BlogPost"][];
};
/** Body_audio_transcriptions_audio_transcriptions_post */
Body_audio_transcriptions_audio_transcriptions_post: {
/** File */
file: string;
};
/** Body_audio_transcriptions_v1_audio_transcriptions_post */
Body_audio_transcriptions_v1_audio_transcriptions_post: {
/** File */
file: string;
};
/** 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: string;
};
/** Body_create_file__provider__v1_files_post */
Body_create_file__provider__v1_files_post: {
/**
* Custom Llm Provider
* @default openai
*/
custom_llm_provider: string;
/** File */
file: string;
/** Litellm Metadata */
litellm_metadata?: string | null;
/** Purpose */
purpose: string;
/**
* Target Model Names
* @default
*/
target_model_names: string;
/**
* Target Storage
* @default default
*/
target_storage: string;
};
/** Body_create_file_files_post */
Body_create_file_files_post: {
/**
* Custom Llm Provider
* @default openai
*/
custom_llm_provider: string;
/** File */
file: string;
/** Litellm Metadata */
litellm_metadata?: string | null;
/** Purpose */
purpose: string;
/**
* Target Model Names
* @default
*/
target_model_names: string;
/**
* Target Storage
* @default default
*/
target_storage: string;
};
/** Body_create_file_v1_files_post */
Body_create_file_v1_files_post: {
/**
* Custom Llm Provider
* @default openai
*/
custom_llm_provider: string;
/** File */
file: string;
/** Litellm Metadata */
litellm_metadata?: string | null;
/** Purpose */
purpose: string;
/**
* Target Model Names
* @default
*/
target_model_names: string;
/**
* Target Storage
* @default default
*/
target_storage: string;
};
/** Body_image_edit_api_images_edits_post */
Body_image_edit_api_images_edits_post: {
/** Image */
image?: string[] | null;
/** Image[] */
"image[]"?: string[] | null;
/** Mask */
mask?: string[] | null;
/** Mask[] */
"mask[]"?: string[] | null;
};
/** Body_image_edit_api_openai_deployments__model__images_edits_post */
Body_image_edit_api_openai_deployments__model__images_edits_post: {
/** Image */
image?: string[] | null;
/** Image[] */
"image[]"?: string[] | null;
/** Mask */
mask?: string[] | null;
/** Mask[] */
"mask[]"?: string[] | null;
};
/** Body_image_edit_api_v1_images_edits_post */
Body_image_edit_api_v1_images_edits_post: {
/** Image */
image?: string[] | null;
/** Image[] */
"image[]"?: string[] | null;
/** Mask */
mask?: string[] | null;
/** Mask[] */
"mask[]"?: string[] | null;
};
/** Body_test_model_connection_health_test_connection_post */
Body_test_model_connection_health_test_connection_post: {
/**
* Litellm Params
* @description Parameters for litellm.completion, litellm.embedding for the health check
*/
litellm_params?: {
[key: string]: unknown;
};
/**
* Mode
* @description The mode to test the model with
* @default chat
*/
mode: ("chat" | "completion" | "embedding" | "audio_speech" | "audio_transcription" | "image_generation" | "video_generation" | "batch" | "rerank" | "realtime" | "responses" | "ocr") | null;
/**
* Model Info
* @description Model info for the health check
*/
model_info?: {
[key: string]: unknown;
};
};
/** Body_upload_logo_upload_logo_post */
Body_upload_logo_upload_logo_post: {
/** File */
file: string;
};
/** Body_video_create_character_v1_videos_characters_post */
Body_video_create_character_v1_videos_characters_post: {
/** Name */
name: string;
/** Video */
video: string;
};
/** Body_video_create_character_videos_characters_post */
Body_video_create_character_videos_characters_post: {
/** Name */
name: string;
/** Video */
video: string;
};
/** Body_video_generation_v1_videos_post */
Body_video_generation_v1_videos_post: {
/** Input Reference */
input_reference?: string | null;
};
/** Body_video_generation_videos_post */
Body_video_generation_videos_post: {
/** Input Reference */
input_reference?: string | null;
};
/**
* BreakdownMetrics
* @description Breakdown of spend by different dimensions
*/
BreakdownMetrics: {
/** Api Keys */
api_keys?: {
[key: string]: components["schemas"]["KeyMetricWithMetadata"];
};
/** Endpoints */
endpoints?: {
[key: string]: components["schemas"]["MetricWithMetadata"];
};
/** Entities */
entities?: {
[key: string]: components["schemas"]["MetricWithMetadata"];
};
/** Mcp Servers */
mcp_servers?: {
[key: string]: components["schemas"]["MetricWithMetadata"];
};
/** Model Groups */
model_groups?: {
[key: string]: components["schemas"]["MetricWithMetadata"];
};
/** Models */
models?: {
[key: string]: components["schemas"]["MetricWithMetadata"];
};
/** Providers */
providers?: {
[key: string]: components["schemas"]["MetricWithMetadata"];
};
};
/** BudgetConfig */
BudgetConfig: {
/** Budget Duration */
budget_duration?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/** BudgetDeleteRequest */
BudgetDeleteRequest: {
/** Id */
id: string;
};
/**
* BudgetLimitEntry
* @description A single budget window with its own limit and independent reset schedule.
*/
BudgetLimitEntry: {
/** Budget Duration */
budget_duration: string;
/** Max Budget */
max_budget: number;
/** Reset At */
reset_at?: string | null;
};
/** BudgetNewRequest */
BudgetNewRequest: {
/**
* Budget Duration
* @description Max duration budget should be set for (e.g. '1hr', '1d', '28d')
*/
budget_duration?: string | null;
/**
* Budget Id
* @description The unique budget id.
*/
budget_id?: string | null;
/**
* Budget Reset At
* @description Datetime when the budget is reset
*/
budget_reset_at?: string | null;
/**
* Max Budget
* @description Requests will fail if this budget (in USD) is exceeded.
*/
max_budget?: number | null;
/**
* Max Parallel Requests
* @description Max concurrent requests allowed for this budget id.
*/
max_parallel_requests?: number | null;
/**
* Model Max Budget
* @description Max budget for each model (e.g. {'gpt-4o': {'max_budget': '0.0000001', 'budget_duration': '1d', 'tpm_limit': 1000, 'rpm_limit': 1000}})
*/
model_max_budget?: {
[key: string]: components["schemas"]["BudgetConfig"];
} | null;
/**
* Rpm Limit
* @description Max requests per minute, allowed for this budget id.
*/
rpm_limit?: number | null;
/**
* Soft Budget
* @description Requests will NOT fail if this is exceeded. Will fire alerting though.
*/
soft_budget?: number | null;
/**
* Tpm Limit
* @description Max tokens per minute, allowed for this budget id.
*/
tpm_limit?: number | null;
};
/** BudgetRequest */
BudgetRequest: {
/** Budgets */
budgets: string[];
};
/**
* BulkTeamMemberAddRequest
* @description Request for bulk team member addition
*/
BulkTeamMemberAddRequest: {
/**
* All Users
* @default false
*/
all_users: boolean | null;
/** Max Budget In Team */
max_budget_in_team?: number | null;
/** Members */
members?: components["schemas"]["Member"][] | null;
/** Team Id */
team_id: string;
};
/**
* BulkTeamMemberAddResponse
* @description Response for bulk team member add operations
*/
BulkTeamMemberAddResponse: {
/** Failed Additions */
failed_additions: number;
/** Results */
results: components["schemas"]["TeamMemberAddResult"][];
/** Successful Additions */
successful_additions: number;
/** Team Id */
team_id: string;
/** Total Requested */
total_requested: number;
/** Updated Team */
updated_team?: {
[key: string]: unknown;
} | null;
};
/**
* BulkUpdateKeyRequest
* @description Request for bulk key updates
*/
BulkUpdateKeyRequest: {
/** Keys */
keys: components["schemas"]["BulkUpdateKeyRequestItem"][];
};
/**
* BulkUpdateKeyRequestItem
* @description Individual key update request item
*/
BulkUpdateKeyRequestItem: {
/** Budget Id */
budget_id?: string | null;
/** Key */
key: string;
/** Max Budget */
max_budget?: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
};
/**
* BulkUpdateKeyResponse
* @description Response for bulk key update operations
*/
BulkUpdateKeyResponse: {
/** Failed Updates */
failed_updates: components["schemas"]["FailedKeyUpdate"][];
/** Successful Updates */
successful_updates: components["schemas"]["SuccessfulKeyUpdate"][];
/** Total Requested */
total_requested: number;
};
/**
* BulkUpdateTeamKeysRequest
* @description Apply one update payload to many keys inside a team; provide either `key_ids` or `all_keys_in_team=True`.
*/
BulkUpdateTeamKeysRequest: {
/**
* All Keys In Team
* @default false
*/
all_keys_in_team: boolean;
/** Key Ids */
key_ids?: string[] | null;
/** Team Id */
team_id: string;
update_fields: components["schemas"]["KeyUpdateFields"];
};
/**
* BulkUpdateTeamMemberPermissionsRequest
* @description Request to bulk-update team member permissions across teams.
*/
BulkUpdateTeamMemberPermissionsRequest: {
/**
* Apply To All Teams
* @default false
*/
apply_to_all_teams: boolean;
/** Permissions */
permissions: components["schemas"]["KeyManagementRoutes"][];
/** Team Ids */
team_ids?: string[] | null;
};
/**
* BulkUpdateTeamMemberPermissionsResponse
* @description Response for bulk team member permissions update.
*/
BulkUpdateTeamMemberPermissionsResponse: {
/** Message */
message: string;
/** Permissions Appended */
permissions_appended?: string[] | null;
/** Teams Updated */
teams_updated: number;
};
/**
* BulkUpdateUserRequest
* @description Request for bulk user updates
*/
BulkUpdateUserRequest: {
/**
* All Users
* @default false
*/
all_users: boolean | null;
user_updates?: components["schemas"]["UpdateUserRequestNoUserIDorEmail"] | null;
/** Users */
users?: components["schemas"]["UpdateUserRequest"][] | null;
};
/**
* BulkUpdateUserResponse
* @description Response for bulk user update operations
*/
BulkUpdateUserResponse: {
/** Failed Updates */
failed_updates: number;
/** Results */
results: components["schemas"]["UserUpdateResult"][];
/** Successful Updates */
successful_updates: number;
/** Total Requested */
total_requested: number;
};
/** CachePingResponse */
CachePingResponse: {
/** Cache Type */
cache_type: string;
/** Health Check Cache Params */
health_check_cache_params?: {
[key: string]: unknown;
} | null;
/** Litellm Cache Params */
litellm_cache_params?: string | null;
/** Ping Response */
ping_response?: boolean | null;
/** Set Cache Response */
set_cache_response?: string | null;
/** Status */
status: string;
};
/** CacheSettingsField */
CacheSettingsField: {
/** Field Default */
field_default?: unknown;
/** Field Description */
field_description: string;
/** Field Name */
field_name: string;
/** Field Type */
field_type: string;
/** Field Value */
field_value: unknown;
/** Link */
link?: string | null;
/** Options */
options?: string[] | null;
/** Redis Type */
redis_type?: string | null;
/** Ui Field Name */
ui_field_name: string;
};
/** CacheSettingsResponse */
CacheSettingsResponse: {
/**
* Current Values
* @description Current values of cache settings
*/
current_values: {
[key: string]: unknown;
};
/**
* Fields
* @description List of all configurable cache settings with metadata
*/
fields: components["schemas"]["CacheSettingsField"][];
/**
* Redis Type Descriptions
* @description Descriptions for each Redis type option
*/
redis_type_descriptions: {
[key: string]: string;
};
};
/** CacheSettingsUpdateRequest */
CacheSettingsUpdateRequest: {
/**
* Cache Settings
* @description Cache settings to save
*/
cache_settings: {
[key: string]: unknown;
};
};
/** CacheTestRequest */
CacheTestRequest: {
/**
* Cache Settings
* @description Cache settings to test connection with
*/
cache_settings: {
[key: string]: unknown;
};
};
/** CacheTestResponse */
CacheTestResponse: {
/**
* Error
* @description Error message if connection failed
*/
error?: string | null;
/**
* Message
* @description Connection result message
*/
message: string;
/**
* Status
* @description Connection status: 'success' or 'failed'
*/
status: string;
};
/**
* CallTypes
* @enum {string}
*/
CallTypes: "embedding" | "aembedding" | "completion" | "acompletion" | "atext_completion" | "text_completion" | "image_generation" | "aimage_generation" | "image_edit" | "aimage_edit" | "moderation" | "amoderation" | "atranscription" | "transcription" | "aspeech" | "speech" | "rerank" | "arerank" | "search" | "asearch" | "_arealtime" | "_aresponses_websocket" | "create_batch" | "acreate_batch" | "aretrieve_batch" | "retrieve_batch" | "acancel_batch" | "cancel_batch" | "pass_through_endpoint" | "anthropic_messages" | "get_assistants" | "aget_assistants" | "create_assistants" | "acreate_assistants" | "delete_assistant" | "adelete_assistant" | "acreate_thread" | "create_thread" | "aget_thread" | "get_thread" | "a_add_message" | "add_message" | "aget_messages" | "get_messages" | "arun_thread" | "run_thread" | "arun_thread_stream" | "run_thread_stream" | "afile_retrieve" | "file_retrieve" | "afile_delete" | "file_delete" | "afile_list" | "file_list" | "acreate_file" | "create_file" | "afile_content" | "file_content" | "create_fine_tuning_job" | "acreate_fine_tuning_job" | "create_video" | "acreate_video" | "avideo_retrieve" | "video_retrieve" | "avideo_content" | "video_content" | "video_remix" | "avideo_remix" | "video_list" | "avideo_list" | "video_retrieve_job" | "avideo_retrieve_job" | "video_delete" | "avideo_delete" | "video_create_character" | "avideo_create_character" | "video_get_character" | "avideo_get_character" | "video_edit" | "avideo_edit" | "video_extension" | "avideo_extension" | "vector_store_file_create" | "avector_store_file_create" | "vector_store_file_list" | "avector_store_file_list" | "vector_store_file_retrieve" | "avector_store_file_retrieve" | "vector_store_file_content" | "avector_store_file_content" | "vector_store_file_update" | "avector_store_file_update" | "vector_store_file_delete" | "avector_store_file_delete" | "vector_store_create" | "avector_store_create" | "vector_store_search" | "avector_store_search" | "create_container" | "acreate_container" | "list_containers" | "alist_containers" | "retrieve_container" | "aretrieve_container" | "delete_container" | "adelete_container" | "list_container_files" | "alist_container_files" | "upload_container_file" | "aupload_container_file" | "acancel_fine_tuning_job" | "cancel_fine_tuning_job" | "alist_fine_tuning_jobs" | "list_fine_tuning_jobs" | "aretrieve_fine_tuning_job" | "retrieve_fine_tuning_job" | "responses" | "aresponses" | "alist_input_items" | "llm_passthrough_route" | "allm_passthrough_route" | "generate_content" | "agenerate_content" | "generate_content_stream" | "agenerate_content_stream" | "ocr" | "aocr" | "call_mcp_tool" | "list_mcp_tools" | "asend_message" | "send_message" | "acreate_skill";
/** CallbackDelete */
CallbackDelete: {
/** Callback Name */
callback_name: string;
};
/** CallbacksByType */
CallbacksByType: {
/** Failure */
failure: string[];
/** Success */
success: string[];
/** Success And Failure */
success_and_failure: string[];
};
/**
* CancelEvalResponse
* @description Response from cancelling an evaluation
*/
CancelEvalResponse: {
/** Id */
id: string;
/**
* Object
* @default eval
*/
object: string;
/**
* Status
* @constant
*/
status: "cancelled";
};
/**
* CancelRunResponse
* @description Response from cancelling a run
*/
CancelRunResponse: {
/** Id */
id: string;
/**
* Object
* @default eval.run
*/
object: string;
/**
* Status
* @constant
*/
status: "cancelled";
};
/** ChatCompletionAnnotation */
ChatCompletionAnnotation: {
/**
* Type
* @constant
*/
type?: "url_citation";
url_citation?: components["schemas"]["ChatCompletionAnnotationURLCitation"];
} & {
[key: string]: unknown;
};
/** ChatCompletionAnnotationURLCitation */
ChatCompletionAnnotationURLCitation: {
/** End Index */
end_index?: number;
/** Start Index */
start_index?: number;
/** Title */
title?: string;
/** Url */
url?: string;
} & {
[key: string]: unknown;
};
/** ChatCompletionAssistantMessage */
ChatCompletionAssistantMessage: {
cache_control?: components["schemas"]["ChatCompletionCachedContent"];
/** Content */
content?: string | (components["schemas"]["ChatCompletionTextObject"] | components["schemas"]["ChatCompletionThinkingBlock"] | components["schemas"]["ChatCompletionRedactedThinkingBlock"] | components["schemas"]["ChatCompletionImageObject"])[] | null;
function_call?: components["schemas"]["ChatCompletionToolCallFunctionChunk"] | null;
/** Name */
name?: string | null;
/** Reasoning Content */
reasoning_content?: string | null;
/** Reasoning Items */
reasoning_items?: components["schemas"]["ChatCompletionReasoningItem"][] | null;
/**
* Role
* @constant
*/
role: "assistant";
/** Thinking Blocks */
thinking_blocks?: (components["schemas"]["ChatCompletionThinkingBlock"] | components["schemas"]["ChatCompletionRedactedThinkingBlock"])[] | null;
/** Tool Calls */
tool_calls?: components["schemas"]["ChatCompletionAssistantToolCall"][] | null;
};
/** ChatCompletionAssistantToolCall */
ChatCompletionAssistantToolCall: {
function: components["schemas"]["ChatCompletionToolCallFunctionChunk"];
/** Id */
id: string | null;
/**
* Type
* @constant
*/
type: "function";
};
/** ChatCompletionAudioObject */
ChatCompletionAudioObject: {
input_audio: components["schemas"]["InputAudio"];
/**
* Type
* @constant
*/
type: "input_audio";
};
/** ChatCompletionAudioResponse */
ChatCompletionAudioResponse: {
/** Data */
data: string;
/** Expires At */
expires_at: number;
/** Id */
id: string;
/** Transcript */
transcript: string;
} & {
[key: string]: unknown;
};
/** ChatCompletionCachedContent */
ChatCompletionCachedContent: {
/**
* Type
* @constant
*/
type: "ephemeral";
};
/** ChatCompletionDeveloperMessage */
ChatCompletionDeveloperMessage: {
cache_control?: components["schemas"]["ChatCompletionCachedContent"];
/** Content */
content: string | unknown[];
/** Name */
name?: string;
/**
* Role
* @constant
*/
role: "developer";
};
/** ChatCompletionDocumentObject */
ChatCompletionDocumentObject: {
citations: components["schemas"]["CitationsObject"] | null;
/** Context */
context: string;
source: components["schemas"]["DocumentObject"];
/** Title */
title: string;
/**
* Type
* @constant
*/
type: "document";
};
/** ChatCompletionFileObject */
ChatCompletionFileObject: {
file: components["schemas"]["ChatCompletionFileObjectFile"];
/**
* Type
* @constant
*/
type: "file";
};
/** ChatCompletionFileObjectFile */
ChatCompletionFileObjectFile: {
/** Detail */
detail?: string;
/** File Data */
file_data?: string;
/** File Id */
file_id?: string;
/** Filename */
filename?: string;
/** Format */
format?: string;
/** Video Metadata */
video_metadata?: {
[key: string]: unknown;
};
};
/** ChatCompletionFunctionMessage */
ChatCompletionFunctionMessage: {
/** Content */
content: string | components["schemas"]["ChatCompletionTextObject"][] | null;
/** Name */
name: string;
/**
* Role
* @constant
*/
role: "function";
/** Tool Call Id */
tool_call_id: string | null;
};
/** ChatCompletionImageObject */
ChatCompletionImageObject: {
/** Image Url */
image_url: string | components["schemas"]["ChatCompletionImageUrlObject"];
/**
* Type
* @constant
*/
type: "image_url";
};
/** ChatCompletionImageUrlObject */
ChatCompletionImageUrlObject: {
/** Detail */
detail?: string;
/** Format */
format?: string;
/** Url */
url: string;
};
/** ChatCompletionMessageToolCall */
ChatCompletionMessageToolCall: {
[key: string]: unknown;
};
/**
* ChatCompletionReasoningItem
* @description Represents an OpenAI Responses API reasoning item for round-tripping in conversation history.
*/
ChatCompletionReasoningItem: {
/** Encrypted Content */
encrypted_content?: string | null;
/** Id */
id?: string;
/** Summary */
summary?: components["schemas"]["ChatCompletionReasoningSummaryTextBlock"][];
/**
* Type
* @constant
*/
type: "reasoning";
};
/** ChatCompletionReasoningSummaryTextBlock */
ChatCompletionReasoningSummaryTextBlock: {
/** Text */
text?: string;
/**
* Type
* @constant
*/
type: "summary_text";
};
/** ChatCompletionRedactedThinkingBlock */
ChatCompletionRedactedThinkingBlock: {
/** Cache Control */
cache_control?: {
[key: string]: unknown;
} | components["schemas"]["ChatCompletionCachedContent"] | null;
/** Data */
data?: string;
/**
* Type
* @constant
*/
type: "redacted_thinking";
};
/** ChatCompletionSystemMessage */
ChatCompletionSystemMessage: {
cache_control?: components["schemas"]["ChatCompletionCachedContent"];
/** Content */
content: string | unknown[];
/** Name */
name?: string;
/**
* Role
* @constant
*/
role: "system";
};
/** ChatCompletionTextObject */
ChatCompletionTextObject: {
cache_control?: components["schemas"]["ChatCompletionCachedContent"];
/** Text */
text: string;
/**
* Type
* @constant
*/
type: "text";
};
/** ChatCompletionThinkingBlock */
ChatCompletionThinkingBlock: {
/** Cache Control */
cache_control?: {
[key: string]: unknown;
} | components["schemas"]["ChatCompletionCachedContent"] | null;
/** Signature */
signature?: string;
/** Thinking */
thinking?: string;
/**
* Type
* @constant
*/
type: "thinking";
};
/** ChatCompletionTokenLogprob */
ChatCompletionTokenLogprob: {
/** Bytes */
bytes?: number[] | null;
/** Logprob */
logprob: number;
/** Token */
token: string;
/** Top Logprobs */
top_logprobs: components["schemas"]["TopLogprob"][];
} & {
[key: string]: unknown;
};
/** ChatCompletionToolCallChunk */
ChatCompletionToolCallChunk: {
function: components["schemas"]["ChatCompletionToolCallFunctionChunk"];
/** Id */
id: string | null;
/** Index */
index: number;
/**
* Type
* @constant
*/
type: "function";
};
/** ChatCompletionToolCallFunctionChunk */
ChatCompletionToolCallFunctionChunk: {
/** Arguments */
arguments?: string;
/** Name */
name?: string | null;
/** Provider Specific Fields */
provider_specific_fields?: {
[key: string]: unknown;
} | null;
};
/** ChatCompletionToolMessage */
ChatCompletionToolMessage: {
/** Content */
content: string | components["schemas"]["ChatCompletionTextObject"][];
/**
* Role
* @constant
*/
role: "tool";
/** Tool Call Id */
tool_call_id: string;
};
/** ChatCompletionToolParam */
ChatCompletionToolParam: {
cache_control?: components["schemas"]["ChatCompletionCachedContent"];
function: components["schemas"]["ChatCompletionToolParamFunctionChunk"];
/** Type */
type: "function" | string;
};
/** ChatCompletionToolParamFunctionChunk */
ChatCompletionToolParamFunctionChunk: {
/** Description */
description?: string;
/** Name */
name: string;
/** Parameters */
parameters?: {
[key: string]: unknown;
};
/** Strict */
strict?: boolean;
};
/** ChatCompletionUserMessage */
ChatCompletionUserMessage: {
cache_control?: components["schemas"]["ChatCompletionCachedContent"];
/** Content */
content: string | (components["schemas"]["ChatCompletionTextObject"] | components["schemas"]["ChatCompletionImageObject"] | components["schemas"]["ChatCompletionAudioObject"] | components["schemas"]["ChatCompletionDocumentObject"] | components["schemas"]["ChatCompletionVideoObject"] | components["schemas"]["ChatCompletionFileObject"])[];
/**
* Role
* @constant
*/
role: "user";
};
/** ChatCompletionVideoObject */
ChatCompletionVideoObject: {
/**
* Type
* @constant
*/
type: "video_url";
/** Video Url */
video_url: string | components["schemas"]["ChatCompletionVideoUrlObject"];
};
/** ChatCompletionVideoUrlObject */
ChatCompletionVideoUrlObject: {
/** Detail */
detail?: string;
/** Url */
url: string;
};
/** ChatMessage */
ChatMessage: {
/** Content */
content: string;
/**
* Role
* @enum {string}
*/
role: "user" | "assistant";
};
/** ChoiceLogprobs */
ChoiceLogprobs: {
/** Content */
content?: components["schemas"]["ChatCompletionTokenLogprob"][] | null;
} & {
[key: string]: unknown;
};
/** Choices */
Choices: {
/**
* Finish Reason
* @enum {string}
*/
finish_reason: "stop" | "content_filter" | "function_call" | "tool_calls" | "length" | "guardrail_intervened" | "eos" | "finish_reason_unspecified" | "malformed_function_call";
/** Index */
index: number;
/** Logprobs */
logprobs?: components["schemas"]["ChoiceLogprobs"] | unknown | null;
message: components["schemas"]["Message"];
/** Provider Specific Fields */
provider_specific_fields?: {
[key: string]: unknown;
} | null;
} & {
[key: string]: unknown;
};
/** CitationsObject */
CitationsObject: {
/** Enabled */
enabled: boolean;
};
/**
* CloudZeroExportRequest
* @description Request model for CloudZero export operations
*/
CloudZeroExportRequest: {
/**
* End Time Utc
* @description End time for data export in UTC
*/
end_time_utc?: string | null;
/**
* Limit
* @description Optional limit on number of records to export
*/
limit?: number | null;
/**
* Operation
* @description CloudZero operation type (replace_hourly or sum)
* @default replace_hourly
*/
operation: string;
/**
* Start Time Utc
* @description Start time for data export in UTC
*/
start_time_utc?: string | null;
};
/**
* CloudZeroExportResponse
* @description Response model for CloudZero export operations
*/
CloudZeroExportResponse: {
/**
* Dry Run Data
* @description Dry run data including usage data and CBF transformed data
*/
dry_run_data?: {
[key: string]: unknown;
} | null;
/** Message */
message: string;
/** Records Exported */
records_exported?: number | null;
/** Status */
status: string;
/**
* Summary
* @description Summary statistics for dry run
*/
summary?: {
[key: string]: unknown;
} | null;
};
/**
* CloudZeroInitRequest
* @description Request model for initializing CloudZero settings
*/
CloudZeroInitRequest: {
/**
* Api Key
* @description CloudZero API key for authentication
*/
api_key: string;
/**
* Connection Id
* @description CloudZero connection ID for data submission
*/
connection_id: string;
/**
* Timezone
* @description Timezone for date handling (default: UTC)
* @default UTC
*/
timezone: string;
};
/**
* CloudZeroInitResponse
* @description Response model for CloudZero initialization
*/
CloudZeroInitResponse: {
/** Message */
message: string;
/** Status */
status: string;
};
/**
* CloudZeroSettingsUpdate
* @description Request model for updating CloudZero settings
*/
CloudZeroSettingsUpdate: {
/**
* Api Key
* @description New CloudZero API key for authentication
*/
api_key?: string | null;
/**
* Connection Id
* @description New CloudZero connection ID for data submission
*/
connection_id?: string | null;
/**
* Timezone
* @description New timezone for date handling
*/
timezone?: string | null;
};
/**
* CloudZeroSettingsView
* @description Response model for viewing CloudZero settings with masked API key
*/
CloudZeroSettingsView: {
/**
* Api Key Masked
* @description Masked API key showing only first 4 and last 4 characters
*/
api_key_masked?: string | null;
/**
* Connection Id
* @description CloudZero connection ID for data submission
*/
connection_id?: string | null;
/**
* Status
* @description Configuration status
*/
status?: string | null;
/**
* Timezone
* @description Timezone for date handling
*/
timezone?: string | null;
};
/**
* ComplianceCheckRequest
* @description Request payload for compliance check endpoints.
*
* Mirrors the spend log fields needed for compliance evaluation.
*/
ComplianceCheckRequest: {
/** Guardrail Information */
guardrail_information?: {
[key: string]: unknown;
}[] | null;
/** Model */
model?: string | null;
/** Request Id */
request_id: string;
/** Timestamp */
timestamp?: string | null;
/** User Id */
user_id?: string | null;
};
/**
* ComplianceCheckResult
* @description Result of a single compliance check.
*/
ComplianceCheckResult: {
/** Article */
article: string;
/** Check Name */
check_name: string;
/** Detail */
detail: string;
/** Passed */
passed: boolean;
};
/**
* ComplianceResponse
* @description Response from a compliance check endpoint.
*/
ComplianceResponse: {
/** Checks */
checks: components["schemas"]["ComplianceCheckResult"][];
/** Compliant */
compliant: boolean;
/** Regulation */
regulation: string;
};
/** ConfigFieldDelete */
ConfigFieldDelete: {
/**
* Config Type
* @constant
*/
config_type: "general_settings";
/** Field Name */
field_name: string;
};
/** ConfigFieldInfo */
ConfigFieldInfo: {
/** Field Name */
field_name: string;
/** Field Value */
field_value: unknown;
};
/** ConfigFieldUpdate */
ConfigFieldUpdate: {
/**
* Config Type
* @constant
*/
config_type: "general_settings";
/** Field Name */
field_name: string;
/** Field Value */
field_value: unknown;
};
/**
* ConfigGeneralSettings
* @description Documents all the fields supported by `general_settings` in config.yaml
*/
ConfigGeneralSettings: {
/**
* Alert To Webhook Url
* @description Mapping of alert type to webhook url. e.g. `alert_to_webhook_url: {'budget_alerts': 'https://nothooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'}`
*/
alert_to_webhook_url?: {
[key: string]: unknown;
} | null;
/**
* Alert Types
* @description List of alerting types. By default it is all alerts
*/
alert_types?: components["schemas"]["AlertType"][] | null;
/**
* Alerting
* @description List of alerting integrations. Today, just slack - `alerting: ['slack']`
*/
alerting?: unknown[] | null;
/**
* Alerting Args
* @description Controllable params for slack alerting - e.g. ttl in cache.
*/
alerting_args?: {
[key: string]: unknown;
} | null;
/**
* Alerting Threshold
* @description sends alerts if requests hang for 5min+
*/
alerting_threshold?: number | null;
/**
* Allowed Routes
* @description Proxy API Endpoints you want users to be able to access
*/
allowed_routes?: unknown[] | null;
/**
* Background Health Checks
* @description run health checks in background
*/
background_health_checks?: boolean | null;
/**
* Completion Model
* @description proxy level default model for all chat completion calls
*/
completion_model?: string | null;
/**
* Custom Auth
* @description override user_api_key_auth with your own auth script - https://docs.litellm.ai/docs/proxy/virtual_keys#custom-auth
*/
custom_auth?: string | null;
/** @description custom args for instantiating dynamodb client - e.g. billing provision */
database_args?: components["schemas"]["DynamoDBArgs"] | null;
/**
* Database Connect Timeout
* @description Prisma `connect_timeout` URL param (seconds). Bounds how long the engine waits to establish a new connection before failing. Defaults to Prisma's built-in value when unset.
*/
database_connect_timeout?: number | null;
/**
* Database Connection Pool Limit
* @description default connection pool for prisma client connecting to postgres db
* @default 10
*/
database_connection_pool_limit: number | null;
/**
* Database Connection Timeout
* @description default timeout for a connection to the database
* @default 60
*/
database_connection_timeout: number | null;
/**
* Database Disable Prepared Statements
* @description Disable server-side prepared statements by setting Prisma's `pgbouncer=true` URL param. Use this for pgbouncer transaction-pooling deployments, or to prevent the 'cached plan must not change result type' error that pooled connections hit during rolling schema migrations. An explicit `pgbouncer` in `database_extra_connection_params` takes precedence.
*/
database_disable_prepared_statements?: boolean | null;
/**
* Database Extra Connection Params
* @description Escape hatch: extra key/value pairs appended verbatim to the Prisma DATABASE_URL / DIRECT_URL query string (e.g. `sslmode`, `pgbouncer`, `statement_cache_size`). Keys here override any default LiteLLM sets.
*/
database_extra_connection_params?: {
[key: string]: unknown;
} | null;
/**
* Database Socket Timeout
* @description Prisma `socket_timeout` URL param (seconds). When set, an idle/slow connection that has not produced data within this window is closed. This is the main knob for capping idle DB connections from LiteLLM.
*/
database_socket_timeout?: number | null;
/**
* Database Type
* @description to use dynamodb instead of postgres db
*/
database_type?: "dynamo_db" | null;
/**
* Database Url
* @description connect to a postgres db - needed for generating temporary keys + tracking spend / key
*/
database_url?: string | null;
/**
* Disable Budget Reservation
* @description If True, disables the optimistic per-request budget reservation introduced in v1.84.0. WARNING: This weakens hard budget enforcement. Without the reservation, a burst of concurrent requests from a single key can each pass the read-time spend check before any of them is charged, allowing a configured budget to be exceeded under high concurrency. Budgets are still evaluated on every request at read time, so an already-exhausted budget is still rejected. Enable only if your deployment is experiencing phantom BudgetExceededError responses caused by leaked reservations (see GitHub issue #27639). A proxy-level WARNING is logged on every request while this flag is active as a reminder that hard enforcement is relaxed.
*/
disable_budget_reservation?: boolean | null;
/**
* Enable Public Model Hub
* @description Public model hub for users to see what models they have access to, supported openai params, etc.
* @default false
*/
enable_public_model_hub: boolean;
/**
* Forward Client Headers To Llm Api
* @description If True, forwards client headers (e.g. Authorization) to the LLM API. Required for Claude Code with Max subscription.
*/
forward_client_headers_to_llm_api?: boolean | null;
/**
* Global Max Parallel Requests
* @description global max parallel requests to allow for a proxy instance.
*/
global_max_parallel_requests?: number | null;
/**
* Health Check Concurrency
* @description limit concurrent health checks per cycle; when unset, health checks run without a concurrency cap
*/
health_check_concurrency?: number | null;
/**
* Health Check Interval
* @description background health check interval in seconds
* @default 300
*/
health_check_interval: number;
/**
* Health Check Skip Disabled Background Models
* @description When true, deployments with model_info.disable_background_health_check are skipped for on-demand GET /health as well as the background health loop.
* @default false
*/
health_check_skip_disabled_background_models: boolean;
/**
* Infer Model From Keys
* @description for `/models` endpoint, infers available model based on environment keys (e.g. OPENAI_API_KEY)
*/
infer_model_from_keys?: boolean | null;
/** @description key manager to load keys from / decrypt keys with */
key_management_system?: components["schemas"]["KeyManagementSystem"] | null;
/**
* Master Key
* @description require a key for all calls to proxy
*/
master_key?: string | null;
/**
* Max Parallel Requests
* @description maximum parallel requests for each api key
*/
max_parallel_requests?: number | null;
/**
* Max Request Size Mb
* @description max request size in MB, if a request is larger than this size it will be rejected
*/
max_request_size_mb?: number | null;
/**
* Max Response Size Mb
* @description max response size in MB, if a response is larger than this size it will be rejected
*/
max_response_size_mb?: number | null;
/**
* Maximum Spend Logs Retention Period
* @description Maximum retention period for spend logs (e.g., '7d' for 7 days). Logs older than this will be deleted.
*/
maximum_spend_logs_retention_period?: string | null;
/**
* Mcp Internal Ip Ranges
* @description Custom CIDR ranges that define internal/private networks for MCP access control. When set, only these ranges are treated as internal. Defaults to RFC 1918 private ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 127.0.0.0/8).
*/
mcp_internal_ip_ranges?: string[] | null;
/**
* Mcp Required Fields
* @description List of MCP server fields that must be filled in for a submission to pass standards checks (e.g. ['description', 'source_url', 'alias']).
*/
mcp_required_fields?: string[] | null;
/**
* Mcp Trusted Proxy Ranges
* @description CIDR ranges of trusted reverse proxies. When set, X-Forwarded-For and X-Forwarded-* origin headers are only trusted from these IPs.
*/
mcp_trusted_proxy_ranges?: string[] | null;
/**
* Otel
* @description [BETA] OpenTelemetry support - this might change, use with caution.
*/
otel?: boolean | null;
/**
* Pass Through Endpoints
* @description Set-up pass-through endpoints for provider-specific endpoints. Docs - https://docs.litellm.ai/docs/proxy/pass_through
*/
pass_through_endpoints?: components["schemas"]["PassThroughGenericEndpoint"][] | null;
/**
* Reject Clientside Metadata Tags
* @description When set to True, rejects requests that contain client-side 'metadata.tags' to prevent users from influencing budgets by sending different tags. Tags can only be inherited from the API key metadata.
*/
reject_clientside_metadata_tags?: boolean | null;
/**
* Store Model In Db
* @description If True, models and config are stored in and loaded from the database. Default is False.
*/
store_model_in_db?: boolean | null;
/**
* Store Prompts In Spend Logs
* @description If True, stores request messages and responses in spend logs. Default is False.
*/
store_prompts_in_spend_logs?: boolean | null;
/**
* Supported Db Objects
* @description Fine-grained control over which object types to load from the database when store_model_in_db is True. Available types: 'models', 'mcp', 'guardrails', 'vector_stores', 'pass_through_endpoints', 'prompts', 'model_cost_map', 'tools', 'config_overrides'. If not set, all objects are loaded (default behavior).
*/
supported_db_objects?: components["schemas"]["SupportedDBObjectType"][] | null;
/**
* Trusted Proxy Ranges
* @description CIDR ranges of trusted reverse proxies allowed to provide identity headers for header-based auth paths such as enable_oauth2_proxy_auth and custom_ui_sso_sign_in_handler.
*/
trusted_proxy_ranges?: string[] | null;
/**
* Ui Access Mode
* @description Control access to the Proxy UI
* @default all
*/
ui_access_mode: ("admin_only" | "all") | null;
/**
* Use Azure Key Vault
* @description load keys from azure key vault
*/
use_azure_key_vault?: boolean | null;
/**
* Use Google Kms
* @description decrypt keys with google kms
*/
use_google_kms?: boolean | null;
/** User Header Mappings */
user_header_mappings?: components["schemas"]["UserHeaderMapping"][] | null;
/**
* User Header Name
* @description [DEPRECATED] Use 'user_header_mappings' instead. When set, the header value is treated as the end user id unless overridden by user_header_mappings.
*/
user_header_name?: string | null;
/**
* User Mcp Management Mode
* @description Controls how non-admin users interact with MCP servers in the dashboard. 'restricted' shows only accessible servers, 'view_all' lists every server in read-only mode.
*/
user_mcp_management_mode?: ("restricted" | "view_all") | null;
};
/** ConfigList */
ConfigList: {
/** Field Default Value */
field_default_value: unknown;
/** Field Description */
field_description: string;
/** Field Name */
field_name: string;
/** Field Type */
field_type: string;
/** Field Value */
field_value: unknown;
/** Nested Fields */
nested_fields?: components["schemas"]["FieldDetail"][] | null;
/**
* Premium Field
* @default false
*/
premium_field: boolean;
/** Stored In Db */
stored_in_db: boolean | null;
};
/**
* ConfigOverrideSettingsResponse
* @description Response model for config override settings GET endpoints.
*/
ConfigOverrideSettingsResponse: {
/**
* Config Type
* @description The type of config override
*/
config_type: string;
/**
* Field Schema
* @description Schema information for UI rendering
*/
field_schema: {
[key: string]: unknown;
};
/**
* Values
* @description Current configuration values (sensitive fields decrypted)
*/
values: {
[key: string]: unknown;
};
};
/**
* ConfigYAML
* @description Documents all the fields supported by the config.yaml
*/
ConfigYAML: {
/**
* Environment Variables
* @description Object to pass in additional environment variables via POST request
*/
environment_variables?: {
[key: string]: unknown;
} | null;
general_settings?: components["schemas"]["ConfigGeneralSettings"] | null;
/**
* Litellm Settings
* @description litellm Module settings. See __init__.py for all, example litellm.drop_params=True, litellm.set_verbose=True, litellm.api_base, litellm.cache
*/
litellm_settings?: {
[key: string]: unknown;
} | null;
/**
* Model List
* @description List of supported models on the server, with model-specific configs
*/
model_list?: components["schemas"]["ModelParams"][] | null;
/** @description litellm router object settings. See router.py __init__ for all, example router.num_retries=5, router.timeout=5, router.max_retries=5, router.retry_after=5 */
router_settings?: components["schemas"]["UpdateRouterConfig"] | null;
};
/** ConfigurableClientsideParamsCustomAuth */
"ConfigurableClientsideParamsCustomAuth-Input": {
/** Api Base */
api_base: string;
} & {
[key: string]: unknown;
};
/** ConfigurableClientsideParamsCustomAuth */
"ConfigurableClientsideParamsCustomAuth-Output": {
/** Api Base */
api_base: string;
};
/**
* ContentFilterAction
* @description Action to take when content filter detects a match
* @enum {string}
*/
ContentFilterAction: "BLOCK" | "MASK";
/**
* ContentFilterCategoryConfig
* @description category: "harmful_self_harm"
* enabled: true
* action: "BLOCK"
* severity_threshold: "medium"
* category_file: "/path/to/custom_file.yaml" # optional override
*/
ContentFilterCategoryConfig: {
/**
* Action
* @description The action to take when the category is detected
* @enum {string}
*/
action: "BLOCK" | "MASK";
/**
* Category
* @description The category to detect
*/
category: string;
/**
* Category File
* @description Optional override. Use your own category file instead of the default one.
*/
category_file?: string | null;
/**
* Enabled
* @description Whether the category is enabled
* @default true
*/
enabled: boolean;
/**
* Severity Threshold
* @description The severity threshold to detect the category
* @default medium
* @enum {string}
*/
severity_threshold: "high" | "medium" | "low";
} & {
[key: string]: unknown;
};
/**
* ContentFilterPattern
* @description Represents a content filter pattern (prebuilt or custom regex)
*/
ContentFilterPattern: {
/** @description Action to take when pattern matches (BLOCK or MASK) */
action: components["schemas"]["ContentFilterAction"];
/**
* Name
* @description Name for this pattern (used in logging and error messages)
*/
name?: string | null;
/**
* Pattern
* @description Custom regex pattern. Required if pattern_type is 'regex'
*/
pattern?: string | null;
/**
* Pattern Name
* @description Name of prebuilt pattern (e.g., 'us_ssn', 'credit_card'). Required if pattern_type is 'prebuilt'
*/
pattern_name?: string | null;
/**
* Pattern Type
* @description Type of pattern: 'prebuilt' for predefined patterns or 'regex' for custom
* @enum {string}
*/
pattern_type: "prebuilt" | "regex";
};
/**
* CostEstimateRequest
* @description Request body for /cost/estimate endpoint.
*/
CostEstimateRequest: {
/**
* Input Tokens
* @description Expected input tokens per request
*/
input_tokens: number;
/**
* Model
* @description Model name (from /model_group/info)
*/
model: string;
/**
* Num Requests Per Day
* @description Number of requests per day
*/
num_requests_per_day?: number | null;
/**
* Num Requests Per Month
* @description Number of requests per month
*/
num_requests_per_month?: number | null;
/**
* Output Tokens
* @description Expected output tokens per request
*/
output_tokens: number;
};
/**
* CostEstimateResponse
* @description Response body for /cost/estimate endpoint.
*/
CostEstimateResponse: {
/**
* Cost Per Request
* @description Total cost per request (includes margin)
*/
cost_per_request: number;
/**
* Daily Cost
* @description Total daily cost (includes margin)
*/
daily_cost?: number | null;
/**
* Daily Input Cost
* @description Daily input token cost
*/
daily_input_cost?: number | null;
/**
* Daily Margin Cost
* @description Daily margin/fee
*/
daily_margin_cost?: number | null;
/**
* Daily Output Cost
* @description Daily output token cost
*/
daily_output_cost?: number | null;
/**
* Input Cost Per Request
* @description Input token cost per request (before margin)
*/
input_cost_per_request: number;
/** Input Cost Per Token */
input_cost_per_token?: number | null;
/** Input Tokens */
input_tokens: number;
/**
* Margin Cost Per Request
* @description Margin/fee added per request
* @default 0
*/
margin_cost_per_request: number;
/** Model */
model: string;
/**
* Monthly Cost
* @description Total monthly cost (includes margin)
*/
monthly_cost?: number | null;
/**
* Monthly Input Cost
* @description Monthly input token cost
*/
monthly_input_cost?: number | null;
/**
* Monthly Margin Cost
* @description Monthly margin/fee
*/
monthly_margin_cost?: number | null;
/**
* Monthly Output Cost
* @description Monthly output token cost
*/
monthly_output_cost?: number | null;
/** Num Requests Per Day */
num_requests_per_day?: number | null;
/** Num Requests Per Month */
num_requests_per_month?: number | null;
/**
* Output Cost Per Request
* @description Output token cost per request (before margin)
*/
output_cost_per_request: number;
/** Output Cost Per Token */
output_cost_per_token?: number | null;
/** Output Tokens */
output_tokens: number;
/** Provider */
provider?: string | null;
};
/** CreateCredentialItem */
CreateCredentialItem: {
/** Credential Info */
credential_info: {
[key: string]: unknown;
};
/** Credential Name */
credential_name: string;
/** Credential Values */
credential_values?: {
[key: string]: unknown;
} | null;
/** Model Id */
model_id?: string | null;
};
/** CreateGuardrailRequest */
CreateGuardrailRequest: {
guardrail: components["schemas"]["Guardrail"];
};
/** CreateJWTKeyMappingRequest */
CreateJWTKeyMappingRequest: {
/** Description */
description?: string | null;
/** Jwt Claim Name */
jwt_claim_name: string;
/** Jwt Claim Value */
jwt_claim_value: string;
/** Key */
key: string;
};
/** CreateSearchToolRequest */
CreateSearchToolRequest: {
search_tool: components["schemas"]["SearchTool"];
};
/** CredentialItem */
CredentialItem: {
/** Credential Info */
credential_info: {
[key: string]: unknown;
};
/** Credential Name */
credential_name: string;
/** Credential Values */
credential_values: {
[key: string]: unknown;
};
};
/** DailySpendData */
DailySpendData: {
breakdown?: components["schemas"]["BreakdownMetrics"];
/**
* Date
* Format: date
*/
date: string;
metrics: components["schemas"]["SpendMetrics"];
};
/** DailySpendMetadata */
DailySpendMetadata: {
/**
* Has More
* @default false
*/
has_more: boolean;
/**
* Page
* @default 1
*/
page: number;
/**
* Total Api Requests
* @default 0
*/
total_api_requests: number;
/**
* Total Cache Creation Input Tokens
* @default 0
*/
total_cache_creation_input_tokens: number;
/**
* Total Cache Read Input Tokens
* @default 0
*/
total_cache_read_input_tokens: number;
/**
* Total Completion Tokens
* @default 0
*/
total_completion_tokens: number;
/**
* Total Failed Requests
* @default 0
*/
total_failed_requests: number;
/**
* Total Pages
* @default 1
*/
total_pages: number;
/**
* Total Prompt Tokens
* @default 0
*/
total_prompt_tokens: number;
/**
* Total Spend
* @default 0
*/
total_spend: number;
/**
* Total Successful Requests
* @default 0
*/
total_successful_requests: number;
/**
* Total Tokens
* @default 0
*/
total_tokens: number;
};
/**
* DefaultInternalUserParams
* @description Default parameters to apply when a new user signs in via SSO or is created on the /user/new API endpoint
*/
DefaultInternalUserParams: {
/**
* Budget Duration
* @description Default budget duration for new users (e.g. 'daily', 'weekly', 'monthly')
*/
budget_duration?: string | null;
/**
* Max Budget
* @description Default maximum budget (in USD) for new users created
*/
max_budget?: number | null;
/**
* Models
* @description Default list of models that new users can access
*/
models?: string[] | null;
/**
* Teams
* @description Default teams for new users created
*/
teams?: string[] | components["schemas"]["NewUserRequestTeam"][] | null;
/**
* User Role
* @description Default role assigned to new users created
* @default internal_user_viewer
*/
user_role: ("internal_user" | "internal_user_viewer" | "proxy_admin" | "proxy_admin_viewer") | null;
};
/**
* DefaultTeamSSOParams
* @description Default parameters to apply when a new team is automatically created by LiteLLM via SSO Groups
*/
DefaultTeamSSOParams: {
/**
* Budget Duration
* @description Default budget duration for new automatically created teams (e.g. 'daily', 'weekly', 'monthly')
*/
budget_duration?: string | null;
/**
* Max Budget
* @description Default maximum budget (in USD) for new automatically created teams
*/
max_budget?: number | null;
/**
* Models
* @description Default list of models that new automatically created teams can access
* @default []
*/
models: string[];
/**
* Rpm Limit
* @description Default rpm limit for new automatically created teams
*/
rpm_limit?: number | null;
/**
* Team Member Permissions
* @description Default permissions granted to members of newly created teams (e.g. /key/generate, /key/update, /key/delete). /key/info and /key/health are always included.
*/
team_member_permissions?: components["schemas"]["KeyManagementRoutes"][] | null;
/**
* Tpm Limit
* @description Default tpm limit for new automatically created teams
*/
tpm_limit?: number | null;
};
/**
* DefaultTeamSettingsResponse
* @description Response model for default team settings
*/
DefaultTeamSettingsResponse: {
/** Field Schema */
field_schema: {
[key: string]: unknown;
};
/** Values */
values: {
[key: string]: unknown;
};
};
/**
* DeleteCustomerRequest
* @description Delete multiple Customers
*/
DeleteCustomerRequest: {
/** User Ids */
user_ids: string[];
};
/**
* DeleteEvalResponse
* @description Response from deleting an evaluation
*/
DeleteEvalResponse: {
/** Deleted */
deleted: boolean;
/** Eval Id */
eval_id: string;
/**
* Object
* @default eval.deleted
*/
object: string;
};
/** DeleteJWTKeyMappingRequest */
DeleteJWTKeyMappingRequest: {
/** Id */
id: string;
};
/** DeleteModelGroupResponse */
DeleteModelGroupResponse: {
/** Access Group */
access_group: string;
/** Message */
message: string;
/** Models Updated */
models_updated: number;
};
/** DeleteOrganizationRequest */
DeleteOrganizationRequest: {
/** Organization Ids */
organization_ids: string[];
};
/**
* DeleteProjectRequest
* @description Request model for DELETE /project/delete
*/
DeleteProjectRequest: {
/** Project Ids */
project_ids: string[];
};
/**
* DeleteSkillResponse
* @description Response from deleting a skill
*/
DeleteSkillResponse: {
/** Id */
id: string;
/**
* Type
* @default skill_deleted
*/
type: string;
};
/** DeleteTeamRequest */
DeleteTeamRequest: {
/** Team Ids */
team_ids: string[];
};
/** DeleteUserRequest */
DeleteUserRequest: {
/** User Ids */
user_ids: string[];
};
/** Deployment */
Deployment: {
litellm_params: components["schemas"]["LiteLLM_Params"];
model_info: components["schemas"]["litellm__types__router__ModelInfo"];
/** Model Name */
model_name: string;
} & {
[key: string]: unknown;
};
/**
* DistinctTagResponse
* @description Response for distinct user agent tags
*/
DistinctTagResponse: {
/** Tag */
tag: string;
};
/**
* DistinctTagsResponse
* @description Response for all distinct user agent tags
*/
DistinctTagsResponse: {
/** Results */
results: components["schemas"]["DistinctTagResponse"][];
};
/** DocumentObject */
DocumentObject: {
/** Data */
data: string;
/** Media Type */
media_type: string;
/**
* Type
* @constant
*/
type: "text";
};
/** DynamoDBArgs */
DynamoDBArgs: {
/** Assume Role Aws Role Name */
assume_role_aws_role_name?: string | null;
/** Assume Role Aws Session Name */
assume_role_aws_session_name?: string | null;
/** Aws Duration Seconds */
aws_duration_seconds?: number | null;
/** Aws Policy */
aws_policy?: string | null;
/** Aws Policy Arns */
aws_policy_arns?: string[] | null;
/** Aws Provider Id */
aws_provider_id?: string | null;
/** Aws Role Name */
aws_role_name?: string | null;
/** Aws Session Name */
aws_session_name?: string | null;
/** Aws Web Identity Token */
aws_web_identity_token?: string | null;
/**
* Billing Mode
* @enum {string}
*/
billing_mode: "PROVISIONED_THROUGHPUT" | "PAY_PER_REQUEST";
/**
* Config Table Name
* @default LiteLLM_Config
*/
config_table_name: string;
/**
* Key Table Name
* @default LiteLLM_VerificationToken
*/
key_table_name: string;
/** Read Capacity Units */
read_capacity_units?: number | null;
/** Region Name */
region_name: string;
/**
* Spend Table Name
* @default LiteLLM_SpendLogs
*/
spend_table_name: string;
/** Ssl Verify */
ssl_verify?: boolean | null;
/**
* User Table Name
* @default LiteLLM_UserTable
*/
user_table_name: string;
/** Write Capacity Units */
write_capacity_units?: number | null;
};
/**
* EmailEvent
* @enum {string}
*/
EmailEvent: "Virtual Key Created" | "New User Invitation" | "Virtual Key Rotated" | "Soft Budget Crossed" | "Max Budget Alert";
/** EmailEventSettings */
EmailEventSettings: {
/** Enabled */
enabled: boolean;
event: components["schemas"]["EmailEvent"];
};
/** EmailEventSettingsResponse */
EmailEventSettingsResponse: {
/** Settings */
settings: components["schemas"]["EmailEventSettings"][];
};
/** EmailEventSettingsUpdateRequest */
EmailEventSettingsUpdateRequest: {
/** Settings */
settings: components["schemas"]["EmailEventSettings"][];
};
/** EmbeddingRequest */
EmbeddingRequest: {
/**
* Api Base
* @default null
*/
api_base: string | null;
/**
* Api Key
* @default null
*/
api_key: string | null;
/**
* Api Type
* @default null
*/
api_type: string | null;
/**
* Api Version
* @default null
*/
api_version: string | null;
/**
* Caching
* @default false
*/
caching: boolean;
/**
* Custom Llm Provider
* @default null
*/
custom_llm_provider: string | {
[key: string]: unknown;
} | null;
/**
* Input
* @default []
*/
input: string[];
/**
* Litellm Call Id
* @default null
*/
litellm_call_id: string | null;
/**
* Litellm Logging Obj
* @default null
*/
litellm_logging_obj: {
[key: string]: unknown;
} | null;
/**
* Logger Fn
* @default null
*/
logger_fn: string | null;
/** Model */
model: string;
/**
* Timeout
* @default 600
*/
timeout: number;
/**
* User
* @default null
*/
user: string | null;
} & {
[key: string]: unknown;
};
/** EndpointProvider */
EndpointProvider: {
/** Display Name */
display_name: string;
/** Slug */
slug: string;
};
/** EnrichTemplateRequest */
EnrichTemplateRequest: {
/**
* Competitors
* @description Optional list of competitor names
*/
competitors?: string[] | null;
/**
* Instruction
* @description Refinement instruction for modifying the competitor list (e.g. 'add 10 more from Asia')
*/
instruction?: string | null;
/** Model */
model?: string | null;
/** Parameters */
parameters: {
[key: string]: unknown;
};
/** Template Id */
template_id: string;
};
/** ErrorResponse */
ErrorResponse: {
/**
* Detail
* @example {
* "error": {
* "code": "error_code",
* "message": "Error message",
* "param": "error_param",
* "type": "error_type"
* }
* }
*/
detail: {
[key: string]: unknown;
};
};
/**
* Eval
* @description Represents an evaluation from the OpenAI Evals API
*/
Eval: {
/** Created At */
created_at: number;
/** Data Source Config */
data_source_config: {
[key: string]: unknown;
};
/** Id */
id: string;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Name */
name?: string | null;
/**
* Object
* @default eval
*/
object: string;
/** Testing Criteria */
testing_criteria: {
[key: string]: unknown;
}[];
/** Updated At */
updated_at?: number | null;
};
/**
* FailedKeyUpdate
* @description Failed key update with reason
*/
FailedKeyUpdate: {
/** Failed Reason */
failed_reason: string;
/** Key */
key: string;
/** Key Info */
key_info?: {
[key: string]: unknown;
} | null;
};
/**
* FallbackCreateRequest
* @description Request model for creating/updating fallbacks
*/
FallbackCreateRequest: {
/**
* Fallback Models
* @description List of fallback model names in order of priority
*/
fallback_models: string[];
/**
* Fallback Type
* @description Type of fallback: 'general' (default), 'context_window', or 'content_policy'
* @default general
* @enum {string}
*/
fallback_type: "general" | "context_window" | "content_policy";
/**
* Model
* @description The model name to configure fallbacks for (e.g., 'gpt-3.5-turbo')
*/
model: string;
};
/**
* FallbackDeleteResponse
* @description Response model for deleting fallbacks
*/
FallbackDeleteResponse: {
/**
* Fallback Type
* @description Type of fallback
*/
fallback_type: string;
/**
* Message
* @description Success message
*/
message: string;
/**
* Model
* @description The model name
*/
model: string;
};
/**
* FallbackGetResponse
* @description Response model for getting fallbacks
*/
FallbackGetResponse: {
/**
* Fallback Models
* @description List of fallback model names
*/
fallback_models: string[];
/**
* Fallback Type
* @description Type of fallback
*/
fallback_type: string;
/**
* Model
* @description The model name
*/
model: string;
};
/**
* FallbackResponse
* @description Response model for fallback operations
*/
FallbackResponse: {
/**
* Fallback Models
* @description List of fallback model names
*/
fallback_models: string[];
/**
* Fallback Type
* @description Type of fallback
*/
fallback_type: string;
/**
* Message
* @description Success message
*/
message: string;
/**
* Model
* @description The model name
*/
model: string;
};
/** FieldDetail */
FieldDetail: {
/** Field Default Value */
field_default_value?: unknown;
/** Field Description */
field_description: string;
/** Field Name */
field_name: string;
/** Field Type */
field_type: string;
/** Stored In Db */
stored_in_db: boolean | null;
};
/** FunctionCall */
FunctionCall: {
/** Arguments */
arguments: string;
/** Name */
name?: string | null;
} & {
[key: string]: unknown;
};
/**
* GUARDRAIL_DEFINITION_LOCATION
* @enum {string}
*/
GUARDRAIL_DEFINITION_LOCATION: "db" | "config";
/** GenerateKeyRequest */
GenerateKeyRequest: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/**
* Auto Rotate
* @description Whether this key should be automatically rotated
* @default false
*/
auto_rotate: boolean | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Duration */
duration?: string | null;
/** Enforced Params */
enforced_params?: string[] | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key */
key?: string | null;
/** Key Alias */
key_alias?: string | null;
/**
* @description Type of key that determines default allowed routes.
* @default default
*/
key_type: components["schemas"]["LiteLLMKeyType"] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Project Id */
project_id?: string | null;
/** Prompts */
prompts?: string[] | null;
/**
* Rotation Interval
* @description How often to rotate this key (e.g., '30d', '90d'). Required if auto_rotate=True
*/
rotation_interval?: string | null;
router_settings?: components["schemas"]["UpdateRouterConfig"] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** Send Invite Email */
send_invite_email?: boolean | null;
/** Soft Budget */
soft_budget?: number | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** User Id */
user_id?: string | null;
};
/** GenerateKeyResponse */
GenerateKeyResponse: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Duration */
duration?: string | null;
/** Enforced Params */
enforced_params?: string[] | null;
/** Expires */
expires?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key */
key: string;
/** Key Alias */
key_alias?: string | null;
/** Key Name */
key_name?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: unknown | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Project Id */
project_id?: string | null;
/** Prompts */
prompts?: string[] | null;
router_settings?: components["schemas"]["UpdateRouterConfig"] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
/** Token */
token?: string | null;
/** Token Id */
token_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User Id */
user_id?: string | null;
};
/** GenericGuardrailAPIInputs */
GenericGuardrailAPIInputs: {
/** Images */
images?: string[];
/** Model */
model?: string | null;
/** Structured Messages */
structured_messages?: (components["schemas"]["ChatCompletionUserMessage"] | components["schemas"]["ChatCompletionAssistantMessage"] | components["schemas"]["ChatCompletionToolMessage"] | components["schemas"]["ChatCompletionSystemMessage"] | components["schemas"]["ChatCompletionFunctionMessage"] | components["schemas"]["ChatCompletionDeveloperMessage"])[];
/** Texts */
texts?: string[];
/** Tool Calls */
tool_calls?: components["schemas"]["ChatCompletionToolCallChunk"][] | components["schemas"]["ChatCompletionMessageToolCall"][];
/** Tools */
tools?: components["schemas"]["ChatCompletionToolParam"][];
};
/**
* GetTeamMemberPermissionsResponse
* @description Response to get the team member permissions for a team
*/
GetTeamMemberPermissionsResponse: {
/** All Available Permissions */
all_available_permissions: string[];
/** Team Id */
team_id: string;
/**
* Team Member Permissions
* @default []
*/
team_member_permissions: string[] | null;
};
/** GlobalEndUsersSpend */
GlobalEndUsersSpend: {
/** Api Key */
api_key?: string | null;
/** Endtime */
endTime?: string | null;
/** 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 */
created_at?: string | null;
/** Guardrail Id */
guardrail_id?: string | null;
/** Guardrail Info */
guardrail_info?: {
[key: string]: unknown;
} | null;
/** Guardrail Name */
guardrail_name: string;
litellm_params: components["schemas"]["LitellmParams"];
/** Policy Template */
policy_template?: string | null;
/** Updated At */
updated_at?: string | null;
};
/** GuardrailInfoResponse */
GuardrailInfoResponse: {
/** Created At */
created_at?: string | null;
/** @default config */
guardrail_definition_location: components["schemas"]["GUARDRAIL_DEFINITION_LOCATION"];
/** Guardrail Id */
guardrail_id?: string | null;
/** Guardrail Info */
guardrail_info?: {
[key: string]: unknown;
} | null;
/** Guardrail Name */
guardrail_name: string;
litellm_params?: components["schemas"]["BaseLitellmParams-Output"] | null;
/** Updated At */
updated_at?: string | null;
};
/** GuardrailSubmissionItem */
GuardrailSubmissionItem: {
/** Created At */
created_at?: string | null;
/** Guardrail Id */
guardrail_id: string;
/** Guardrail Info */
guardrail_info?: {
[key: string]: unknown;
} | null;
/** Guardrail Name */
guardrail_name: string;
/** Litellm Params */
litellm_params?: {
[key: string]: unknown;
} | null;
/** Reviewed At */
reviewed_at?: string | null;
/** Status */
status: string;
/** Submitted At */
submitted_at?: string | null;
/** Submitted By Email */
submitted_by_email?: string | null;
/** Submitted By User Id */
submitted_by_user_id?: string | null;
/**
* Team Guardrail
* @default false
*/
team_guardrail: boolean;
/** Team Id */
team_id?: string | null;
/** Updated At */
updated_at?: string | null;
};
/** GuardrailSubmissionSummary */
GuardrailSubmissionSummary: {
/** Active */
active: number;
/** Pending Review */
pending_review: number;
/** Rejected */
rejected: number;
/** Total */
total: number;
};
/** GuardrailTestResultEntry */
GuardrailTestResultEntry: {
/** Action */
action: string;
/** Details */
details: string;
/** Guardrail Name */
guardrail_name: string;
/** Output Text */
output_text: string;
};
/**
* HTTPAuthSecurityScheme
* @description Defines a security scheme using HTTP authentication.
*/
HTTPAuthSecurityScheme: {
/** Bearerformat */
bearerFormat: string | null;
/** Description */
description?: string | null;
/** Scheme */
scheme: string;
/**
* Type
* @constant
*/
type: "http";
};
/** HTTPValidationError */
HTTPValidationError: {
/** Detail */
detail?: components["schemas"]["ValidationError"][];
};
/**
* HashicorpVaultConfig
* @description Configuration for Hashicorp Vault secret manager integration.
*/
HashicorpVaultConfig: {
/**
* Approle Mount Path
* @description Mount path for the AppRole auth method (default: approle)
*/
approle_mount_path?: string | null;
/**
* Approle Role Id
* @description Role ID for Vault AppRole authentication
*/
approle_role_id?: string | null;
/**
* Approle Secret Id
* @description Secret ID for Vault AppRole authentication
*/
approle_secret_id?: string | null;
/**
* Client Cert
* @description Path to the client TLS certificate for Vault
*/
client_cert?: string | null;
/**
* Client Key
* @description Path to the client TLS private key for Vault
*/
client_key?: string | null;
/**
* Vault Addr
* @description The address of the Vault server (e.g., https://vault.example.com:8200)
*/
vault_addr?: string | null;
/**
* Vault Cert Role
* @description Certificate role name for TLS cert authentication
*/
vault_cert_role?: string | null;
/**
* Vault Mount Name
* @description KV engine mount name (default: secret)
*/
vault_mount_name?: string | null;
/**
* Vault Namespace
* @description Vault namespace (for multi-tenant Vault, sent as X-Vault-Namespace header)
*/
vault_namespace?: string | null;
/**
* Vault Path Prefix
* @description Optional path prefix for secrets (e.g., myapp -> secret/data/myapp/{secret_name})
*/
vault_path_prefix?: string | null;
/**
* Vault Token
* @description Token for Vault token-based authentication
*/
vault_token?: string | null;
};
/** Hyperparameters */
Hyperparameters: {
/** Batch Size */
batch_size?: string | number | null;
/** Learning Rate Multiplier */
learning_rate_multiplier?: string | number | null;
/** N Epochs */
n_epochs?: string | number | null;
} & {
[key: string]: unknown;
};
/** IPAddress */
IPAddress: {
/** Ip */
ip: string;
};
/** ImageURLListItem */
ImageURLListItem: {
image_url: components["schemas"]["ImageURLObject"];
/** Index */
index: number;
/**
* Type
* @constant
*/
type: "image_url";
} & {
[key: string]: unknown;
};
/** ImageURLObject */
ImageURLObject: {
/** Detail */
detail?: string | null;
/** Url */
url: string;
} & {
[key: string]: unknown;
};
/** InProductNudgeResponse */
InProductNudgeResponse: {
/**
* Is Claude Code Enabled
* @description Whether the Claude Code nudge should be shown.
* @default false
*/
is_claude_code_enabled: boolean;
};
/** IndexCreateLiteLLMParams */
IndexCreateLiteLLMParams: {
/** Vector Store Index */
vector_store_index: string;
/** Vector Store Name */
vector_store_name: string;
};
/** IndexCreateRequest */
IndexCreateRequest: {
/** Index Info */
index_info?: {
[key: string]: unknown;
} | null;
/** Index Name */
index_name: string;
litellm_params: components["schemas"]["IndexCreateLiteLLMParams"];
};
/** InputAudio */
InputAudio: {
/** Data */
data: string;
/**
* Format
* @enum {string}
*/
format: "wav" | "mp3";
};
/**
* InternalUserSettingsResponse
* @description Response model for internal user settings
*/
InternalUserSettingsResponse: {
/** Field Schema */
field_schema: {
[key: string]: unknown;
};
/** Values */
values: {
[key: string]: unknown;
};
};
/** InvitationClaim */
InvitationClaim: {
/** Invitation Link */
invitation_link: string;
/** Password */
password: string;
/** User Id */
user_id: string;
};
/** InvitationDelete */
InvitationDelete: {
/** Invitation Id */
invitation_id: string;
};
/** InvitationModel */
InvitationModel: {
/** Accepted At */
accepted_at: string | null;
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Created By */
created_by: string;
/**
* Expires At
* Format: date-time
*/
expires_at: string;
/** Id */
id: string;
/** Is Accepted */
is_accepted: boolean;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated By */
updated_by: string;
/** User Id */
user_id: string;
};
/** InvitationNew */
InvitationNew: {
/** User Id */
user_id: string;
};
/** InvitationUpdate */
InvitationUpdate: {
/** Invitation Id */
invitation_id: string;
/** Is Accepted */
is_accepted: boolean;
};
/** JWTKeyMappingResponse */
JWTKeyMappingResponse: {
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Created By */
created_by?: string | null;
/** Description */
description?: string | null;
/** Id */
id: string;
/** Is Active */
is_active: boolean;
/** Jwt Claim Name */
jwt_claim_name: string;
/** Jwt Claim Value */
jwt_claim_value: string;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated By */
updated_by?: string | null;
};
/** KeyHealthResponse */
KeyHealthResponse: {
/**
* Key
* @enum {string}
*/
key?: "healthy" | "unhealthy";
logging_callbacks?: components["schemas"]["LoggingCallbackStatus"] | null;
};
/** KeyListResponseObject */
KeyListResponseObject: {
/** Current Page */
current_page?: number | null;
/** Keys */
keys?: (string | components["schemas"]["UserAPIKeyAuth"] | components["schemas"]["LiteLLM_DeletedVerificationToken"])[];
/** Total Count */
total_count?: number | null;
/** Total Pages */
total_pages?: number | null;
};
/**
* KeyManagementRoutes
* @description Enum for key management routes
* @enum {string}
*/
KeyManagementRoutes: "/key/generate" | "/key/update" | "/key/delete" | "/key/regenerate" | "/key/service-account/generate" | "/key/{key_id}/regenerate" | "/key/block" | "/key/unblock" | "/key/bulk_update" | "/team/key/bulk_update" | "/key/{key_id}/reset_spend" | "/key/access_group_assignment" | "/key/info" | "/key/health" | "/key/list" | "/key/aliases" | "/team/daily/activity" | "/spend/logs" | "/spend/logs/v2";
/**
* KeyManagementSystem
* @enum {string}
*/
KeyManagementSystem: "google_kms" | "azure_key_vault" | "aws_secret_manager" | "google_secret_manager" | "hashicorp_vault" | "cyberark" | "local" | "aws_kms" | "custom";
/**
* KeyMetadata
* @description Metadata for a key
*/
KeyMetadata: {
/** Key Alias */
key_alias?: string | null;
/** Team Id */
team_id?: string | null;
};
/**
* KeyMetricWithMetadata
* @description Base class for metrics with additional metadata
*/
KeyMetricWithMetadata: {
metadata?: components["schemas"]["KeyMetadata"];
metrics: components["schemas"]["SpendMetrics"];
};
/** KeyRequest */
KeyRequest: {
/** Key Aliases */
key_aliases?: string[] | null;
/** Keys */
keys?: string[] | null;
};
/**
* KeyUpdateFields
* @description Allowlist of bulk-broadcastable fields for /team/key/bulk_update; `extra="forbid"` blocks RBAC/ownership/scope mutations even by team admins.
*/
KeyUpdateFields: {
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: unknown[] | null;
/** Duration */
duration?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** Tags */
tags?: string[] | null;
/** Temp Budget Expiry */
temp_budget_expiry?: string | null;
/** Temp Budget Increase */
temp_budget_increase?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
};
/** LakeraCategoryThresholds */
LakeraCategoryThresholds: {
/** Jailbreak */
jailbreak?: number;
/** Prompt Injection */
prompt_injection?: number;
} & {
[key: string]: unknown;
};
/** ListAccessGroupsResponse */
ListAccessGroupsResponse: {
/** Access Groups */
access_groups: components["schemas"]["AccessGroupInfo"][];
};
/**
* ListEvalsResponse
* @description Response from listing evaluations
*/
ListEvalsResponse: {
/** Data */
data: components["schemas"]["Eval"][];
/** First Id */
first_id?: string | null;
/**
* Has More
* @default false
*/
has_more: boolean;
/** Last Id */
last_id?: string | null;
/**
* Object
* @default list
*/
object: string;
};
/** ListGuardrailSubmissionsResponse */
ListGuardrailSubmissionsResponse: {
/** Submissions */
submissions: components["schemas"]["GuardrailSubmissionItem"][];
summary: components["schemas"]["GuardrailSubmissionSummary"];
};
/** ListGuardrailsResponse */
ListGuardrailsResponse: {
/** Guardrails */
guardrails: components["schemas"]["GuardrailInfoResponse"][];
};
/**
* ListPluginsResponse
* @description Response from listing plugins.
*/
ListPluginsResponse: {
/** Count */
count: number;
/** Plugins */
plugins: components["schemas"]["PluginListItem"][];
};
/** ListPromptsResponse */
ListPromptsResponse: {
/** Prompts */
prompts: components["schemas"]["PromptSpec"][];
};
/**
* ListRunsResponse
* @description Response from listing runs
*/
ListRunsResponse: {
/** Data */
data: components["schemas"]["Run"][];
/** First Id */
first_id?: string | null;
/**
* Has More
* @default false
*/
has_more: boolean;
/** Last Id */
last_id?: string | null;
/**
* Object
* @default list
*/
object: string;
};
/**
* ListSearchToolsResponse
* @description Response model for listing search tools.
*/
ListSearchToolsResponse: {
/** Search Tools */
search_tools: components["schemas"]["SearchToolInfoResponse"][];
};
/**
* ListSkillsResponse
* @description Response from listing skills
*/
ListSkillsResponse: {
/** Data */
data: components["schemas"]["Skill"][];
/**
* Has More
* @default false
*/
has_more: boolean;
/** Next Page */
next_page?: string | null;
};
/** LiteLLMFineTuningJobCreate */
LiteLLMFineTuningJobCreate: {
/** Custom Llm Provider */
custom_llm_provider?: ("openai" | "azure" | "vertex_ai") | null;
hyperparameters?: components["schemas"]["Hyperparameters"] | null;
/** Integrations */
integrations?: string[] | null;
/** Model */
model: string;
/** Seed */
seed?: number | null;
/** Suffix */
suffix?: string | null;
/** Training File */
training_file: string;
/** Validation File */
validation_file?: string | null;
} & {
[key: string]: unknown;
};
/**
* LiteLLMKeyType
* @description Enum for key types that determine what routes a key can access
* @enum {string}
*/
LiteLLMKeyType: "llm_api" | "management" | "read_only" | "default";
/**
* LiteLLM_BudgetTable
* @description Represents user-controllable params for a LiteLLM_BudgetTable record.
*
* Budget-write paths use `model_fields.keys()` on this class as an allowlist
* for user input. Keep server-managed fields (e.g. `budget_reset_at`) on
* `LiteLLM_BudgetTableFull` so they aren't user-settable.
*/
LiteLLM_BudgetTable: {
/** Allowed Models */
allowed_models?: string[] | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/**
* LiteLLM_BudgetTableFull
* @description LiteLLM_BudgetTable + server-managed fields returned on API responses.
*/
LiteLLM_BudgetTableFull: {
/** Allowed Models */
allowed_models?: string[] | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/**
* LiteLLM_DeletedTeamTable
* @description Audit record for deleted teams; mirrors the team plus deletion metadata.
*/
LiteLLM_DeletedTeamTable: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/**
* Admins
* @default []
*/
admins: unknown[];
/**
* Allow Team Guardrail Config
* @default false
*/
allow_team_guardrail_config: boolean | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/** Default Team Member Models */
default_team_member_models?: string[] | null;
/** Deleted At */
deleted_at?: string | null;
/** Deleted By */
deleted_by?: string | null;
/** Deleted By Api Key */
deleted_by_api_key?: string | null;
/** Id */
id?: string | null;
/** Litellm Changed By */
litellm_changed_by?: string | null;
litellm_model_table?: components["schemas"]["LiteLLM_ModelTable"] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Members
* @default []
*/
members: unknown[];
/**
* Members With Roles
* @default []
*/
members_with_roles: components["schemas"]["Member"][];
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Id */
model_id?: number | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Id */
organization_id?: string | null;
/** Policies */
policies?: string[] | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Spend */
spend?: number | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id: string;
/** Team Member Permissions */
team_member_permissions?: string[] | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
};
/**
* LiteLLM_DeletedVerificationToken
* @description Audit record for deleted keys; mirrors the token plus deletion metadata.
*/
LiteLLM_DeletedVerificationToken: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
};
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/**
* Auto Rotate
* @default false
*/
auto_rotate: boolean | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: {
[key: string]: unknown;
}[] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
};
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Deleted At */
deleted_at?: string | null;
/** Deleted By */
deleted_by?: string | null;
/** Deleted By Api Key */
deleted_by_api_key?: string | null;
/** Expires */
expires?: string | null;
/** Id */
id?: string | null;
/** Key Alias */
key_alias?: string | null;
/** Key Name */
key_name?: string | null;
/** Key Rotation At */
key_rotation_at?: string | null;
/** Last Active */
last_active?: string | null;
/** Last Rotation At */
last_rotation_at?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: {
[key: string]: unknown;
} | null;
/** Litellm Changed By */
litellm_changed_by?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
};
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
};
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
};
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Org Id */
org_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
};
/** Project Id */
project_id?: string | null;
/**
* Rotation Count
* @default 0
*/
rotation_count: number | null;
/** Rotation Interval */
rotation_interval?: string | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/**
* Soft Budget Cooldown
* @default false
*/
soft_budget_cooldown: boolean;
/**
* Spend
* @default 0
*/
spend: number;
/** Team Id */
team_id?: string | null;
/** Token */
token?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User Id */
user_id?: string | null;
};
/** LiteLLM_EndUserTable */
LiteLLM_EndUserTable: {
/** Alias */
alias?: string | null;
/** Allowed Model Region */
allowed_model_region?: ("eu" | "us") | null;
/** Blocked */
blocked: boolean;
/** Default Model */
default_model?: string | null;
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTable"] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/**
* Spend
* @default 0
*/
spend: number;
/** User Id */
user_id: string;
};
/**
* LiteLLM_MCPServerTable
* @description Represents a LiteLLM_MCPServerTable record
*/
LiteLLM_MCPServerTable: {
/** Alias */
alias?: string | null;
/**
* Allow All Keys
* @default false
*/
allow_all_keys: boolean;
/** Allowed Tools */
allowed_tools?: string[];
/**
* Approval Status
* @description Approval status: 'pending_review', 'active', 'rejected'
* @default active
*/
approval_status: string | null;
/** Args */
args?: string[];
/** Auth Type */
auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token") | null;
/** Authorization Url */
authorization_url?: string | null;
/**
* Available On Public Internet
* @default true
*/
available_on_public_internet: boolean;
/** Byok Api Key Help Url */
byok_api_key_help_url?: string | null;
/** Byok Description */
byok_description?: string[];
/** Command */
command?: string | null;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
credentials?: components["schemas"]["MCPCredentials"] | null;
/** Description */
description?: string | null;
/** Env */
env?: {
[key: string]: string;
};
/** Extra Headers */
extra_headers?: string[];
/** Has User Credential */
has_user_credential?: boolean | null;
/** Health Check Error */
health_check_error?: string | null;
/** Instructions */
instructions?: string | null;
/**
* Is Byok
* @default false
*/
is_byok: boolean;
/** Last Health Check */
last_health_check?: string | null;
/** Mcp Access Groups */
mcp_access_groups?: string[];
/** Mcp Info */
mcp_info?: {
[key: string]: unknown;
} | null;
/** Registration Url */
registration_url?: string | null;
/** Review Notes */
review_notes?: string | null;
/** Reviewed At */
reviewed_at?: string | null;
/** Server Id */
server_id: string;
/** Server Name */
server_name?: string | null;
/** Source Url */
source_url?: string | null;
/** Spec Path */
spec_path?: string | null;
/** Static Headers */
static_headers?: {
[key: string]: string;
} | null;
/**
* Status
* @description Health status: 'healthy', 'unhealthy', 'unknown'
* @default unknown
*/
status: ("healthy" | "unhealthy" | "unknown") | null;
/** Submitted At */
submitted_at?: string | null;
/** Submitted By */
submitted_by?: string | null;
/** Teams */
teams?: {
[key: string]: string | null;
}[];
/** Token Url */
token_url?: string | null;
/** Tool Name To Description */
tool_name_to_description?: {
[key: string]: string;
} | null;
/** Tool Name To Display Name */
tool_name_to_display_name?: {
[key: string]: string;
} | null;
/**
* Transport
* @enum {string}
*/
transport: "sse" | "http" | "stdio";
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** 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 */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Key */
key: string;
/** Memory Id */
memory_id: string;
/** Metadata */
metadata?: unknown | null;
/** Team Id */
team_id?: string | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User Id */
user_id?: string | null;
/** Value */
value: string;
};
/** LiteLLM_ModelTable */
LiteLLM_ModelTable: {
/** Created By */
created_by: string;
/** Id */
id?: number | null;
/** Model Aliases */
model_aliases?: string | {
[key: string]: unknown;
} | null;
team?: components["schemas"]["LiteLLM_TeamTable"] | null;
/** Updated By */
updated_by: string;
};
/** LiteLLM_ObjectPermissionBase */
LiteLLM_ObjectPermissionBase: {
/** Agent Access Groups */
agent_access_groups?: string[] | null;
/** Agents */
agents?: string[] | null;
/** Blocked Tools */
blocked_tools?: string[] | null;
/** Mcp Access Groups */
mcp_access_groups?: string[] | null;
/** Mcp Servers */
mcp_servers?: string[] | null;
/** Mcp Tool Permissions */
mcp_tool_permissions?: {
[key: string]: string[];
} | null;
/** Mcp Toolsets */
mcp_toolsets?: string[] | null;
/** Models */
models?: string[] | null;
/** Search Tools */
search_tools?: string[] | null;
/** Vector Stores */
vector_stores?: string[] | null;
};
/**
* LiteLLM_ObjectPermissionTable
* @description Represents a LiteLLM_ObjectPermissionTable record
*/
LiteLLM_ObjectPermissionTable: {
/**
* Agent Access Groups
* @default []
*/
agent_access_groups: string[] | null;
/**
* Agents
* @default []
*/
agents: string[] | null;
/**
* Blocked Tools
* @default []
*/
blocked_tools: string[] | null;
/**
* Mcp Access Groups
* @default []
*/
mcp_access_groups: string[] | null;
/**
* Mcp Servers
* @default []
*/
mcp_servers: string[] | null;
/** Mcp Tool Permissions */
mcp_tool_permissions?: {
[key: string]: string[];
} | null;
/** Mcp Toolsets */
mcp_toolsets?: string[] | null;
/**
* Models
* @default []
*/
models: string[] | null;
/** Object Permission Id */
object_permission_id: string;
/**
* Search Tools
* @default []
*/
search_tools: string[] | null;
/**
* Vector Stores
* @default []
*/
vector_stores: string[] | null;
};
/**
* LiteLLM_OrganizationMembershipTable
* @description Tracks which organizations a user belongs to and their spend within it.
*/
LiteLLM_OrganizationMembershipTable: {
/** Budget Id */
budget_id?: string | null;
/**
* Created At
* Format: date-time
*/
created_at: string;
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTable"] | null;
/** Organization Id */
organization_id: string;
/**
* Spend
* @default 0
*/
spend: number;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** User */
user?: unknown | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
/** User Role */
user_role?: string | null;
};
/**
* LiteLLM_OrganizationTableWithMembers
* @description Returned by the /organization/info endpoint and /organization/list endpoint
*/
LiteLLM_OrganizationTableWithMembers: {
/** Budget Id */
budget_id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Created By */
created_by: string;
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTable"] | null;
/**
* Members
* @default []
*/
members: components["schemas"]["LiteLLM_OrganizationMembershipTable"][];
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: string[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Alias */
organization_alias?: string | null;
/** Organization Id */
organization_id?: string | null;
/**
* Spend
* @default 0
*/
spend: number;
/**
* Teams
* @default []
*/
teams: components["schemas"]["LiteLLM_TeamTable"][];
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated By */
updated_by: string;
/** Users */
users?: components["schemas"]["LiteLLM_UserTable"][] | null;
};
/**
* LiteLLM_Params
* @description LiteLLM Params with 'model' requirement - used for completions
*/
LiteLLM_Params: {
/** Adaptive Router Config */
adaptive_router_config?: {
[key: string]: unknown;
} | null;
/** Adaptive Router Default Model */
adaptive_router_default_model?: string | null;
/** Api Base */
api_base?: string | null;
/** Api Key */
api_key?: string | null;
/** Api Version */
api_version?: string | null;
/** Auto Router Config */
auto_router_config?: string | null;
/** Auto Router Config Path */
auto_router_config_path?: string | null;
/** Auto Router Default Model */
auto_router_default_model?: string | null;
/** Auto Router Embedding Model */
auto_router_embedding_model?: string | null;
/** Aws Access Key Id */
aws_access_key_id?: string | null;
/** Aws Bedrock Runtime Endpoint */
aws_bedrock_runtime_endpoint?: string | null;
/** Aws Region Name */
aws_region_name?: string | null;
/** Aws Secret Access Key */
aws_secret_access_key?: string | null;
/** Budget Duration */
budget_duration?: string | null;
/** Cache Creation Input Audio Token Cost */
cache_creation_input_audio_token_cost?: number | null;
/** Cache Creation Input Token Cost */
cache_creation_input_token_cost?: number | null;
/** Cache Creation Input Token Cost Above 1Hr */
cache_creation_input_token_cost_above_1hr?: number | null;
/** Cache Creation Input Token Cost Above 200K Tokens */
cache_creation_input_token_cost_above_200k_tokens?: number | null;
/** Cache Read Input Audio Token Cost */
cache_read_input_audio_token_cost?: number | null;
/** Cache Read Input Token Cost */
cache_read_input_token_cost?: number | null;
/** Cache Read Input Token Cost Above 200K Tokens */
cache_read_input_token_cost_above_200k_tokens?: number | null;
/** Cache Read Input Token Cost Flex */
cache_read_input_token_cost_flex?: number | null;
/** Cache Read Input Token Cost Priority */
cache_read_input_token_cost_priority?: number | null;
/** Citation Cost Per Token */
citation_cost_per_token?: number | null;
/** Complexity Router Config */
complexity_router_config?: {
[key: string]: unknown;
} | null;
/** Complexity Router Default Model */
complexity_router_default_model?: string | null;
/** Configurable Clientside Auth Params */
configurable_clientside_auth_params?: (string | components["schemas"]["ConfigurableClientsideParamsCustomAuth-Input"])[] | null;
/** Custom Llm Provider */
custom_llm_provider?: string | null;
/** Default Api Key Rpm Limit */
default_api_key_rpm_limit?: number | null;
/** Default Api Key Tpm Limit */
default_api_key_tpm_limit?: number | null;
/** Gcs Bucket Name */
gcs_bucket_name?: string | null;
/** Input Cost Per Audio Per Second */
input_cost_per_audio_per_second?: number | null;
/** Input Cost Per Audio Per Second Above 128K Tokens */
input_cost_per_audio_per_second_above_128k_tokens?: number | null;
/** Input Cost Per Audio Token */
input_cost_per_audio_token?: number | null;
/** Input Cost Per Character */
input_cost_per_character?: number | null;
/** Input Cost Per Character Above 128K Tokens */
input_cost_per_character_above_128k_tokens?: number | null;
/** Input Cost Per Image */
input_cost_per_image?: number | null;
/** Input Cost Per Image Above 128K Tokens */
input_cost_per_image_above_128k_tokens?: number | null;
/** Input Cost Per Pixel */
input_cost_per_pixel?: number | null;
/** Input Cost Per Query */
input_cost_per_query?: number | null;
/** Input Cost Per Second */
input_cost_per_second?: number | null;
/** Input Cost Per Token */
input_cost_per_token?: number | null;
/** Input Cost Per Token Above 128K Tokens */
input_cost_per_token_above_128k_tokens?: number | null;
/** Input Cost Per Token Above 200K Tokens */
input_cost_per_token_above_200k_tokens?: number | null;
/** Input Cost Per Token Batches */
input_cost_per_token_batches?: number | null;
/** Input Cost Per Token Cache Hit */
input_cost_per_token_cache_hit?: number | null;
/** Input Cost Per Token Flex */
input_cost_per_token_flex?: number | null;
/** Input Cost Per Token Priority */
input_cost_per_token_priority?: number | null;
/** Input Cost Per Video Per Second */
input_cost_per_video_per_second?: number | null;
/** Input Cost Per Video Per Second Above 128K Tokens */
input_cost_per_video_per_second_above_128k_tokens?: number | null;
/** Input Cost Per Video Per Second Above 15S Interval */
input_cost_per_video_per_second_above_15s_interval?: number | null;
/** Input Cost Per Video Per Second Above 8S Interval */
input_cost_per_video_per_second_above_8s_interval?: number | null;
/** Litellm Credential Name */
litellm_credential_name?: string | null;
/** Litellm Trace Id */
litellm_trace_id?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max File Size Mb */
max_file_size_mb?: number | null;
/** Max Retries */
max_retries?: number | null;
/**
* Merge Reasoning Content In Choices
* @default false
*/
merge_reasoning_content_in_choices: boolean | null;
/** Milvus Db Name */
milvus_db_name?: string | null;
/** Milvus Partition Names */
milvus_partition_names?: string[] | null;
/** Milvus Text Field */
milvus_text_field?: string | null;
/** Mock Response */
mock_response?: string | components["schemas"]["ModelResponse"] | unknown | null;
/** Model */
model: string;
/** Model Info */
model_info?: {
[key: string]: unknown;
} | null;
/** Organization */
organization?: string | null;
/** Output Cost Per Audio Per Second */
output_cost_per_audio_per_second?: number | null;
/** Output Cost Per Audio Token */
output_cost_per_audio_token?: number | null;
/** Output Cost Per Character */
output_cost_per_character?: number | null;
/** Output Cost Per Character Above 128K Tokens */
output_cost_per_character_above_128k_tokens?: number | null;
/** Output Cost Per Image */
output_cost_per_image?: number | null;
/** Output Cost Per Image Token */
output_cost_per_image_token?: number | null;
/** Output Cost Per Pixel */
output_cost_per_pixel?: number | null;
/** Output Cost Per Reasoning Token */
output_cost_per_reasoning_token?: number | null;
/** Output Cost Per Second */
output_cost_per_second?: number | null;
/** Output Cost Per Second 1080P */
output_cost_per_second_1080p?: number | null;
/** Output Cost Per Token */
output_cost_per_token?: number | null;
/** Output Cost Per Token Above 128K Tokens */
output_cost_per_token_above_128k_tokens?: number | null;
/** Output Cost Per Token Above 200K Tokens */
output_cost_per_token_above_200k_tokens?: number | null;
/** Output Cost Per Token Batches */
output_cost_per_token_batches?: number | null;
/** Output Cost Per Token Flex */
output_cost_per_token_flex?: number | null;
/** Output Cost Per Token Priority */
output_cost_per_token_priority?: number | null;
/** Output Cost Per Video Per Second */
output_cost_per_video_per_second?: number | null;
/** Quality Router Config */
quality_router_config?: {
[key: string]: unknown;
} | null;
/** Quality Router Default Model */
quality_router_default_model?: string | null;
/** Region Name */
region_name?: string | null;
/** Rpm */
rpm?: number | null;
/** S3 Bucket Name */
s3_bucket_name?: string | null;
/** S3 Encryption Key Id */
s3_encryption_key_id?: string | null;
/** Search Context Cost Per Query */
search_context_cost_per_query?: {
[key: string]: unknown;
} | null;
/** Stream Timeout */
stream_timeout?: number | string | null;
/** Tag Regex */
tag_regex?: string[] | null;
/** Tags */
tags?: string[] | null;
/** Tiered Pricing */
tiered_pricing?: {
[key: string]: unknown;
}[] | null;
/** Timeout */
timeout?: number | string | null;
/** Tpm */
tpm?: number | null;
/** Use Chat Completions Api */
use_chat_completions_api?: boolean | null;
/**
* Use In Pass Through
* @default false
*/
use_in_pass_through: boolean | null;
/**
* Use Litellm Proxy
* @default false
*/
use_litellm_proxy: boolean | null;
/**
* Use Xai Oauth
* @description Use stored xAI OAuth credentials when no xAI API key is configured.
* @default false
*/
use_xai_oauth: boolean | null;
/** Vector Store Id */
vector_store_id?: string | null;
/** Vertex Credentials */
vertex_credentials?: string | {
[key: string]: unknown;
} | null;
/** Vertex Location */
vertex_location?: string | null;
/** Vertex Project */
vertex_project?: string | null;
/** Watsonx Region Name */
watsonx_region_name?: string | null;
} & {
[key: string]: unknown;
};
/**
* LiteLLM_ProjectTable
* @description Database model representation for project
*/
LiteLLM_ProjectTable: {
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Id */
budget_id?: string | null;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Description */
description?: string | null;
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTable"] | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Spend */
model_spend?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: string[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Project Alias */
project_alias?: string | null;
/** Project Id */
project_id: string;
/**
* Spend
* @default 0
*/
spend: number;
/** Team Id */
team_id?: string | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
};
/** LiteLLM_SpendLogs */
LiteLLM_SpendLogs: {
/**
* Api Base
* @default
*/
api_base: string | null;
/** Api Key */
api_key: string;
/**
* Cache Hit
* @default False
*/
cache_hit: string | null;
/** Cache Key */
cache_key?: string | null;
/** Call Type */
call_type: string;
/**
* Completion Tokens
* @default 0
*/
completion_tokens: number | null;
/** Endtime */
endTime: string | null;
/** Messages */
messages: string | unknown[] | {
[key: string]: unknown;
} | null;
/**
* Metadata
* @default {}
*/
metadata: unknown | null;
/**
* Model
* @default
*/
model: string | null;
/**
* Prompt Tokens
* @default 0
*/
prompt_tokens: number | null;
/** Request Id */
request_id: string;
/** Request Tags */
request_tags?: unknown | null;
/** Requester Ip Address */
requester_ip_address?: string | null;
/** Response */
response: string | unknown[] | {
[key: string]: unknown;
} | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Starttime */
startTime: string | null;
/**
* Total Tokens
* @default 0
*/
total_tokens: number | null;
/**
* User
* @default
*/
user: string | null;
};
/** LiteLLM_TeamMembership */
LiteLLM_TeamMembership: {
/** Budget Id */
budget_id?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTableFull"] | components["schemas"]["LiteLLM_BudgetTable"] | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Team Id */
team_id: string;
/**
* Total Spend
* @default 0
*/
total_spend: number | null;
/** User Id */
user_id: string;
};
/** LiteLLM_TeamTable */
LiteLLM_TeamTable: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/**
* Admins
* @default []
*/
admins: unknown[];
/**
* Allow Team Guardrail Config
* @default false
*/
allow_team_guardrail_config: boolean | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/** Default Team Member Models */
default_team_member_models?: string[] | null;
litellm_model_table?: components["schemas"]["LiteLLM_ModelTable"] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Members
* @default []
*/
members: unknown[];
/**
* Members With Roles
* @default []
*/
members_with_roles: components["schemas"]["Member"][];
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Id */
model_id?: number | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Id */
organization_id?: string | null;
/** Policies */
policies?: string[] | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Spend */
spend?: number | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id: string;
/** Team Member Permissions */
team_member_permissions?: string[] | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
};
/** LiteLLM_ToolTableRow */
LiteLLM_ToolTableRow: {
/** Assignments */
assignments?: {
[key: string]: unknown;
} | null;
/**
* Call Count
* @default 0
*/
call_count: number;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/**
* Input Policy
* @default untrusted
* @enum {string}
*/
input_policy: "trusted" | "untrusted" | "blocked";
/** Key Alias */
key_alias?: string | null;
/** Key Hash */
key_hash?: string | null;
/** Last Used At */
last_used_at?: string | null;
/** Origin */
origin?: string | null;
/**
* Output Policy
* @default untrusted
* @enum {string}
*/
output_policy: "trusted" | "untrusted";
/** Team Id */
team_id?: string | null;
/** Tool Id */
tool_id: string;
/** Tool Name */
tool_name: string;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User Agent */
user_agent?: string | null;
};
/** LiteLLM_UserTable */
LiteLLM_UserTable: {
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: string[];
/** Budget Duration */
budget_duration?: string | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Id */
organization_id?: string | null;
/** Organization Memberships */
organization_memberships?: components["schemas"]["LiteLLM_OrganizationMembershipTable"][] | null;
/**
* Policies
* @default []
*/
policies: string[];
/** Rpm Limit */
rpm_limit?: number | null;
/**
* Spend
* @default 0
*/
spend: number;
/** Sso User Id */
sso_user_id?: string | null;
/** Team Id */
team_id?: string | null;
/**
* Teams
* @default []
*/
teams: string[];
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
/** User Alias */
user_alias?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
/** User Role */
user_role?: string | null;
};
/** LiteLLM_UserTableFiltered */
LiteLLM_UserTableFiltered: {
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
};
/** LiteLLM_UserTableWithKeyCount */
LiteLLM_UserTableWithKeyCount: {
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: string[];
/** Budget Duration */
budget_duration?: string | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/**
* Key Count
* @default 0
*/
key_count: number;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Id */
organization_id?: string | null;
/** Organization Memberships */
organization_memberships?: components["schemas"]["LiteLLM_OrganizationMembershipTable"][] | null;
/**
* Policies
* @default []
*/
policies: string[];
/** Rpm Limit */
rpm_limit?: number | null;
/**
* Spend
* @default 0
*/
spend: number;
/** Sso User Id */
sso_user_id?: string | null;
/** Team Id */
team_id?: string | null;
/**
* Teams
* @default []
*/
teams: string[];
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
/** User Alias */
user_alias?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
/** User Role */
user_role?: string | null;
};
/** LiteLLM_VerificationToken */
LiteLLM_VerificationToken: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
};
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/**
* Auto Rotate
* @default false
*/
auto_rotate: boolean | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: {
[key: string]: unknown;
}[] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
};
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Expires */
expires?: string | null;
/** Key Alias */
key_alias?: string | null;
/** Key Name */
key_name?: string | null;
/** Key Rotation At */
key_rotation_at?: string | null;
/** Last Active */
last_active?: string | null;
/** Last Rotation At */
last_rotation_at?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: {
[key: string]: unknown;
} | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
};
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
};
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
};
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Org Id */
org_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
};
/** Project Id */
project_id?: string | null;
/**
* Rotation Count
* @default 0
*/
rotation_count: number | null;
/** Rotation Interval */
rotation_interval?: string | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/**
* Soft Budget Cooldown
* @default false
*/
soft_budget_cooldown: boolean;
/**
* Spend
* @default 0
*/
spend: number;
/** Team Id */
team_id?: string | null;
/** Token */
token?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User Id */
user_id?: string | null;
};
/** LitellmParams */
LitellmParams: {
/**
* Action
* @description 'block' raises an error; 'mask' replaces the code block with a placeholder.
* @default block
* @enum {string}
*/
action: "block" | "mask";
/**
* Additional Provider Specific Params
* @description Additional provider-specific parameters for generic guardrail APIs
*/
additional_provider_specific_params?: {
[key: string]: unknown;
} | null;
/**
* Akto Account Id
* @description Akto account ID for multi-tenant deployments. Env: AKTO_ACCOUNT_ID. Default: '1000000'.
*/
akto_account_id?: string | null;
/**
* Akto Api Key
* @description API key for Akto. Env: AKTO_API_KEY.
*/
akto_api_key?: string | null;
/**
* Akto Base Url
* @description Akto Guardrail API Base URL. Env: AKTO_GUARDRAIL_API_BASE.
* @example http://localhost:9090
* @example https://akto-ingestion.example.com
*/
akto_base_url?: string | null;
/**
* Akto Vxlan Id
* @description Akto VXLAN ID. Env: AKTO_VXLAN_ID. Default: '0'.
*/
akto_vxlan_id?: string | null;
/**
* Anonymize Input
* @description If True, replaces sensitive content with anonymized version when only PII/PCI/secrets are detected. Only applies in blocking mode. Defaults to False if not provided
*/
anonymize_input?: boolean | null;
/**
* Api Base
* @description Base URL for the Lakera AI API
*/
api_base?: string | null;
/**
* Api Endpoint
* @description Optional custom API endpoint for Model Armor
*/
api_endpoint?: string | null;
/**
* Api Id
* @description The Hiddenlayer API Id for the Hiddenlayer API. If not provided, the `HIDDENLAYER_CLIENT_ID` environment variable is checked or https://api.hiddenlayer.ai is used.
*/
api_id?: string | null;
/**
* Api Key
* @description API key for the Lakera AI service
*/
api_key?: string | null;
/**
* Api Version
* @description API version for Javelin service
* @default v1
*/
api_version: string | null;
/**
* Application
* @description Application name for Javelin service
*/
application?: string | null;
/**
* Application Id
* @description Application ID for Noma Security. Defaults to 'litellm' if not provided
*/
application_id?: string | null;
/**
* Assertions
* @description Custom assertions to validate against the output. Each assertion is a string describing a condition.
*/
assertions?: string[] | null;
/**
* Async Mode
* @description Set to True to request asynchronous analysis (sets `plr_async` header). Defaults to provider behaviour when omitted.
*/
async_mode?: boolean | null;
/**
* Auth Token
* @description Authorization bearer token for IBM Guardrails API. Reads from IBM_GUARDRAILS_AUTH_TOKEN env var if None.
*/
auth_token?: string | null;
/**
* Aws Access Key Id
* @description AWS access key ID for authentication
*/
aws_access_key_id?: string | null;
/**
* Aws Bedrock Runtime Endpoint
* @description AWS Bedrock runtime endpoint URL
*/
aws_bedrock_runtime_endpoint?: string | null;
/**
* Aws Profile Name
* @description AWS profile name for credential retrieval
*/
aws_profile_name?: string | null;
/**
* Aws Region Name
* @description AWS region where your guardrail is deployed
*/
aws_region_name?: string | null;
/**
* Aws Role Name
* @description AWS role name for assuming roles
*/
aws_role_name?: string | null;
/**
* Aws Secret Access Key
* @description AWS secret access key for authentication
*/
aws_secret_access_key?: string | null;
/**
* Aws Session Name
* @description Name of the AWS session
*/
aws_session_name?: string | null;
/**
* Aws Session Token
* @description AWS session token for temporary credentials
*/
aws_session_token?: string | null;
/**
* Aws Sts Endpoint
* @description AWS STS endpoint URL
*/
aws_sts_endpoint?: string | null;
/**
* Aws Web Identity Token
* @description Web identity token for AWS role assumption
*/
aws_web_identity_token?: string | null;
/**
* Base Url
* @description Base URL for the IBM Guardrails server
*/
base_url?: string | null;
/**
* Block Failures
* @description If True, blocks requests on API failures. Defaults to True if not provided
*/
block_failures?: boolean | null;
/**
* Block On Error
* @description Whether to block the request when the PromptGuard API is unreachable. Defaults to true (fail-closed). Set to false for fail-open behaviour.
*/
block_on_error?: boolean | null;
/**
* Block On Violation
* @description Whether to block requests when violations are detected. Defaults to True.
* @default true
*/
block_on_violation: boolean | null;
/**
* Blocked Languages
* @description Language tags to block (e.g. python, javascript, bash). Empty or None = block all fenced code blocks.
*/
blocked_languages?: 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;
/**
* Breakdown
* @description Whether to include breakdown in the response
* @default true
*/
breakdown: boolean | 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;
/**
* Confidence Threshold
* @description Only block or mask when detection confidence >= this value; below threshold, allow or log_only.
* @default 0.5
*/
confidence_threshold: number;
/**
* Config
* @description Additional configuration for the guardrail
*/
config?: {
[key: string]: unknown;
} | null;
/**
* Content Moderation Check
* @description Enable content moderation to check for harmful content (harassment, hate speech, etc.).
*/
content_moderation_check?: boolean | 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 Action
* @description Fallback decision when no rule matches
* @default deny
* @enum {string}
*/
default_action: "allow" | "deny";
/**
* Default On
* @description Whether the guardrail is enabled by default
*/
default_on?: boolean | null;
/**
* Deployment Name
* @description The EnkryptAI deployment name to use. Sent via X-Enkrypt-Deployment header.
*/
deployment_name?: string | null;
/**
* Detect Execution Intent
* @description When True, block only when user intent is to run/execute; allow when intent is explain/refactor/don't run. Also block text-only execution requests (e.g. 'run `ls`', 'read /etc/passwd').
* @default true
*/
detect_execution_intent: boolean;
/**
* Detect Secrets Config
* @description Configuration for detect-secrets guardrail
*/
detect_secrets_config?: {
[key: string]: unknown;
} | null;
/**
* Detector Id
* @description Name of the detector inside the server (e.g., 'jailbreak-detector')
*/
detector_id?: string | null;
/**
* Detectors
* @description Dictionary of detector configurations (e.g., {'nsfw': {'enabled': True}, 'toxicity': {'enabled': True}}).
*/
detectors?: {
[key: string]: unknown;
} | null;
/**
* Dev Info
* @description Whether to include developer information in the response
* @default true
*/
dev_info: boolean | null;
/**
* Disable Exception On Block
* @description If True, will not raise an exception when the guardrail is blocked. Useful for OpenWebUI where exceptions can end the chat flow.
* @default false
*/
disable_exception_on_block: boolean | 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;
/**
* Evaluation Id
* @description Pre-configured evaluation ID from Qualifire dashboard. When provided, uses invoke_evaluation() instead of evaluate().
*/
evaluation_id?: string | 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
* @default true
*/
fail_on_error: boolean | null;
/**
* Grounding Check
* @description Enable grounding verification to ensure output is grounded in provided context.
*/
grounding_check?: boolean | null;
/**
* Grounding Strictness
* @description Strictness level for XecGuard context-grounding validation. 'BALANCED' (default) treats INCOMPLETE answers as SAFE; 'STRICT' flags them as UNSAFE. Grounding only runs in post_call when `metadata.xecguard_grounding_documents` is provided.
*/
grounding_strictness?: ("BALANCED" | "STRICT") | null;
/**
* Guard Name
* @description Name of the Javelin guard to use
*/
guard_name?: string | null;
/**
* Guardrail
* @description The type of guardrail integration to use
*/
guardrail: string;
/**
* Guardrailidentifier
* @description The ID of your guardrail on Bedrock
*/
guardrailIdentifier?: string | null;
/**
* Guardrailversion
* @description The version of your Bedrock guardrail (e.g., DRAFT or version number)
*/
guardrailVersion?: string | null;
/**
* Guardrail Timeout
* @description HTTP timeout in seconds. Default: 5.
*/
guardrail_timeout?: number | null;
/**
* Hallucinations Check
* @description Enable hallucination detection to detect factual inaccuracies.
*/
hallucinations_check?: boolean | null;
/**
* Include Evidence
* @description Include detailed evidence payloads in responses (sets `plr_evidence` header).
* @default true
*/
include_evidence: boolean | null;
/**
* Include Scanners
* @description Include scanner category summaries in responses (sets `plr_scanners` header).
* @default true
*/
include_scanners: boolean | null;
/**
* Is Detector Server
* @description Boolean flag to determine if calling a detector server (True) or the FMS Orchestrator (False). Defaults to True.
* @default true
*/
is_detector_server: boolean | null;
/**
* Keyword Redaction Tag
* @description Tag to use for keyword redaction
*/
keyword_redaction_tag?: string | null;
/**
* Lasso Conversation Id
* @description Conversation ID for the Lasso guardrail
*/
lasso_conversation_id?: string | null;
/**
* Lasso User Id
* @description User ID for the Lasso guardrail
*/
lasso_user_id?: string | null;
/**
* Location
* @description Google Cloud location/region (e.g., us-central1)
*/
location?: string | null;
/**
* Mask
* @description Enable content masking using Lasso classifix API
* @default false
*/
mask: boolean | 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;
/**
* Metadata
* @description Additional metadata to include in the request
*/
metadata?: {
[key: string]: unknown;
} | null;
/**
* Mock Redacted Text
* @description Mock redacted text for testing
*/
mock_redacted_text?: {
[key: string]: unknown;
} | null;
/**
* Mode
* @description When to apply the guardrail (pre_call, post_call, during_call, logging_only)
*/
mode: string | string[] | components["schemas"]["Mode"];
/**
* Model
* @description Optional field if guardrail requires a 'model' parameter
*/
model?: string | null;
/**
* Monitor Mode
* @description If True, logs violations without blocking. Defaults to False if not provided
*/
monitor_mode?: boolean | null;
/**
* On Disallowed Action
* @description Choose whether disallowed tools block the request or get rewritten out of the payload
* @default block
* @enum {string}
*/
on_disallowed_action: "block" | "rewrite";
/**
* On Flagged
* @description Action to take when content is flagged: 'block' (raise exception) or 'monitor' (log only)
* @default block
*/
on_flagged: ("block" | "monitor") | null;
/**
* On Flagged Action
* @description Action to take when content is flagged: 'block' (raise exception) or 'monitor' (log only)
* @default monitor
*/
on_flagged_action: 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;
/** @description Optional parameters for the guardrail */
optional_params?: components["schemas"]["GraySwanGuardrailConfigModelOptionalParams"] | null;
/**
* Output Parse Pii
* @description When True, LiteLLM will replace the masked text with the original text in the response
*/
output_parse_pii?: boolean | 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;
/**
* Payload
* @description Whether to include payload in the response
* @default true
*/
payload: boolean | null;
/**
* Persist Session
* @description Controls Pillar session persistence (sets `plr_persist` header). Set to False to disable persistence.
*/
persist_session?: boolean | null;
/**
* Pii Check
* @description Enable PII (Personally Identifiable Information) detection.
*/
pii_check?: boolean | null;
/**
* Pii Entities Config
* @description Configuration for PII entity types and actions
*/
pii_entities_config?: {
[key: string]: components["schemas"]["PiiAction"];
} | null;
/**
* Policy Id
* @description Policy ID for Zscaler AI Guard. Can also be set via ZSCALER_AI_GUARD_POLICY_ID environment variable
*/
policy_id?: number | null;
/**
* Policy Name
* @description The EnkryptAI policy name to use. Sent via x-enkrypt-policy header.
*/
policy_name?: string | null;
/**
* Policy Names
* @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;
/**
* Presidio Ad Hoc Recognizers
* @description Path to a JSON file containing ad-hoc recognizers for Presidio
*/
presidio_ad_hoc_recognizers?: string | null;
/**
* Presidio Analyzer Api Base
* @description Base URL for the Presidio analyzer API
*/
presidio_analyzer_api_base?: string | null;
/**
* Presidio Anonymizer Api Base
* @description Base URL for the Presidio anonymizer API
*/
presidio_anonymizer_api_base?: string | null;
/**
* Presidio Entities Deny List
* @description List of entity types to exclude from Presidio detection results. Detections of these types will be silently dropped. Useful for suppressing false positives (e.g., US_DRIVER_LICENSE on coding routes).
*/
presidio_entities_deny_list?: (components["schemas"]["PiiEntityType"] | string)[] | null;
/**
* Presidio Filter Scope
* @description Where to apply Presidio checks: 'input' (user -> model), 'output' (model -> user), or 'both' (default).
*/
presidio_filter_scope?: ("input" | "output" | "both") | null;
/**
* Presidio Language
* @description Language code for Presidio PII analysis (e.g., 'en', 'de', 'es', 'fr')
* @default en
*/
presidio_language: string | null;
/**
* Presidio Run On
* @description Where to apply Presidio checks: input, output, or both (default).
*/
presidio_run_on?: ("input" | "output" | "both") | null;
/**
* Presidio Score Thresholds
* @description Optional per-entity minimum confidence scores for Presidio detections. Entities below the threshold are ignored.
*/
presidio_score_thresholds?: {
[key: string]: number;
} | null;
/**
* Project Id
* @description Project ID for the Lakera AI project
*/
project_id?: string | null;
/**
* Prompt Injections
* @description Enable prompt injection detection. Default check if no evaluation_id and no other checks are specified.
*/
prompt_injections?: boolean | 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;
/**
* Rules
* @description Ordered allow/deny rules. Patterns use regex for tool names/types and optional regex constraints on tool arguments.
*/
rules?: components["schemas"]["ToolPermissionRule"][] | null;
/**
* Send User Api Key Alias
* @description Whether to send user_API_key_alias in headers
* @default false
*/
send_user_api_key_alias: boolean | null;
/**
* Send User Api Key Team Id
* @description Whether to send user_API_key_team_id in headers
* @default false
*/
send_user_api_key_team_id: boolean | null;
/**
* Send User Api Key User Id
* @description Whether to send user_API_key_user_id in headers
* @default false
*/
send_user_api_key_user_id: boolean | 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;
/**
* Template Id
* @description The ID of your Model Armor template
*/
template_id?: string | null;
/**
* Tool Selection Quality Check
* @description Enable tool selection quality check to evaluate quality of tool/function calls.
*/
tool_selection_quality_check?: boolean | null;
/**
* Unreachable Fallback
* @description What to do when Akto is unreachable. 'fail_open' = allow, 'fail_closed' = block.
* @default fail_closed
* @enum {string}
*/
unreachable_fallback: "fail_closed" | "fail_open";
/**
* Use V2
* @description If True and guardrail='noma', route to the new Noma v2 implementation instead of the legacy implementation.
* @default false
*/
use_v2: boolean | null;
/**
* Verify Ssl
* @description Whether to verify SSL certificates. Defaults to True.
* @default true
*/
verify_ssl: boolean | null;
/**
* Version
* @description Hiddenlayer guardrail version to use.
* @default 2
*/
version: number | null;
/**
* 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;
/**
* Xecguard Model
* @description XecGuard scanning model identifier. Defaults to 'xecguard_v2'.
*/
xecguard_model?: string | null;
} & {
[key: string]: unknown;
};
/**
* LitellmUserRoles
* @description Admin Roles:
* PROXY_ADMIN: admin over the platform
* PROXY_ADMIN_VIEW_ONLY: can login, view all own keys, view all spend
* ORG_ADMIN: admin over a specific organization, can create teams, users only within their organization
*
* Internal User Roles:
* INTERNAL_USER: can login, view/create/delete their own keys, view their spend
* INTERNAL_USER_VIEW_ONLY: can login, view their own keys, view their own spend
*
*
* Team Roles:
* TEAM: used for JWT auth
*
*
* Customer Roles:
* CUSTOMER: External users -> these are customers
* @enum {string}
*/
LitellmUserRoles: "proxy_admin" | "proxy_admin_viewer" | "org_admin" | "internal_user" | "internal_user_viewer" | "team" | "customer";
/** LoggingCallbackStatus */
LoggingCallbackStatus: {
/** Callbacks */
callbacks?: string[];
/** Details */
details?: string | null;
/**
* Status
* @enum {string}
*/
status?: "healthy" | "unhealthy";
};
/** MCPCredentials */
MCPCredentials: {
/** Auth Value */
auth_value?: string | null;
/** Aws Access Key Id */
aws_access_key_id?: string | null;
/** Aws Region Name */
aws_region_name?: string | null;
/** Aws Role Name */
aws_role_name?: string | null;
/** Aws Secret Access Key */
aws_secret_access_key?: string | null;
/** Aws Service Name */
aws_service_name?: string | null;
/** Aws Session Name */
aws_session_name?: string | null;
/** Aws Session Token */
aws_session_token?: string | null;
/** Client Id */
client_id?: string | null;
/** Client Secret */
client_secret?: string | null;
/** Scopes */
scopes?: string[] | null;
};
/**
* MCPOAuthUserCredentialRequest
* @description Stores a user's OAuth2 token for an OpenAPI MCP server.
*/
MCPOAuthUserCredentialRequest: {
/** Access Token */
access_token: string;
/** Expires In */
expires_in?: number | null;
/** Refresh Token */
refresh_token?: string | null;
/** Scopes */
scopes?: string[] | null;
};
/**
* MCPOAuthUserCredentialStatus
* @description Describes whether the calling user has a stored OAuth credential.
*/
MCPOAuthUserCredentialStatus: {
/** Connected At */
connected_at?: string | null;
/** Expires At */
expires_at?: string | null;
/** Has Credential */
has_credential: boolean;
/**
* Is Expired
* @default false
*/
is_expired: boolean;
/** Server Id */
server_id: string;
};
/**
* MCPPublicServer
* @description Safe params for public MCP servers
*/
MCPPublicServer: {
/** Alias */
alias?: string | null;
/** Auth Type */
auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token" | "oauth2_token_exchange") | null;
/** Mcp Info */
mcp_info?: {
[key: string]: unknown;
} | null;
/** Name */
name: string;
/** Server Id */
server_id: string;
/** Server Name */
server_name?: string | null;
/** Spec Path */
spec_path?: string | null;
/**
* Transport
* @enum {string}
*/
transport: "sse" | "http" | "stdio";
/** Url */
url?: string | null;
};
/**
* MCPSemanticFilterSettings
* @description Configuration for MCP Semantic Tool Filter
*/
MCPSemanticFilterSettings: {
/**
* Embedding Model
* @description Embedding model to use for semantic similarity (e.g., 'text-embedding-3-small', 'text-embedding-ada-002')
* @default text-embedding-3-small
*/
embedding_model: string;
/**
* Enabled
* @description Enable semantic filtering of MCP tools based on query relevance
* @default false
*/
enabled: boolean;
/**
* Similarity Threshold
* @description Minimum similarity score for tool inclusion (0.0 to 1.0, where 1.0 = exact match)
* @default 0.3
*/
similarity_threshold: number;
/**
* Top K
* @description Number of most relevant tools to return
* @default 10
*/
top_k: number;
};
/**
* MCPSemanticFilterSettingsResponse
* @description Response model for MCP semantic filter settings
*/
MCPSemanticFilterSettingsResponse: {
/** Field Schema */
field_schema: {
[key: string]: unknown;
};
/** Values */
values: {
[key: string]: unknown;
};
};
/** MCPSubmissionsSummary */
MCPSubmissionsSummary: {
/** Active */
active: number;
/** Items */
items: components["schemas"]["LiteLLM_MCPServerTable"][];
/** Pending Review */
pending_review: number;
/** Rejected */
rejected: number;
/** Total */
total: number;
};
/** MCPToolsetTool */
MCPToolsetTool: {
/** Server Id */
server_id: string;
/** Tool Name */
tool_name: string;
};
/**
* MCPUserCredentialListItem
* @description One entry in the /user-credentials list.
*/
MCPUserCredentialListItem: {
/** Alias */
alias?: string | null;
/** Connected At */
connected_at?: string | null;
/** Credential Type */
credential_type: string;
/** Expires At */
expires_at?: string | null;
/** Has Credential */
has_credential: boolean;
/** Server Id */
server_id: string;
/** Server Name */
server_name?: string | null;
};
/** MCPUserCredentialRequest */
MCPUserCredentialRequest: {
/** Credential */
credential: string;
/**
* Save
* @default true
*/
save: boolean;
};
/** MCPUserCredentialResponse */
MCPUserCredentialResponse: {
/** Has Credential */
has_credential: boolean;
/** Server Id */
server_id: string;
};
/** MakeAgentsPublicRequest */
MakeAgentsPublicRequest: {
/** Agent Ids */
agent_ids: string[];
};
/** MakeMCPServersPublicRequest */
MakeMCPServersPublicRequest: {
/** Mcp Server Ids */
mcp_server_ids: string[];
};
/** Member */
Member: {
/**
* Role
* @description The role of the user within the team. 'admin' users can manage team settings and members, 'user' is a regular team member
* @enum {string}
*/
role: "admin" | "user";
/**
* User Email
* @description The email address of the user to add. Either user_id or user_email must be provided
*/
user_email?: string | null;
/**
* User Id
* @description The unique ID of the user to add. Either user_id or user_email must be provided
*/
user_id?: string | null;
};
/** MemoryCreateRequest */
MemoryCreateRequest: {
/**
* Key
* @description Memory key (acts as the namespace in the URL).
*/
key: string;
/**
* Metadata
* @description Optional JSON metadata (tags, structured fields).
*/
metadata?: unknown | null;
/**
* Team Id
* @description Scope to this team. Defaults to the caller's team_id.
*/
team_id?: string | null;
/**
* User Id
* @description Scope to this user. Defaults to the caller's user_id.
*/
user_id?: string | null;
/**
* Value
* @description Memory content. Typically markdown/text for LLM context.
*/
value: string;
};
/** MemoryDeleteResponse */
MemoryDeleteResponse: {
/** Deleted */
deleted: boolean;
/** Key */
key: string;
};
/** MemoryListResponse */
MemoryListResponse: {
/** Memories */
memories: components["schemas"]["LiteLLM_MemoryRow"][];
/** Total */
total: number;
};
/** MemoryUpdateRequest */
MemoryUpdateRequest: {
/** Metadata */
metadata?: unknown | null;
/** Team Id */
team_id?: string | null;
/** User Id */
user_id?: string | null;
/** Value */
value?: string | null;
};
/** Message */
Message: {
/** Annotations */
annotations?: components["schemas"]["ChatCompletionAnnotation"][] | null;
audio?: components["schemas"]["ChatCompletionAudioResponse"] | null;
/** Content */
content: string | null;
function_call: components["schemas"]["FunctionCall"] | null;
/** Images */
images?: components["schemas"]["ImageURLListItem"][] | null;
/** Provider Specific Fields */
provider_specific_fields?: {
[key: string]: unknown;
} | null;
/** Reasoning Content */
reasoning_content?: string | null;
/** Reasoning Items */
reasoning_items?: components["schemas"]["ChatCompletionReasoningItem"][] | null;
/**
* Role
* @enum {string}
*/
role: "assistant" | "user" | "system" | "tool" | "function";
/** Thinking Blocks */
thinking_blocks?: (components["schemas"]["ChatCompletionThinkingBlock"] | components["schemas"]["ChatCompletionRedactedThinkingBlock"])[] | null;
/** Tool Calls */
tool_calls: components["schemas"]["ChatCompletionMessageToolCall"][] | null;
} & {
[key: string]: unknown;
};
/** MetricWithMetadata */
MetricWithMetadata: {
/** Api Key Breakdown */
api_key_breakdown?: {
[key: string]: components["schemas"]["KeyMetricWithMetadata"];
};
/** Metadata */
metadata?: {
[key: string]: unknown;
};
metrics: components["schemas"]["SpendMetrics"];
};
/** Mode */
Mode: {
/**
* Default
* @description Default mode when no tags match
*/
default?: string | string[] | null;
/**
* Tags
* @description Tags for the guardrail mode
*/
tags: {
[key: string]: string | string[];
};
};
/** ModelGroupInfoProxy */
ModelGroupInfoProxy: {
/** Configurable Clientside Auth Params */
configurable_clientside_auth_params?: (string | components["schemas"]["ConfigurableClientsideParamsCustomAuth-Output"])[] | null;
/** Health Checked At */
health_checked_at?: string | null;
/** Health Response Time */
health_response_time?: number | null;
/** Health Status */
health_status?: string | null;
/** Input Cost Per Pixel */
input_cost_per_pixel?: number | null;
/** Input Cost Per Token */
input_cost_per_token?: number | null;
/**
* Is Public Model Group
* @default false
*/
is_public_model_group: boolean;
/** Max Input Tokens */
max_input_tokens?: number | null;
/** Max Output Tokens */
max_output_tokens?: number | null;
/**
* Mode
* @default chat
*/
mode: string | ("chat" | "embedding" | "completion" | "image_generation" | "audio_transcription" | "rerank" | "moderations") | null;
/** Model Group */
model_group: string;
/** Output Cost Per Token */
output_cost_per_token?: number | null;
/** Providers */
providers: string[];
/** Rpm */
rpm?: number | null;
/**
* Supported Openai Params
* @default []
*/
supported_openai_params: string[] | null;
/**
* Supports Function Calling
* @default false
*/
supports_function_calling: boolean;
/**
* Supports Parallel Function Calling
* @default false
*/
supports_parallel_function_calling: boolean;
/**
* Supports Reasoning
* @default false
*/
supports_reasoning: boolean;
/**
* Supports Url Context
* @default false
*/
supports_url_context: boolean;
/**
* Supports Vision
* @default false
*/
supports_vision: boolean;
/**
* Supports Web Search
* @default false
*/
supports_web_search: boolean;
/** Tpm */
tpm?: number | null;
};
/** ModelInfoDelete */
ModelInfoDelete: {
/** Id */
id: string;
};
/** ModelParams */
ModelParams: {
/** Litellm Params */
litellm_params: {
[key: string]: unknown;
};
model_info: components["schemas"]["litellm__proxy___types__ModelInfo"];
/** Model Name */
model_name: string;
};
/** ModelResponse */
ModelResponse: {
/** Choices */
choices: components["schemas"]["Choices"][];
/** Created */
created: number;
/** Id */
id: string;
/** Model */
model?: string | null;
/** Object */
object: string;
/** System Fingerprint */
system_fingerprint?: string | null;
} & {
[key: string]: unknown;
};
/**
* MutualTLSSecurityScheme
* @description Defines a security scheme using mTLS authentication.
*/
MutualTLSSecurityScheme: {
/** Description */
description?: string | null;
/**
* Type
* @constant
*/
type: "mutualTLS";
};
/**
* NewCustomerRequest
* @description Create a new customer, allocate a budget to them
*/
NewCustomerRequest: {
/** Alias */
alias?: string | null;
/** Allowed Model Region */
allowed_model_region?: ("eu" | "us") | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/**
* Budget Duration
* @description Max duration budget should be set for (e.g. '1hr', '1d', '28d')
*/
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/**
* Budget Reset At
* @description Datetime when the budget is reset
*/
budget_reset_at?: string | null;
/** Default Model */
default_model?: string | null;
/**
* Max Budget
* @description Requests will fail if this budget (in USD) is exceeded.
*/
max_budget?: number | null;
/**
* Max Parallel Requests
* @description Max concurrent requests allowed for this budget id.
*/
max_parallel_requests?: number | null;
/**
* Model Max Budget
* @description Max budget for each model (e.g. {'gpt-4o': {'max_budget': '0.0000001', 'budget_duration': '1d', 'tpm_limit': 1000, 'rpm_limit': 1000}})
*/
model_max_budget?: {
[key: string]: components["schemas"]["BudgetConfig"];
} | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/**
* Rpm Limit
* @description Max requests per minute, allowed for this budget id.
*/
rpm_limit?: number | null;
/**
* Soft Budget
* @description Requests will NOT fail if this is exceeded. Will fire alerting though.
*/
soft_budget?: number | null;
/** Spend */
spend?: number | null;
/**
* Tpm Limit
* @description Max tokens per minute, allowed for this budget id.
*/
tpm_limit?: number | null;
/** User Id */
user_id: string;
};
/** NewMCPServerRequest */
NewMCPServerRequest: {
/** Alias */
alias?: string | null;
/**
* Allow All Keys
* @default false
*/
allow_all_keys: boolean;
/** Allowed Tools */
allowed_tools?: string[] | null;
/**
* Approval Status
* @description Server-managed: set by the endpoint; caller values are overridden.
*/
approval_status?: string | null;
/** Args */
args?: string[];
/** Auth Type */
auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token") | null;
/** Authorization Url */
authorization_url?: string | null;
/**
* Available On Public Internet
* @default true
*/
available_on_public_internet: boolean;
/** Byok Api Key Help Url */
byok_api_key_help_url?: string | null;
/** Byok Description */
byok_description?: string[];
/** Command */
command?: string | null;
credentials?: components["schemas"]["MCPCredentials"] | null;
/** Description */
description?: string | null;
/** Env */
env?: {
[key: string]: string;
};
/** Extra Headers */
extra_headers?: string[] | null;
/** Instructions */
instructions?: string | null;
/**
* Is Byok
* @default false
*/
is_byok: boolean;
/** Mcp Access Groups */
mcp_access_groups?: string[];
/** Mcp Info */
mcp_info?: {
[key: string]: unknown;
} | null;
/** Oauth2 Flow */
oauth2_flow?: ("client_credentials" | "authorization_code") | null;
/** Registration Url */
registration_url?: string | null;
/** Server Id */
server_id?: string | null;
/** Server Name */
server_name?: string | null;
/** Source Url */
source_url?: string | null;
/** Spec Path */
spec_path?: string | null;
/** Static Headers */
static_headers?: {
[key: string]: string;
} | null;
/**
* Submitted At
* @description Server-managed: set by the endpoint; caller values are overridden.
*/
submitted_at?: string | null;
/**
* Submitted By
* @description Server-managed: set by the endpoint; caller values are overridden.
*/
submitted_by?: string | null;
/** Token Url */
token_url?: string | null;
/** Tool Name To Description */
tool_name_to_description?: {
[key: string]: string;
} | null;
/** Tool Name To Display Name */
tool_name_to_display_name?: {
[key: string]: string;
} | null;
/**
* Transport
* @default sse
* @enum {string}
*/
transport: "sse" | "http" | "stdio";
/** Url */
url?: string | null;
};
/** NewMCPToolsetRequest */
NewMCPToolsetRequest: {
/** Description */
description?: string | null;
/**
* Tools
* @default []
*/
tools: components["schemas"]["MCPToolsetTool"][];
/** Toolset Name */
toolset_name: string;
};
/** NewModelGroupRequest */
NewModelGroupRequest: {
/** Access Group */
access_group: string;
/** Model Ids */
model_ids?: string[] | null;
/** Model Names */
model_names?: string[] | null;
};
/** NewModelGroupResponse */
NewModelGroupResponse: {
/** Access Group */
access_group: string;
/** Model Ids */
model_ids?: string[] | null;
/** Model Names */
model_names?: string[] | null;
/** Models Updated */
models_updated: number;
};
/** NewOrganizationRequest */
NewOrganizationRequest: {
/** Allowed Models */
allowed_models?: string[] | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: number;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: number;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Alias */
organization_alias: string;
/** Organization Id */
organization_id?: string | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/** NewOrganizationResponse */
NewOrganizationResponse: {
/** Budget Id */
budget_id: string;
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Created By */
created_by: string;
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTable"] | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: string[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Alias */
organization_alias?: string | null;
/** Organization Id */
organization_id: string;
/**
* Spend
* @default 0
*/
spend: number;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated By */
updated_by: string;
/** Users */
users?: components["schemas"]["LiteLLM_UserTable"][] | null;
};
/**
* NewProjectRequest
* @description Request model for POST /project/new
*/
NewProjectRequest: {
/** Allowed Models */
allowed_models?: string[] | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Description */
description?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: string[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Policies */
policies?: string[] | null;
/** Project Alias */
project_alias?: string | null;
/** Project Id */
project_id?: string | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id: string;
/** Tpm Limit */
tpm_limit?: number | null;
};
/**
* NewProjectResponse
* @description Response model for POST /project/new
*/
NewProjectResponse: {
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Id */
budget_id?: string | null;
/**
* Created At
* Format: date-time
*/
created_at: string;
/** Created By */
created_by?: string | null;
/** Description */
description?: string | null;
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTable"] | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Spend */
model_spend?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: string[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Project Alias */
project_alias?: string | null;
/** Project Id */
project_id: string;
/**
* Spend
* @default 0
*/
spend: number;
/** Team Id */
team_id?: string | null;
/**
* Updated At
* Format: date-time
*/
updated_at: string;
/** Updated By */
updated_by?: string | null;
};
/** NewTeamRequest */
NewTeamRequest: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/**
* Admins
* @default []
*/
admins: unknown[];
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/** Default Team Member Models */
default_team_member_models?: string[] | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Enforced Batch Output Expires After */
enforced_batch_output_expires_after?: {
[key: string]: unknown;
} | null;
/** Enforced File Expires After */
enforced_file_expires_after?: {
[key: string]: unknown;
} | null;
/** Guardrails */
guardrails?: string[] | null;
/** Max Budget */
max_budget?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/**
* Members
* @default []
*/
members: unknown[];
/**
* Members With Roles
* @default []
*/
members_with_roles: components["schemas"]["Member"][];
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Aliases */
model_aliases?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: number;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: number;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/** Policies */
policies?: string[] | null;
/** Prompts */
prompts?: string[] | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput") | null;
/** Secret Manager Settings */
secret_manager_settings?: {
[key: string]: unknown;
} | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tags */
tags?: unknown[] | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id?: string | null;
/** Team Member Budget */
team_member_budget?: number | null;
/** Team Member Budget Duration */
team_member_budget_duration?: string | null;
/** Team Member Key Duration */
team_member_key_duration?: string | null;
/** Team Member Permissions */
team_member_permissions?: string[] | null;
/** Team Member Rpm Limit */
team_member_rpm_limit?: number | null;
/** Team Member Tpm Limit */
team_member_tpm_limit?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput") | null;
};
/** NewUserRequest */
NewUserRequest: {
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/**
* Auto Create Key
* @default true
*/
auto_create_key: boolean;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Duration */
duration?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key Alias */
key_alias?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organizations */
organizations?: string[] | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Prompts */
prompts?: string[] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Send Invite Email */
send_invite_email?: boolean | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Sso User Id */
sso_user_id?: string | null;
/** Team Id */
team_id?: string | null;
/** Teams */
teams?: string[] | components["schemas"]["NewUserRequestTeam"][] | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** User Alias */
user_alias?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
/** User Role */
user_role?: ("proxy_admin" | "proxy_admin_viewer" | "internal_user" | "internal_user_viewer") | null;
};
/** NewUserRequestTeam */
NewUserRequestTeam: {
/** Max Budget In Team */
max_budget_in_team?: number | null;
/** Team Id */
team_id: string;
/**
* User Role
* @default user
* @enum {string}
*/
user_role: "user" | "admin";
};
/** NewUserResponse */
NewUserResponse: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Duration */
duration?: string | null;
/** Enforced Params */
enforced_params?: string[] | null;
/** Expires */
expires?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key */
key: string;
/** Key Alias */
key_alias?: string | null;
/** Key Name */
key_name?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: unknown | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Project Id */
project_id?: string | null;
/** Prompts */
prompts?: string[] | null;
router_settings?: components["schemas"]["UpdateRouterConfig"] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
/** Teams */
teams?: unknown[] | null;
/** Token */
token?: string | null;
/** Token Id */
token_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User Alias */
user_alias?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
/** User Role */
user_role?: ("proxy_admin" | "proxy_admin_viewer" | "internal_user" | "internal_user_viewer") | null;
};
/**
* OAuth2SecurityScheme
* @description Defines a security scheme using OAuth 2.0.
*/
OAuth2SecurityScheme: {
/** Description */
description?: string | null;
flows: components["schemas"]["OAuthFlows"];
/** Oauth2Metadataurl */
oauth2MetadataUrl: string | null;
/**
* Type
* @constant
*/
type: "oauth2";
};
/**
* OAuthFlows
* @description Defines the configuration for the supported OAuth 2.0 flows.
*/
OAuthFlows: {
/** Authorizationcode */
authorizationCode?: {
[key: string]: unknown;
} | null;
/** Clientcredentials */
clientCredentials?: {
[key: string]: unknown;
} | null;
/** Implicit */
implicit?: {
[key: string]: unknown;
} | null;
/** Password */
password?: {
[key: string]: unknown;
} | null;
};
/**
* OpenIdConnectSecurityScheme
* @description Defines a security scheme using OpenID Connect.
*/
OpenIdConnectSecurityScheme: {
/** Description */
description?: string | null;
/** Openidconnecturl */
openIdConnectUrl: string;
/**
* Type
* @constant
*/
type: "openIdConnect";
};
/** OrgMember */
OrgMember: {
/**
* Role
* @enum {string}
*/
role: "org_admin" | "internal_user" | "internal_user_viewer";
/**
* User Email
* @description The email address of the user to add. Either user_id or user_email must be provided
*/
user_email?: string | null;
/**
* User Id
* @description The unique ID of the user to add. Either user_id or user_email must be provided
*/
user_id?: string | null;
};
/** OrganizationAddMemberResponse */
OrganizationAddMemberResponse: {
/** Organization Id */
organization_id: string;
/** Updated Organization Memberships */
updated_organization_memberships: components["schemas"]["LiteLLM_OrganizationMembershipTable"][];
/** Updated Users */
updated_users: components["schemas"]["LiteLLM_UserTable"][];
};
/** OrganizationMemberAddRequest */
OrganizationMemberAddRequest: {
/** Max Budget In Organization */
max_budget_in_organization?: number | null;
/** Member */
member: components["schemas"]["OrgMember"][] | components["schemas"]["OrgMember"];
/** Organization Id */
organization_id: string;
};
/** OrganizationMemberDeleteRequest */
OrganizationMemberDeleteRequest: {
/** Organization Id */
organization_id: string;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
};
/** OrganizationMemberUpdateRequest */
OrganizationMemberUpdateRequest: {
/** Max Budget In Organization */
max_budget_in_organization?: number | null;
/** Organization Id */
organization_id: string;
role?: components["schemas"]["LitellmUserRoles"] | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
};
/** OrganizationRequest */
OrganizationRequest: {
/** Organizations */
organizations: string[];
};
/**
* PaginatedAuditLogResponse
* @description Response model for paginated audit logs
*/
PaginatedAuditLogResponse: {
/** Audit Logs */
audit_logs: components["schemas"]["AuditLogResponse"][];
/**
* Page
* @description Current page number
*/
page: number;
/**
* Page Size
* @description Number of items per page
*/
page_size: number;
/**
* Total
* @description Total number of audit logs matching the filters
*/
total: number;
/**
* Total Pages
* @description Total number of pages
*/
total_pages: number;
};
/** PassThroughEndpointResponse */
PassThroughEndpointResponse: {
/** Endpoints */
endpoints: components["schemas"]["PassThroughGenericEndpoint"][];
};
/** PassThroughGenericEndpoint */
PassThroughGenericEndpoint: {
/**
* Auth
* @description Whether authentication is required for the pass-through endpoint. Defaults to True so a pass-through silently created without an explicit value still requires a valid LiteLLM API key — set to False only if the endpoint is meant to be a public forwarder (e.g. an unauthenticated webhook target).
* @default true
*/
auth: boolean;
/**
* Cost Per Request
* @description The USD cost per request to the target endpoint. This is used to calculate the cost of the request to the target endpoint.
* @default 0
*/
cost_per_request: number;
/**
* Default Query Params
* @description Key-value pairs of default query parameters to be sent with every request to this endpoint. These can be overridden by client-provided query parameters. For example: {'key': 'default_value', 'api_version': '2023-01'}
* @default {}
*/
default_query_params: {
[key: string]: unknown;
};
/**
* Guardrails
* @description Guardrails configuration for this passthrough endpoint. Dict keys are guardrail names, values are optional settings for field targeting. When set, all org/team/key level guardrails will also execute. Defaults to None (no guardrails execute).
*/
guardrails?: {
[key: string]: components["schemas"]["PassThroughGuardrailSettings"] | null;
} | null;
/**
* Headers
* @description Key-value pairs of headers to be forwarded with the request. You can set any key value pair here and it will be forwarded to your target endpoint
* @default {}
*/
headers: {
[key: string]: unknown;
};
/**
* Id
* @description Optional unique identifier for the pass-through endpoint. If not provided, endpoints will be identified by path for backwards compatibility.
*/
id?: string | null;
/**
* Include Subpath
* @description If True, requests to subpaths of the path will be forwarded to the target endpoint. For example, if the path is /bria and include_subpath is True, requests to /bria/v1/text-to-image/base/2.3 will be forwarded to the target endpoint.
* @default false
*/
include_subpath: boolean;
/**
* Is From Config
* @description True if this endpoint is defined in the config file, False if from DB. Config-defined endpoints cannot be edited via the UI.
* @default false
*/
is_from_config: boolean;
/**
* Methods
* @description List of HTTP methods this endpoint handles (e.g., ['GET', 'POST']). If None or empty, all methods (GET, POST, PUT, DELETE, PATCH) are supported for backward compatibility. This allows the same path to have different targets for different HTTP methods.
*/
methods?: string[] | null;
/**
* Path
* @description The route to be added to the LiteLLM Proxy Server.
*/
path: string;
/**
* Target
* @description The URL to which requests for this path should be forwarded.
*/
target: string;
};
/**
* PassThroughGuardrailSettings
* @description Settings for a specific guardrail on a passthrough endpoint.
*
* Allows field-level targeting for guardrail execution.
*/
PassThroughGuardrailSettings: {
/**
* Request Fields
* @description JSONPath expressions for input field targeting (pre_call). Examples: 'query', 'documents[*].text', 'messages[*].content'. If not specified, guardrail runs on entire request payload.
*/
request_fields?: string[] | null;
/**
* Response Fields
* @description JSONPath expressions for output field targeting (post_call). Examples: 'results[*].text', 'output'. If not specified, guardrail runs on entire response payload.
*/
response_fields?: string[] | null;
};
/** PatchAgentRequest */
PatchAgentRequest: {
agent_card_params?: components["schemas"]["AgentCard"];
/** Agent Name */
agent_name?: string;
/** Extra Headers */
extra_headers?: string[] | null;
/** Litellm Params */
litellm_params?: {
[key: string]: unknown;
};
object_permission?: components["schemas"]["AgentObjectPermission"];
/** Rpm Limit */
rpm_limit?: number | null;
/** Session Rpm Limit */
session_rpm_limit?: number | null;
/** Session Tpm Limit */
session_tpm_limit?: number | null;
/** Static Headers */
static_headers?: {
[key: string]: string;
} | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/** PatchGuardrailRequest */
PatchGuardrailRequest: {
/** Guardrail Info */
guardrail_info?: {
[key: string]: unknown;
} | null;
/** Guardrail Name */
guardrail_name?: string | null;
litellm_params?: components["schemas"]["BaseLitellmParams-Input"] | null;
};
/** PatchPromptRequest */
PatchPromptRequest: {
litellm_params?: components["schemas"]["PromptLiteLLMParams"] | null;
prompt_info?: components["schemas"]["PromptInfo"] | null;
};
/**
* PerTestingCriteriaResult
* @description Results for a specific testing criteria
*/
PerTestingCriteriaResult: {
/** Average Score */
average_score?: number | null;
result_counts: components["schemas"]["ResultCounts"];
/** Testing Criteria Index */
testing_criteria_index: number;
};
/**
* PerUserAnalyticsResponse
* @description Response for per-user analytics
*/
PerUserAnalyticsResponse: {
/** Page */
page: number;
/** Page Size */
page_size: number;
/** Results */
results: components["schemas"]["PerUserMetrics"][];
/** Total Count */
total_count: number;
/** Total Pages */
total_pages: number;
};
/**
* PerUserMetrics
* @description Metrics for individual user
*/
PerUserMetrics: {
/**
* Failed Requests
* @default 0
*/
failed_requests: number;
/**
* Spend
* @default 0
*/
spend: number;
/**
* Successful Requests
* @default 0
*/
successful_requests: number;
/**
* Total Requests
* @default 0
*/
total_requests: number;
/**
* Total Tokens
* @default 0
*/
total_tokens: number;
/** User Agent */
user_agent?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
};
/**
* PiiAction
* @enum {string}
*/
PiiAction: "BLOCK" | "MASK";
/**
* 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";
/**
* PipelineTestRequest
* @description Request body for testing a guardrail pipeline with sample messages.
*/
PipelineTestRequest: {
/**
* Pipeline
* @description Pipeline definition with 'mode' and 'steps'.
*/
pipeline: {
[key: string]: unknown;
};
/**
* Test Messages
* @description Test messages to run through the pipeline, e.g. [{'role': 'user', 'content': '...'}].
*/
test_messages: {
[key: string]: string;
}[];
};
/**
* PluginAuthor
* @description Plugin author information.
*/
PluginAuthor: {
/**
* Email
* @description Author email
*/
email?: string | null;
/**
* Name
* @description Author name
*/
name: string;
};
/**
* PluginListItem
* @description Plugin item in list responses.
*/
PluginListItem: {
author?: components["schemas"]["PluginAuthor"] | null;
/** Category */
category?: string | null;
/** Created At */
created_at: string | null;
/** Description */
description: string | null;
/** Domain */
domain?: string | null;
/** Enabled */
enabled: boolean;
/** Homepage */
homepage?: string | null;
/** Id */
id: string;
/** Keywords */
keywords?: string[] | null;
/** Name */
name: string;
/** Namespace */
namespace?: string | null;
/** Source */
source: {
[key: string]: string;
};
/** Updated At */
updated_at: string | null;
/** Version */
version: string | null;
};
/**
* PolicyAttachmentCreateRequest
* @description Request body for creating a policy attachment.
*/
PolicyAttachmentCreateRequest: {
/**
* Keys
* @description Key aliases or patterns this attachment applies to.
*/
keys?: string[] | null;
/**
* Models
* @description Model names or patterns this attachment applies to.
*/
models?: string[] | null;
/**
* Policy Name
* @description Name of the policy to attach.
*/
policy_name: string;
/**
* Scope
* @description Use '*' for global scope (applies to all requests).
*/
scope?: string | null;
/**
* Tags
* @description Tag patterns this attachment applies to. Supports wildcards (e.g., health-*).
*/
tags?: string[] | null;
/**
* Teams
* @description Team aliases or patterns this attachment applies to.
*/
teams?: string[] | null;
};
/**
* PolicyAttachmentDBResponse
* @description Response for a policy attachment from the database.
*/
PolicyAttachmentDBResponse: {
/**
* Attachment Id
* @description Unique ID of the attachment.
*/
attachment_id: string;
/**
* Created At
* @description When the attachment was created.
*/
created_at?: string | null;
/**
* Created By
* @description Who created the attachment.
*/
created_by?: string | null;
/**
* Keys
* @description Key patterns.
*/
keys?: string[];
/**
* Models
* @description Model patterns.
*/
models?: string[];
/**
* Policy Name
* @description Name of the attached policy.
*/
policy_name: string;
/**
* Scope
* @description Scope of the attachment.
*/
scope?: string | null;
/**
* Tags
* @description Tag patterns.
*/
tags?: string[];
/**
* Teams
* @description Team patterns.
*/
teams?: string[];
/**
* Updated At
* @description When the attachment was last updated.
*/
updated_at?: string | null;
/**
* Updated By
* @description Who last updated the attachment.
*/
updated_by?: string | null;
};
/**
* PolicyAttachmentListResponse
* @description Response for listing policy attachments.
*/
PolicyAttachmentListResponse: {
/**
* Attachments
* @description List of policy attachments.
*/
attachments?: components["schemas"]["PolicyAttachmentDBResponse"][];
/**
* Total Count
* @description Total number of attachments.
* @default 0
*/
total_count: number;
};
/**
* PolicyConditionRequest
* @description Condition for when a policy applies.
*/
PolicyConditionRequest: {
/**
* Model
* @description Model name pattern (exact match or regex) for when policy applies.
*/
model?: string | null;
};
/**
* PolicyCreateRequest
* @description Request body for creating a new policy.
*/
PolicyCreateRequest: {
/** @description Condition for when this policy applies. */
condition?: components["schemas"]["PolicyConditionRequest"] | null;
/**
* Description
* @description Human-readable description of the policy.
*/
description?: string | null;
/**
* Guardrails Add
* @description List of guardrail names to add.
*/
guardrails_add?: string[] | null;
/**
* Guardrails Remove
* @description List of guardrail names to remove (from inherited).
*/
guardrails_remove?: string[] | null;
/**
* Inherit
* @description Name of parent policy to inherit from.
*/
inherit?: string | null;
/**
* Pipeline
* @description Optional guardrail pipeline for ordered execution. Contains 'mode' and 'steps'.
*/
pipeline?: {
[key: string]: unknown;
} | null;
/**
* Policy Name
* @description Unique name for the policy.
*/
policy_name: string;
};
/**
* PolicyDBResponse
* @description Response for a policy from the database.
*/
PolicyDBResponse: {
/**
* Condition
* @description Policy condition.
*/
condition?: {
[key: string]: unknown;
} | null;
/**
* Created At
* @description When the policy was created.
*/
created_at?: string | null;
/**
* Created By
* @description Who created the policy.
*/
created_by?: string | null;
/**
* Description
* @description Policy description.
*/
description?: string | null;
/**
* Guardrails Add
* @description Guardrails to add.
*/
guardrails_add?: string[];
/**
* Guardrails Remove
* @description Guardrails to remove.
*/
guardrails_remove?: string[];
/**
* Inherit
* @description Parent policy name.
*/
inherit?: string | null;
/**
* Is Latest
* @description True if this is the latest version by version_number.
* @default true
*/
is_latest: boolean;
/**
* Parent Version Id
* @description Policy ID this version was cloned from.
*/
parent_version_id?: string | null;
/**
* Pipeline
* @description Optional guardrail pipeline.
*/
pipeline?: {
[key: string]: unknown;
} | null;
/**
* Policy Id
* @description Unique ID of the policy.
*/
policy_id: string;
/**
* Policy Name
* @description Name of the policy.
*/
policy_name: string;
/**
* Production At
* @description When this version was promoted to production.
*/
production_at?: string | null;
/**
* Published At
* @description When this version was published.
*/
published_at?: string | null;
/**
* Updated At
* @description When the policy was last updated.
*/
updated_at?: string | null;
/**
* Updated By
* @description Who last updated the policy.
*/
updated_by?: string | null;
/**
* Version Number
* @description Version number of this policy.
* @default 1
*/
version_number: number;
/**
* Version Status
* @description One of: draft, published, production.
* @default production
*/
version_status: string;
};
/**
* PolicyGuardrailsResponse
* @description Guardrails configuration for a policy.
*/
PolicyGuardrailsResponse: {
/** Add */
add?: string[];
/** Remove */
remove?: string[];
};
/**
* PolicyInfoResponse
* @description Response for /policy/info/{policy_name} endpoint.
*/
PolicyInfoResponse: {
guardrails: components["schemas"]["PolicyGuardrailsResponse"];
/** Inherit */
inherit?: string | null;
/** Inheritance Chain */
inheritance_chain: string[];
/** Policy Name */
policy_name: string;
/** Resolved Guardrails */
resolved_guardrails: string[];
scope: components["schemas"]["PolicyScopeResponse"];
};
/**
* PolicyListDBResponse
* @description Response for listing policies from the database.
*/
PolicyListDBResponse: {
/**
* Policies
* @description List of policies.
*/
policies?: components["schemas"]["PolicyDBResponse"][];
/**
* Total Count
* @description Total number of policies.
* @default 0
*/
total_count: number;
};
/**
* PolicyListResponse
* @description Response for /policy/list endpoint.
*/
PolicyListResponse: {
/** Policies */
policies: {
[key: string]: components["schemas"]["PolicySummaryItem"];
};
/** Total Count */
total_count: number;
};
/**
* PolicyMatchContext
* @description Context used to match a request against policies.
*
* Contains the team alias, key alias, and model from the incoming request.
*/
PolicyMatchContext: {
/**
* Key Alias
* @description API key alias from the request.
*/
key_alias?: string | null;
/**
* Model
* @description Model name from the request.
*/
model?: string | null;
/**
* Tags
* @description Tags from key/team metadata.
*/
tags?: string[] | null;
/**
* Team Alias
* @description Team alias from the request.
*/
team_alias?: string | null;
};
/**
* PolicyMatchDetail
* @description Details about why a specific policy matched.
*/
PolicyMatchDetail: {
/**
* Guardrails Added
* @description Guardrails this policy contributes.
*/
guardrails_added?: string[];
/**
* Matched Via
* @description How the policy was matched (e.g., 'tag:healthcare', 'team:health-team', 'scope:*').
*/
matched_via: string;
/**
* Policy Name
* @description Name of the matched policy.
*/
policy_name: string;
};
/**
* PolicyResolveRequest
* @description Request body for resolving effective policies/guardrails for a context.
*/
PolicyResolveRequest: {
/**
* Key Alias
* @description Key alias to resolve for.
*/
key_alias?: string | null;
/**
* Model
* @description Model name to resolve for.
*/
model?: string | null;
/**
* Tags
* @description Tags to resolve for.
*/
tags?: string[] | null;
/**
* Team Alias
* @description Team alias to resolve for.
*/
team_alias?: string | null;
};
/**
* PolicyResolveResponse
* @description Response for resolving effective policies/guardrails for a context.
*/
PolicyResolveResponse: {
/**
* Effective Guardrails
* @description Final list of guardrails that would be applied.
*/
effective_guardrails?: string[];
/**
* Matched Policies
* @description Details about each matched policy and why it matched.
*/
matched_policies?: components["schemas"]["PolicyMatchDetail"][];
};
/**
* PolicyScopeResponse
* @description Scope configuration for a policy.
*/
PolicyScopeResponse: {
/** Keys */
keys?: string[];
/** Models */
models?: string[];
/** Tags */
tags?: string[];
/** Teams */
teams?: string[];
};
/**
* PolicySummaryItem
* @description Summary of a single policy for list endpoint.
*/
PolicySummaryItem: {
guardrails: components["schemas"]["PolicyGuardrailsResponse"];
/** Inherit */
inherit?: string | null;
/** Inheritance Chain */
inheritance_chain: string[];
/** Resolved Guardrails */
resolved_guardrails: string[];
scope: components["schemas"]["PolicyScopeResponse"];
};
/**
* PolicyTestResponse
* @description Response for /policy/test endpoint.
*/
PolicyTestResponse: {
context: components["schemas"]["PolicyMatchContext"];
/** Matching Policies */
matching_policies: string[];
/** Message */
message?: string | null;
/** Resolved Guardrails */
resolved_guardrails: string[];
};
/**
* PolicyUpdateRequest
* @description Request body for updating a policy.
*/
PolicyUpdateRequest: {
/** @description Condition for when this policy applies. */
condition?: components["schemas"]["PolicyConditionRequest"] | null;
/**
* Description
* @description Human-readable description of the policy.
*/
description?: string | null;
/**
* Guardrails Add
* @description List of guardrail names to add.
*/
guardrails_add?: string[] | null;
/**
* Guardrails Remove
* @description List of guardrail names to remove (from inherited).
*/
guardrails_remove?: string[] | null;
/**
* Inherit
* @description Name of parent policy to inherit from.
*/
inherit?: string | null;
/**
* Pipeline
* @description Optional guardrail pipeline for ordered execution. Contains 'mode' and 'steps'.
*/
pipeline?: {
[key: string]: unknown;
} | null;
/**
* Policy Name
* @description New name for the policy.
*/
policy_name?: string | null;
};
/**
* PolicyValidateRequest
* @description Request body for the /policy/validate endpoint.
*/
PolicyValidateRequest: {
/**
* Policies
* @description Policy configuration to validate. Map of policy names to policy definitions.
*/
policies: {
[key: string]: unknown;
};
};
/**
* PolicyValidationError
* @description Represents a validation error or warning for a policy.
*/
PolicyValidationError: {
/** @description Type of validation error. */
error_type: components["schemas"]["PolicyValidationErrorType"];
/**
* Field
* @description Specific field that caused the error (e.g., 'guardrails.add', 'scope.teams').
*/
field?: string | null;
/**
* Message
* @description Human-readable error message.
*/
message: string;
/**
* Policy Name
* @description Name of the policy with the issue.
*/
policy_name: string;
/**
* Value
* @description The invalid value that caused the error.
*/
value?: string | null;
};
/**
* PolicyValidationErrorType
* @description Types of validation errors that can occur.
* @enum {string}
*/
PolicyValidationErrorType: "invalid_guardrail" | "invalid_team" | "invalid_key" | "invalid_model" | "invalid_inheritance" | "circular_inheritance" | "invalid_scope" | "invalid_syntax";
/**
* PolicyValidationResponse
* @description Response from policy validation.
*
* - `valid`: True if no blocking errors were found
* - `errors`: List of blocking errors (prevent policy from being applied)
* - `warnings`: List of non-blocking warnings (policy can still be applied)
*/
PolicyValidationResponse: {
/**
* Errors
* @description List of blocking validation errors.
*/
errors?: components["schemas"]["PolicyValidationError"][];
/**
* Valid
* @description True if the policy configuration is valid.
*/
valid: boolean;
/**
* Warnings
* @description List of non-blocking validation warnings.
*/
warnings?: components["schemas"]["PolicyValidationError"][];
};
/**
* PolicyVersionCompareResponse
* @description Response for comparing two policy versions.
*/
PolicyVersionCompareResponse: {
/**
* Field Diffs
* @description Field name -> {version_a: val, version_b: val} for differing fields.
*/
field_diffs?: {
[key: string]: {
[key: string]: unknown;
};
};
/** @description First version. */
version_a: components["schemas"]["PolicyDBResponse"];
/** @description Second version. */
version_b: components["schemas"]["PolicyDBResponse"];
};
/**
* PolicyVersionCreateRequest
* @description Request body for creating a new policy version (draft).
*/
PolicyVersionCreateRequest: {
/**
* Source Policy Id
* @description Policy ID to clone from. If None, clone from current production version.
*/
source_policy_id?: string | null;
};
/**
* PolicyVersionListResponse
* @description Response for listing all versions of a policy.
*/
PolicyVersionListResponse: {
/**
* Policy Name
* @description Name of the policy.
*/
policy_name: string;
/**
* Total Count
* @description Total number of versions.
* @default 0
*/
total_count: number;
/**
* Versions
* @description All versions ordered by version_number desc.
*/
versions?: components["schemas"]["PolicyDBResponse"][];
};
/**
* PolicyVersionStatusUpdateRequest
* @description Request body for updating a policy version's status.
*/
PolicyVersionStatusUpdateRequest: {
/**
* Version Status
* @description New status: 'published' or 'production'.
*/
version_status: string;
};
/** Prompt */
Prompt: {
litellm_params: components["schemas"]["PromptLiteLLMParams"];
/** Prompt Id */
prompt_id: string;
prompt_info?: components["schemas"]["PromptInfo"] | null;
};
/** PromptInfo */
PromptInfo: {
/**
* Environment
* @default development
*/
environment: string | null;
/**
* Prompt Type
* @enum {string}
*/
prompt_type: "config" | "db";
} & {
[key: string]: unknown;
};
/** PromptInfoResponse */
PromptInfoResponse: {
/** Environments */
environments?: string[] | null;
prompt_spec: components["schemas"]["PromptSpec"];
raw_prompt_template?: components["schemas"]["PromptTemplateBase"] | null;
};
/** PromptLiteLLMParams */
PromptLiteLLMParams: {
/** Api Base */
api_base?: string | null;
/** Api Key */
api_key?: string | null;
/** Dotprompt Content */
dotprompt_content?: string | null;
/**
* Ignore Prompt Manager Model
* @default false
*/
ignore_prompt_manager_model: boolean | null;
/**
* Ignore Prompt Manager Optional Params
* @default false
*/
ignore_prompt_manager_optional_params: boolean | null;
/** Prompt Id */
prompt_id?: string | null;
/** Prompt Integration */
prompt_integration: string;
/** Provider Specific Query Params */
provider_specific_query_params?: {
[key: string]: unknown;
} | null;
} & {
[key: string]: unknown;
};
/** PromptSpec */
PromptSpec: {
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/**
* Environment
* @default development
*/
environment: string | null;
litellm_params: components["schemas"]["PromptLiteLLMParams"];
/** Prompt Id */
prompt_id: string;
prompt_info: components["schemas"]["PromptInfo"];
/** Updated At */
updated_at?: string | null;
/** Version */
version?: number | null;
};
/** PromptTemplateBase */
PromptTemplateBase: {
/** Content */
content: string;
/** Litellm Prompt Id */
litellm_prompt_id: string;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
};
/** PromptTokensDetails */
PromptTokensDetails: {
/**
* Modality
* @enum {string}
*/
modality: "TEXT" | "AUDIO" | "IMAGE" | "VIDEO";
/** Tokencount */
tokenCount: number;
};
/**
* ProviderBudgetResponse
* @description Complete provider budget configuration and status.
* Maps provider names to their budget configs.
*/
ProviderBudgetResponse: {
/**
* Providers
* @default {}
*/
providers: {
[key: string]: components["schemas"]["ProviderBudgetResponseObject"];
};
};
/**
* ProviderBudgetResponseObject
* @description Configuration for a single provider's budget settings
*/
ProviderBudgetResponseObject: {
/** Budget Limit */
budget_limit: number | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Time Period */
time_period: string | null;
};
/** ProviderCreateInfo */
ProviderCreateInfo: {
/** Credential Fields */
credential_fields: components["schemas"]["ProviderCredentialField"][];
/** Default Model Placeholder */
default_model_placeholder?: string | null;
/** Litellm Provider */
litellm_provider: string;
/** Provider */
provider: string;
/** Provider Display Name */
provider_display_name: string;
};
/** ProviderCredentialField */
ProviderCredentialField: {
/** Default Value */
default_value?: string | null;
/**
* Field Type
* @default text
* @enum {string}
*/
field_type: "text" | "password" | "select" | "upload" | "textarea";
/** Key */
key: string;
/** Label */
label: string;
/** Options */
options?: string[] | null;
/** Placeholder */
placeholder?: string | null;
/**
* Required
* @default false
*/
required: boolean;
/** Tooltip */
tooltip?: string | null;
};
/**
* ProxyChatCompletionRequest
* @description Pydantic model for chat completion requests that includes both OpenAI standard fields
* and LiteLLM-specific parameters. This replaces the previous TypedDict version.
*/
ProxyChatCompletionRequest: {
/**
* Caching
* @default null
*/
caching: boolean | null;
/**
* Context Window Fallback Dict
* @default null
*/
context_window_fallback_dict: {
[key: string]: string;
} | null;
/**
* Fallbacks
* @default null
*/
fallbacks: string[] | null;
/**
* Frequency Penalty
* @default null
*/
frequency_penalty: number | null;
/**
* Function Call
* @default null
*/
function_call: string | {
[key: string]: unknown;
} | null;
/**
* Functions
* @default null
*/
functions: {
[key: string]: unknown;
}[] | null;
/**
* Guardrails
* @default null
*/
guardrails: string[] | null;
/**
* Logit Bias
* @default null
*/
logit_bias: {
[key: string]: number;
} | null;
/**
* Logprobs
* @default null
*/
logprobs: boolean | null;
/**
* Max Tokens
* @default null
*/
max_tokens: number | null;
/** Messages */
messages: (components["schemas"]["ChatCompletionUserMessage"] | components["schemas"]["ChatCompletionAssistantMessage"] | components["schemas"]["ChatCompletionToolMessage"] | components["schemas"]["ChatCompletionSystemMessage"] | components["schemas"]["ChatCompletionFunctionMessage"] | components["schemas"]["ChatCompletionDeveloperMessage"])[];
/**
* Metadata
* @default null
*/
metadata: {
[key: string]: unknown;
} | null;
/** Model */
model: string;
/**
* N
* @default null
*/
n: number | null;
/**
* Num Retries
* @default null
*/
num_retries: number | null;
/**
* Parallel Tool Calls
* @default null
*/
parallel_tool_calls: boolean | null;
/**
* Presence Penalty
* @default null
*/
presence_penalty: number | null;
/**
* Response Format
* @default null
*/
response_format: {
[key: string]: unknown;
} | null;
/**
* Seed
* @default null
*/
seed: number | null;
/**
* Service Tier
* @default null
*/
service_tier: string | null;
/**
* Stop
* @default null
*/
stop: string | string[] | null;
/**
* Stream
* @default null
*/
stream: boolean | null;
/**
* Stream Options
* @default null
*/
stream_options: {
[key: string]: unknown;
} | null;
/**
* Temperature
* @default null
*/
temperature: number | null;
/**
* Tool Choice
* @default null
*/
tool_choice: string | {
[key: string]: unknown;
} | null;
/**
* Tools
* @default null
*/
tools: {
[key: string]: unknown;
}[] | null;
/**
* Top Logprobs
* @default null
*/
top_logprobs: number | null;
/**
* Top P
* @default null
*/
top_p: number | null;
/**
* User
* @default null
*/
user: string | null;
};
/** PublicModelHubInfo */
PublicModelHubInfo: {
/** Custom Docs Description */
custom_docs_description: string | null;
/** Docs Title */
docs_title: string;
/** Litellm Version */
litellm_version: string;
/** Useful Links */
useful_links: {
[key: string]: string | {
[key: string]: unknown;
};
} | null;
};
/** RawRequestTypedDict */
RawRequestTypedDict: {
/** Error */
error?: string | null;
/** Raw Request Api Base */
raw_request_api_base?: string | null;
/** Raw Request Body */
raw_request_body?: {
[key: string]: unknown;
} | null;
/** Raw Request Headers */
raw_request_headers?: {
[key: string]: unknown;
} | null;
};
/**
* RealtimeClientSecretResponse
* @description Response from POST /v1/realtime/client_secrets.
*
* Both the top-level `value` and `session.client_secret.value`
* will contain the encrypted token instead of the raw ephemeral key.
* The `session` field is kept as a raw dict so unknown fields pass through.
*/
RealtimeClientSecretResponse: {
/** Expires At */
expires_at?: number | null;
/** Session */
session?: {
[key: string]: unknown;
} | null;
/** Value */
value: string;
};
/** RegenerateKeyRequest */
RegenerateKeyRequest: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/**
* Auto Rotate
* @description Whether this key should be automatically rotated
* @default false
*/
auto_rotate: boolean | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Duration */
duration?: string | null;
/** Enforced Params */
enforced_params?: string[] | null;
/** Grace Period */
grace_period?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key */
key?: string | null;
/** Key Alias */
key_alias?: string | null;
/**
* @description Type of key that determines default allowed routes.
* @default default
*/
key_type: components["schemas"]["LiteLLMKeyType"] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
/** New Key */
new_key?: string | null;
/** New Master Key */
new_master_key?: string | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Project Id */
project_id?: string | null;
/** Prompts */
prompts?: string[] | null;
/**
* Rotation Interval
* @description How often to rotate this key (e.g., '30d', '90d'). Required if auto_rotate=True
*/
rotation_interval?: string | null;
router_settings?: components["schemas"]["UpdateRouterConfig"] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** Send Invite Email */
send_invite_email?: boolean | null;
/** Soft Budget */
soft_budget?: number | null;
/** Spend */
spend?: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** User Id */
user_id?: string | null;
};
/**
* RegisterGuardrailRequest
* @description Request body for POST /guardrails/register. Follows Generic Guardrail API config.
*/
RegisterGuardrailRequest: {
/** Guardrail Info */
guardrail_info?: {
[key: string]: unknown;
} | null;
/** Guardrail Name */
guardrail_name: string;
/** Litellm Params */
litellm_params: {
[key: string]: unknown;
};
/** Team Id */
team_id?: string | null;
};
/** RegisterGuardrailResponse */
RegisterGuardrailResponse: {
/** Guardrail Id */
guardrail_id: string;
/** Guardrail Name */
guardrail_name: string;
/** Status */
status: string;
/** Submitted At */
submitted_at?: string | null;
};
/**
* RegisterPluginRequest
* @description Request body for registering a plugin in the marketplace.
*
* LiteLLM acts as a registry/discovery layer. Plugins are hosted on
* GitHub/GitLab/Bitbucket and referenced by their git source.
*/
RegisterPluginRequest: {
/** @description Plugin author */
author?: components["schemas"]["PluginAuthor"] | null;
/**
* Category
* @description Plugin category
*/
category?: string | null;
/**
* Description
* @description Plugin description
*/
description?: string | null;
/**
* Domain
* @description Skill domain (e.g., 'Productivity')
*/
domain?: string | null;
/**
* Homepage
* @description Plugin homepage URL
*/
homepage?: string | null;
/**
* Keywords
* @description Search keywords
*/
keywords?: string[] | null;
/**
* Name
* @description Plugin name (kebab-case, e.g., 'my-plugin')
*/
name: string;
/**
* Namespace
* @description Skill namespace within domain (e.g., 'workflows')
*/
namespace?: string | null;
/**
* Source
* @description Git source reference. Supported formats:
* - GitHub: {'source': 'github', 'repo': 'org/repo'}
* - Git URL: {'source': 'url', 'url': 'https://github.com/org/repo.git'}
* - Git Subdir: {'source': 'git-subdir', 'url': 'https://github.com/org/repo.git', 'path': 'plugins/plugin-name'}
*/
source: {
[key: string]: string;
};
/**
* Version
* @description Semantic version
* @default 1.0.0
*/
version: string | null;
};
/** RejectMCPServerRequest */
RejectMCPServerRequest: {
/** Review Notes */
review_notes?: string | null;
};
/** ResetSpendRequest */
ResetSpendRequest: {
/** Reset To */
reset_to: number;
};
/** ResponseLiteLLM_ManagedVectorStore */
ResponseLiteLLM_ManagedVectorStore: {
vector_store?: components["schemas"]["LiteLLM_ManagedVectorStoresTable"];
};
/**
* ResultCounts
* @description Result counts for a run
*/
ResultCounts: {
/**
* Error
* @default 0
*/
error: number;
/**
* Failed
* @default 0
*/
failed: number;
/**
* Passed
* @default 0
*/
passed: number;
/** Total */
total: number;
};
/**
* RoleMappings
* @description Configuration for mapping SSO groups to LiteLLM roles.
*
* The system will look at the group_claim field in the SSO token to determine
* which role to assign the user based on the roles mapping.
*/
RoleMappings: {
/** @description Default role to assign if user's groups don't match any role mappings. Must be a valid LitellmUserRoles value (e.g., 'proxy_admin', 'internal_user', 'proxy_admin_viewer') */
default_role?: components["schemas"]["LitellmUserRoles"] | null;
/**
* Group Claim
* @description The field name in the SSO token that contains the groups array (e.g., 'groups', 'roles')
*/
group_claim: string;
/**
* Provider
* @description SSO Provider name (e.g., 'google', 'microsoft', 'generic')
*/
provider: string;
/**
* Roles
* @description Mapping of LiteLLM role names to arrays of SSO group names. Example: {'proxy_admin': ['group-1', 'group-2'], 'proxy_admin_viewer': ['group-3']}
*/
roles?: {
[key: string]: string[];
};
};
/** RouterFieldsResponse */
RouterFieldsResponse: {
/**
* Fields
* @description List of all configurable router settings with metadata (without field values)
*/
fields: components["schemas"]["RouterSettingsField"][];
/**
* Routing Strategy Descriptions
* @description Descriptions for each routing strategy option
*/
routing_strategy_descriptions: {
[key: string]: string;
};
};
/** RouterSettingsField */
RouterSettingsField: {
/** Field Default */
field_default?: unknown;
/** Field Description */
field_description: string;
/** Field Name */
field_name: string;
/** Field Type */
field_type: string;
/** Field Value */
field_value: unknown;
/** Link */
link?: string | null;
/** Options */
options?: string[] | null;
/** Ui Field Name */
ui_field_name: string;
};
/** RouterSettingsResponse */
RouterSettingsResponse: {
/**
* Current Values
* @description Current values of router settings
*/
current_values: {
[key: string]: unknown;
};
/**
* Fields
* @description List of all configurable router settings with metadata
*/
fields: components["schemas"]["RouterSettingsField"][];
/**
* Routing Strategy Descriptions
* @description Descriptions for each routing strategy option
*/
routing_strategy_descriptions: {
[key: string]: string;
};
};
/**
* RoutingGroup
* @description A group of models that share a routing strategy.
*/
RoutingGroup: {
/** Group Name */
group_name: string;
/** Models */
models: string[];
/** Routing Strategy */
routing_strategy: string;
/** Routing Strategy Args */
routing_strategy_args?: {
[key: string]: unknown;
} | null;
};
/**
* Run
* @description Represents a run from the OpenAI Evals API
*/
Run: {
/** Completed At */
completed_at?: number | null;
/** Created At */
created_at: number;
/** Data Source */
data_source: {
[key: string]: unknown;
};
/** Error */
error?: {
[key: string]: unknown;
} | null;
/** Eval Id */
eval_id: string;
/** Id */
id: string;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model */
model?: string | null;
/** Name */
name?: string | null;
/**
* Object
* @default eval.run
*/
object: string;
/** Per Model Usage */
per_model_usage?: unknown | null;
/** Per Testing Criteria Results */
per_testing_criteria_results?: components["schemas"]["PerTestingCriteriaResult"][] | null;
/** Report Url */
report_url?: string | null;
/** Result Counts */
result_counts?: {
[key: string]: number;
} | null;
/** Shared With Openai */
shared_with_openai?: boolean | null;
/** Started At */
started_at?: number | null;
/**
* Status
* @enum {string}
*/
status: "queued" | "running" | "completed" | "failed" | "cancelled";
};
/**
* RunDeleteResponse
* @description Response from deleting a run
*/
RunDeleteResponse: {
/**
* Deleted
* @default true
*/
deleted: boolean | null;
/**
* Object
* @default eval.run.deleted
*/
object: string | null;
/** Run Id */
run_id: string;
};
/** SCIMFeature */
SCIMFeature: {
/** Maxoperations */
maxOperations?: number | null;
/** Maxpayloadsize */
maxPayloadSize?: number | null;
/** Maxresults */
maxResults?: number | null;
/** Supported */
supported: boolean;
};
/** SCIMGroup */
SCIMGroup: {
/** Displayname */
displayName: string;
/** Externalid */
externalId?: string | null;
/** Id */
id?: string | null;
/** Members */
members?: components["schemas"]["SCIMMember"][] | null;
/** Meta */
meta?: {
[key: string]: unknown;
} | null;
/** Schemas */
schemas: string[];
};
/** SCIMListResponse */
SCIMListResponse: {
/** Resources */
Resources: components["schemas"]["SCIMUser"][] | components["schemas"]["SCIMGroup"][];
/**
* Itemsperpage
* @default 10
*/
itemsPerPage: number | null;
/**
* Schemas
* @default [
* "urn:ietf:params:scim:api:messages:2.0:ListResponse"
* ]
*/
schemas: string[];
/**
* Startindex
* @default 1
*/
startIndex: number | null;
/** Totalresults */
totalResults: number;
};
/** SCIMMember */
SCIMMember: {
/** Display */
display?: string | null;
/** Value */
value: string;
};
/** SCIMPatchOp */
SCIMPatchOp: {
/** Operations */
Operations: components["schemas"]["SCIMPatchOperation"][];
/**
* Schemas
* @default [
* "urn:ietf:params:scim:api:messages:2.0:PatchOp"
* ]
*/
schemas: string[];
};
/** SCIMPatchOperation */
SCIMPatchOperation: {
/** Op */
op: string;
/** Path */
path?: string | null;
/** Value */
value?: unknown | null;
};
/** SCIMServiceProviderConfig */
SCIMServiceProviderConfig: {
/** Authenticationschemes */
authenticationSchemes?: {
[key: string]: unknown;
}[] | null;
/**
* @default {
* "supported": false
* }
*/
bulk: components["schemas"]["SCIMFeature"];
/**
* @default {
* "supported": false
* }
*/
changePassword: components["schemas"]["SCIMFeature"];
/**
* @default {
* "supported": false
* }
*/
etag: components["schemas"]["SCIMFeature"];
/**
* @default {
* "supported": false
* }
*/
filter: components["schemas"]["SCIMFeature"];
/** Meta */
meta?: {
[key: string]: unknown;
} | null;
/**
* @default {
* "supported": true
* }
*/
patch: components["schemas"]["SCIMFeature"];
/**
* Schemas
* @default [
* "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
* ]
*/
schemas: string[];
/**
* @default {
* "supported": false
* }
*/
sort: components["schemas"]["SCIMFeature"];
};
/** SCIMUser */
SCIMUser: {
/**
* Active
* @default true
*/
active: boolean;
/** Displayname */
displayName?: string | null;
/** Emails */
emails?: components["schemas"]["SCIMUserEmail"][] | null;
/** Externalid */
externalId?: string | null;
/** Groups */
groups?: components["schemas"]["SCIMUserGroup"][] | null;
/** Id */
id?: string | null;
/** Meta */
meta?: {
[key: string]: unknown;
} | null;
name?: components["schemas"]["SCIMUserName"] | null;
/** Schemas */
schemas: string[];
/** Username */
userName?: string | null;
};
/** SCIMUserEmail */
SCIMUserEmail: {
/** Primary */
primary?: boolean | null;
/** Type */
type?: string | null;
/**
* Value
* Format: email
*/
value: string;
};
/** SCIMUserGroup */
SCIMUserGroup: {
/** Display */
display?: string | null;
/**
* Type
* @default direct
*/
type: string | null;
/** Value */
value: string;
};
/** SCIMUserName */
SCIMUserName: {
/** Familyname */
familyName?: string | null;
/** Formatted */
formatted?: string | null;
/** Givenname */
givenName?: string | null;
/** Honorificprefix */
honorificPrefix?: string | null;
/** Honorificsuffix */
honorificSuffix?: string | null;
/** Middlename */
middleName?: string | null;
};
/**
* SSOConfig
* @description Configuration for SSO environment variables and settings
*/
SSOConfig: {
/**
* Generic Authorization Endpoint
* @description Authorization endpoint URL for generic OAuth provider
*/
generic_authorization_endpoint?: string | null;
/**
* Generic Client Id
* @description Generic OAuth Client ID for SSO authentication (used for Okta and other providers)
*/
generic_client_id?: string | null;
/**
* Generic Client Secret
* @description Generic OAuth Client Secret for SSO authentication
*/
generic_client_secret?: string | null;
/**
* Generic Token Endpoint
* @description Token endpoint URL for generic OAuth provider
*/
generic_token_endpoint?: string | null;
/**
* Generic Userinfo Endpoint
* @description User info endpoint URL for generic OAuth provider
*/
generic_userinfo_endpoint?: string | null;
/**
* Google Client Id
* @description Google OAuth Client ID for SSO authentication
*/
google_client_id?: string | null;
/**
* Google Client Secret
* @description Google OAuth Client Secret for SSO authentication
*/
google_client_secret?: string | null;
/**
* Microsoft Client Id
* @description Microsoft OAuth Client ID for SSO authentication
*/
microsoft_client_id?: string | null;
/**
* Microsoft Client Secret
* @description Microsoft OAuth Client Secret for SSO authentication
*/
microsoft_client_secret?: string | null;
/**
* Microsoft Tenant
* @description Microsoft Azure Tenant ID for SSO authentication
*/
microsoft_tenant?: string | null;
/**
* Proxy Base Url
* @description Base URL of the proxy server for SSO redirects
*/
proxy_base_url?: string | null;
/** @description Configuration for mapping SSO groups to LiteLLM roles based on group claims in the SSO token */
role_mappings?: components["schemas"]["RoleMappings"] | null;
/** @description Configuration for mapping SSO JWT fields to team IDs. Takes precedence over config file settings. */
team_mappings?: components["schemas"]["TeamMappings"] | null;
/**
* Ui Access Mode
* @description Access mode for the UI
*/
ui_access_mode?: components["schemas"]["AccessControl_UI_AccessMode"] | string | null;
/**
* User Email
* @description Email of the proxy admin user
*/
user_email?: string | null;
};
/**
* SSOSettingsResponse
* @description Response model for SSO settings
*/
SSOSettingsResponse: {
/** Field Schema */
field_schema: {
[key: string]: unknown;
};
/** Values */
values: {
[key: string]: unknown;
};
};
/**
* SearchTool
* @description Search tool configuration.
*
* Example:
* {
* "search_tool_id": "123e4567-e89b-12d3-a456-426614174000",
* "search_tool_name": "litellm-search",
* "litellm_params": {
* "search_provider": "perplexity",
* "api_key": "sk-..."
* },
* "search_tool_info": {
* "description": "Perplexity search tool"
* }
* }
*/
SearchTool: {
/** Created At */
created_at?: string | null;
litellm_params: components["schemas"]["SearchToolLiteLLMParams"];
/** Search Tool Id */
search_tool_id?: string | null;
/** Search Tool Info */
search_tool_info?: {
[key: string]: unknown;
} | null;
/** Search Tool Name */
search_tool_name: string;
/** Updated At */
updated_at?: string | null;
};
/**
* SearchToolInfoResponse
* @description Response model for search tool information.
*/
SearchToolInfoResponse: {
/** Created At */
created_at?: string | null;
/** Is From Config */
is_from_config?: boolean | null;
/** Litellm Params */
litellm_params?: {
[key: string]: unknown;
};
/** Search Tool Id */
search_tool_id?: string | null;
/** Search Tool Info */
search_tool_info?: {
[key: string]: unknown;
} | null;
/** Search Tool Name */
search_tool_name?: string;
/** Updated At */
updated_at?: string | null;
};
/**
* SearchToolLiteLLMParams
* @description LiteLLM params for search tools configuration.
*/
SearchToolLiteLLMParams: {
/** Api Base */
api_base?: string | null;
/** Api Key */
api_key?: string | null;
/** Max Retries */
max_retries?: number | null;
/** Search Provider */
search_provider: string;
/** Timeout */
timeout?: number | null;
};
/**
* Skill
* @description Represents a skill from the Anthropic Skills API
*/
Skill: {
/** Created At */
created_at: string;
/** Display Title */
display_title?: string | null;
/** Id */
id: string;
/** Latest Version */
latest_version?: string | null;
/** Source */
source: string;
/**
* Type
* @default skill
*/
type: string;
/** Updated At */
updated_at: string;
};
/** SpendAnalyticsPaginatedResponse */
SpendAnalyticsPaginatedResponse: {
metadata?: components["schemas"]["DailySpendMetadata"];
/** Results */
results: components["schemas"]["DailySpendData"][];
};
/** SpendCalculateRequest */
SpendCalculateRequest: {
/** Completion Response */
completion_response?: {
[key: string]: unknown;
} | null;
/** Messages */
messages?: unknown[] | null;
/** Model */
model?: string | null;
};
/** SpendMetrics */
SpendMetrics: {
/**
* Api Requests
* @default 0
*/
api_requests: number;
/**
* Cache Creation Input Tokens
* @default 0
*/
cache_creation_input_tokens: number;
/**
* Cache Read Input Tokens
* @default 0
*/
cache_read_input_tokens: number;
/**
* Completion Tokens
* @default 0
*/
completion_tokens: number;
/**
* Failed Requests
* @default 0
*/
failed_requests: number;
/**
* Prompt Tokens
* @default 0
*/
prompt_tokens: number;
/**
* Spend
* @default 0
*/
spend: number;
/**
* Successful Requests
* @default 0
*/
successful_requests: number;
/**
* Total Tokens
* @default 0
*/
total_tokens: number;
};
/**
* SuccessfulKeyUpdate
* @description Successfully updated key with its updated information
*/
SuccessfulKeyUpdate: {
/** Key */
key: string;
/** Key Info */
key_info: {
[key: string]: unknown;
};
};
/** SuggestTemplatesRequest */
SuggestTemplatesRequest: {
/** Attack Examples */
attack_examples?: string[];
/**
* Description
* @default
*/
description: string;
/** Model */
model?: string | null;
};
/**
* SupportedDBObjectType
* @description Supported database object types for fine-grained DB storage control.
* Use in general_settings.supported_db_objects to specify which objects to load from DB.
* @enum {string}
*/
SupportedDBObjectType: "models" | "mcp" | "guardrails" | "policies" | "vector_stores" | "pass_through_endpoints" | "prompts" | "model_cost_map" | "tools" | "config_overrides";
/** SupportedEndpoint */
SupportedEndpoint: {
/** Endpoint */
endpoint: string;
/** Key */
key: string;
/** Label */
label: string;
/** Providers */
providers: components["schemas"]["EndpointProvider"][];
};
/** SupportedEndpointsResponse */
SupportedEndpointsResponse: {
/** Endpoints */
endpoints: components["schemas"]["SupportedEndpoint"][];
};
/**
* TagActiveUsersResponse
* @description Response for tag active users metrics
*/
TagActiveUsersResponse: {
/** Active Users */
active_users: number;
/** Date */
date: string;
/** Period End */
period_end?: string | null;
/** Period Start */
period_start?: string | null;
/** Tag */
tag: string;
};
/** TagDeleteRequest */
TagDeleteRequest: {
/** Name */
name: string;
};
/** TagInfoRequest */
TagInfoRequest: {
/** Names */
names: string[];
};
/** TagNewRequest */
TagNewRequest: {
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Description */
description?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Model Info */
model_info?: {
[key: string]: string;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Models */
models?: string[] | null;
/** Name */
name: string;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/**
* TagSummaryMetrics
* @description Summary metrics for a tag
*/
TagSummaryMetrics: {
/** Failed Requests */
failed_requests: number;
/** Successful Requests */
successful_requests: number;
/** Tag */
tag: string;
/** Total Requests */
total_requests: number;
/** Total Spend */
total_spend: number;
/** Total Tokens */
total_tokens: number;
/** Unique Users */
unique_users: number;
};
/**
* TagSummaryResponse
* @description Response for tag summary analytics
*/
TagSummaryResponse: {
/** Results */
results: components["schemas"]["TagSummaryMetrics"][];
};
/** TagUpdateRequest */
TagUpdateRequest: {
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Description */
description?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Model Info */
model_info?: {
[key: string]: string;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Models */
models?: string[] | null;
/** Name */
name: string;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/** TeamAddMemberResponse */
TeamAddMemberResponse: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/**
* Admins
* @default []
*/
admins: unknown[];
/**
* Allow Team Guardrail Config
* @default false
*/
allow_team_guardrail_config: boolean | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/** Default Team Member Models */
default_team_member_models?: string[] | null;
litellm_model_table?: components["schemas"]["LiteLLM_ModelTable"] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Members
* @default []
*/
members: unknown[];
/**
* Members With Roles
* @default []
*/
members_with_roles: components["schemas"]["Member"][];
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Id */
model_id?: number | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Id */
organization_id?: string | null;
/** Policies */
policies?: string[] | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Spend */
spend?: number | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id: string;
/** Team Member Permissions */
team_member_permissions?: string[] | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
/** Updated Team Memberships */
updated_team_memberships: components["schemas"]["LiteLLM_TeamMembership"][];
/** Updated Users */
updated_users: components["schemas"]["LiteLLM_UserTable"][];
};
/**
* TeamListItem
* @description A team item in the paginated list response, enriched with computed fields.
*/
TeamListItem: {
/** Access Group Agent Ids */
access_group_agent_ids?: string[] | null;
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Access Group Mcp Server Ids */
access_group_mcp_server_ids?: string[] | null;
/** Access Group Models */
access_group_models?: string[] | null;
/**
* Admins
* @default []
*/
admins: unknown[];
/**
* Allow Team Guardrail Config
* @default false
*/
allow_team_guardrail_config: boolean | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/** Default Team Member Models */
default_team_member_models?: string[] | null;
/**
* Keys Count
* @default 0
*/
keys_count: number;
litellm_model_table?: components["schemas"]["LiteLLM_ModelTable"] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Members
* @default []
*/
members: unknown[];
/**
* Members Count
* @default 0
*/
members_count: number;
/**
* Members With Roles
* @default []
*/
members_with_roles: components["schemas"]["Member"][];
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Id */
model_id?: number | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Organization Id */
organization_id?: string | null;
/** Policies */
policies?: string[] | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Spend */
spend?: number | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id: string;
/** Team Member Permissions */
team_member_permissions?: string[] | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Updated At */
updated_at?: string | null;
};
/**
* TeamListResponse
* @description Response to get the list of teams
*/
TeamListResponse: {
/** Page */
page: number;
/** Page Size */
page_size: number;
/** Teams */
teams: (components["schemas"]["TeamListItem"] | components["schemas"]["LiteLLM_TeamTable"] | components["schemas"]["LiteLLM_DeletedTeamTable"])[];
/** Total */
total: number;
/** Total Pages */
total_pages: number;
};
/**
* TeamMappings
* @description Configuration for mapping SSO JWT fields to team IDs.
*
* This allows configuring team_ids_jwt_field via the database instead of
* requiring config file changes and restarts.
*/
TeamMappings: {
/**
* Team Ids Jwt Field
* @description The field name in the SSO/JWT token that contains the team IDs array (e.g., 'groups', 'teams'). Supports dot notation for nested fields.
*/
team_ids_jwt_field?: string | null;
};
/**
* TeamMemberAddRequest
* @description Request body for adding members to a team.
*
* Example:
* ```json
* {
* "team_id": "45e3e396-ee08-4a61-a88e-16b3ce7e0849",
* "member": {
* "role": "user",
* "user_id": "user123"
* },
* "max_budget_in_team": 100.0
* }
* ```
*/
TeamMemberAddRequest: {
/**
* Allowed Models
* @description List of models this team member can access. If not set, inherits the team's default_team_member_models or all team models.
*/
allowed_models?: string[] | null;
/**
* Max Budget In Team
* @description Maximum budget allocated to this user within the team. If not set, user has unlimited budget within team limits
*/
max_budget_in_team?: number | null;
/**
* Member
* @description Member object or list of member objects to add. Each member must include either user_id or user_email, and a role
*/
member: components["schemas"]["Member"][] | components["schemas"]["Member"];
/**
* Team Id
* @description The ID of the team to add the member to
*/
team_id: string;
};
/**
* TeamMemberAddResult
* @description Result of a single team member add operation
*/
TeamMemberAddResult: {
/** Error */
error?: string | null;
/** Success */
success: boolean;
/** Updated Team Membership */
updated_team_membership?: {
[key: string]: unknown;
} | null;
/** Updated User */
updated_user?: {
[key: string]: unknown;
} | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
};
/** TeamMemberDeleteRequest */
TeamMemberDeleteRequest: {
/** Team Id */
team_id: string;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
};
/**
* TeamMemberInfoResponse
* @description Response for GET /team/{team_id}/members/me — caller's own membership row.
*/
TeamMemberInfoResponse: {
/** Budget Id */
budget_id?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: components["schemas"]["LiteLLM_BudgetTableFull"] | components["schemas"]["LiteLLM_BudgetTable"] | null;
/** Role */
role?: string | null;
/**
* Spend
* @default 0
*/
spend: number | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id: string;
/**
* Total Spend
* @default 0
*/
total_spend: number | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
};
/** TeamMemberUpdateRequest */
TeamMemberUpdateRequest: {
/**
* Allowed Models
* @description List of models this team member can access. Pass an empty list to remove per-member model restrictions.
*/
allowed_models?: string[] | null;
/**
* Budget Duration
* @description Duration after which this team member's budget resets (e.g. '1h', '24h', '7d', '30d'). If not set, the budget never resets.
*/
budget_duration?: string | null;
/** Max Budget In Team */
max_budget_in_team?: number | null;
/** Role */
role?: ("admin" | "user") | null;
/**
* Rpm Limit
* @description Requests per minute limit for this team member
*/
rpm_limit?: number | null;
/** Team Id */
team_id: string;
/**
* Tpm Limit
* @description Tokens per minute limit for this team member
*/
tpm_limit?: number | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
};
/** TeamMemberUpdateResponse */
TeamMemberUpdateResponse: {
/** Allowed Models */
allowed_models?: string[] | null;
/** Budget Duration */
budget_duration?: string | null;
/** Max Budget In Team */
max_budget_in_team?: number | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Team Id */
team_id: string;
/** Tpm Limit */
tpm_limit?: number | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
};
/**
* TeamModelAddRequest
* @description Request to add models to a team
*/
TeamModelAddRequest: {
/** Models */
models: string[];
/** Team Id */
team_id: string;
};
/**
* TeamModelDeleteRequest
* @description Request to delete models from a team
*/
TeamModelDeleteRequest: {
/** Models */
models: string[];
/** Team Id */
team_id: string;
};
/**
* TestCustomCodeGuardrailRequest
* @description Request model for testing custom code guardrails.
*/
TestCustomCodeGuardrailRequest: {
/** Custom Code */
custom_code: string;
/**
* Input Type
* @default request
*/
input_type: string;
/** Request Data */
request_data?: {
[key: string]: unknown;
} | null;
/** Test Input */
test_input: {
[key: string]: unknown;
};
};
/**
* TestCustomCodeGuardrailResponse
* @description Response model for testing custom code guardrails.
*/
TestCustomCodeGuardrailResponse: {
/** Error */
error?: string | null;
/** Error Type */
error_type?: string | null;
/** Result */
result?: {
[key: string]: unknown;
} | null;
/** Success */
success: boolean;
};
/**
* TestPoliciesAndGuardrailsRequest
* @description Request body for POST /utils/test_policies_and_guardrails.
*/
TestPoliciesAndGuardrailsRequest: {
/**
* Agent Id
* @description When set, call chat completion with this model/agent for each input and include the response in the result.
*/
agent_id?: string | null;
/**
* Guardrail Names
* @description Guardrail names to apply directly
*/
guardrail_names?: string[] | null;
/**
* Input Type
* @description Whether inputs are request or response
* @default request
* @enum {string}
*/
input_type: "request" | "response";
/**
* Inputs List
* @description List of GenericGuardrailAPIInputs; each item processed separately (for batch compliance testing).
* @default []
*/
inputs_list: components["schemas"]["GenericGuardrailAPIInputs"][];
/**
* Policy Names
* @description Policy names to resolve guardrails from
*/
policy_names?: string[] | null;
/**
* Request Data
* @description Request context (model, user_id, etc.)
*/
request_data?: {
[key: string]: unknown;
};
};
/** TestPolicyTemplateRequest */
TestPolicyTemplateRequest: {
/**
* Guardrail Definitions
* @description All guardrailDefinitions from the policy template
*/
guardrail_definitions: {
[key: string]: unknown;
}[];
/**
* Text
* @description Test input text to run guardrails against
*/
text: string;
};
/** TestPolicyTemplateResponse */
TestPolicyTemplateResponse: {
/** Overall Action */
overall_action: string;
/** Results */
results: components["schemas"]["GuardrailTestResultEntry"][];
};
/** TestPromptRequest */
TestPromptRequest: {
/** Conversation History */
conversation_history?: {
[key: string]: string;
}[] | null;
/** Dotprompt Content */
dotprompt_content: string;
/** Prompt Variables */
prompt_variables?: {
[key: string]: unknown;
} | null;
};
/** TestSearchToolConnectionRequest */
TestSearchToolConnectionRequest: {
/** Litellm Params */
litellm_params: {
[key: string]: unknown;
};
};
/**
* TokenCountDetailsResponse
* @description Response structure for token count details with modality breakdown.
*
* Example:
* {'totalTokens': 12, 'promptTokensDetails': [{'modality': 'TEXT', 'tokenCount': 12}]}
*/
TokenCountDetailsResponse: {
/** Prompttokensdetails */
promptTokensDetails: components["schemas"]["PromptTokensDetails"][];
/** Totaltokens */
totalTokens: number;
};
/** TokenCountRequest */
TokenCountRequest: {
/** Contents */
contents?: {
[key: string]: unknown;
}[] | null;
/** Messages */
messages?: {
[key: string]: unknown;
}[] | null;
/** Model */
model: string;
/** Prompt */
prompt?: string | null;
/** System */
system?: unknown | null;
/** Tools */
tools?: {
[key: string]: unknown;
}[] | null;
};
/** TokenCountResponse */
TokenCountResponse: {
/**
* Error
* @default false
*/
error: boolean;
/** Error Message */
error_message?: string | null;
/** Model Used */
model_used: string;
/** Original Response */
original_response?: {
[key: string]: unknown;
} | null;
/** Request Model */
request_model: string;
/** Status Code */
status_code?: number | null;
/** Tokenizer Type */
tokenizer_type: string;
/** Total Tokens */
total_tokens: number;
};
/** ToolDetailResponse */
ToolDetailResponse: {
/** Overrides */
overrides?: components["schemas"]["ToolPolicyOverrideRow"][];
tool: components["schemas"]["LiteLLM_ToolTableRow"];
};
/** ToolListResponse */
ToolListResponse: {
/** Tools */
tools: components["schemas"]["LiteLLM_ToolTableRow"][];
/** Total */
total: number;
};
/**
* ToolPermissionRule
* @description A rule defining permission for a specific tool or tool pattern
*/
ToolPermissionRule: {
/**
* Allowed Param Patterns
* @description Optional regex map enforcing nested parameter values using dot/[] paths
*/
allowed_param_patterns?: {
[key: string]: string;
} | null;
/**
* Decision
* @description Whether to allow or deny this tool usage
* @enum {string}
*/
decision: "allow" | "deny";
/**
* Id
* @description Unique identifier for the rule
*/
id: string;
/**
* Tool Name
* @description Regex pattern applied to the tool's function name
*/
tool_name?: string | null;
/**
* Tool Type
* @description Regex pattern applied to the tool type (e.g., function)
*/
tool_type?: string | null;
};
/** ToolPolicyOption */
ToolPolicyOption: {
/** Description */
description: string;
/** Label */
label: string;
/** Value */
value: string;
};
/** ToolPolicyOptionsResponse */
ToolPolicyOptionsResponse: {
/** Input Policies */
input_policies: components["schemas"]["ToolPolicyOption"][];
/** Output Policies */
output_policies: components["schemas"]["ToolPolicyOption"][];
};
/** ToolPolicyOverrideRow */
ToolPolicyOverrideRow: {
/** Created At */
created_at?: string | null;
/**
* Input Policy
* @default blocked
* @enum {string}
*/
input_policy: "trusted" | "untrusted" | "blocked";
/** Key Alias */
key_alias?: string | null;
/** Key Hash */
key_hash?: string | null;
/** Override Id */
override_id: string;
/** Team Id */
team_id?: string | null;
/** Tool Name */
tool_name: string;
/** Updated At */
updated_at?: string | null;
};
/** ToolPolicyUpdateRequest */
ToolPolicyUpdateRequest: {
/** Input Policy */
input_policy?: ("trusted" | "untrusted" | "blocked") | null;
/** Key Alias */
key_alias?: string | null;
/** Key Hash */
key_hash?: string | null;
/** Output Policy */
output_policy?: ("trusted" | "untrusted") | null;
/** Team Id */
team_id?: string | null;
/** Tool Name */
tool_name: string;
};
/** ToolPolicyUpdateResponse */
ToolPolicyUpdateResponse: {
/** Input Policy */
input_policy?: ("trusted" | "untrusted" | "blocked") | null;
/** Key Hash */
key_hash?: string | null;
/** Output Policy */
output_policy?: ("trusted" | "untrusted") | null;
/** Team Id */
team_id?: string | null;
/** Tool Name */
tool_name: string;
/** Updated */
updated: boolean;
};
/**
* ToolUsageLogEntry
* @description One spend log row for a tool call (for UI "recent logs" table).
*/
ToolUsageLogEntry: {
/** Id */
id: string;
/** Input Snippet */
input_snippet?: string | null;
/** Model */
model?: string | null;
/** Spend */
spend?: number | null;
/** Timestamp */
timestamp: string;
/** Total Tokens */
total_tokens?: number | null;
};
/** ToolUsageLogsResponse */
ToolUsageLogsResponse: {
/** Logs */
logs: components["schemas"]["ToolUsageLogEntry"][];
/** Page */
page: number;
/** Page Size */
page_size: number;
/** Total */
total: number;
};
/** TopLogprob */
TopLogprob: {
/** Bytes */
bytes?: number[] | null;
/** Logprob */
logprob: number;
/** Token */
token: string;
} & {
[key: string]: unknown;
};
/** TransformRequestBody */
TransformRequestBody: {
call_type: components["schemas"]["CallTypes"];
/** Request Body */
request_body: {
[key: string]: unknown;
};
};
/**
* UISettingsResponse
* @description Response model for UI settings
*/
UISettingsResponse: {
/** Field Schema */
field_schema: {
[key: string]: unknown;
};
/** Values */
values: {
[key: string]: unknown;
};
};
/**
* UIThemeConfig
* @description Configuration for UI theme customization
*/
UIThemeConfig: {
/**
* Favicon Url
* @description URL to custom favicon image. Must be an HTTP/HTTPS URL to a .ico, .png, or .svg file
*/
favicon_url?: string | null;
/**
* Logo Url
* @description URL or path to custom logo image. Can be a local file path or HTTP/HTTPS URL
*/
logo_url?: string | null;
};
/**
* UIThemeSettingsResponse
* @description Response model for UI theme settings
*/
UIThemeSettingsResponse: {
/** Field Schema */
field_schema: {
[key: string]: unknown;
};
/** Values */
values: {
[key: string]: unknown;
};
};
/** UiDiscoveryEndpoints */
UiDiscoveryEndpoints: {
/** Admin Ui Disabled */
admin_ui_disabled: boolean;
/** Auto Redirect To Sso */
auto_redirect_to_sso: boolean;
/**
* Is Control Plane
* @default false
*/
is_control_plane: boolean;
/** Proxy Base Url */
proxy_base_url: string | null;
/** Server Root Path */
server_root_path: string;
/** Sso Configured */
sso_configured: boolean;
/**
* Workers
* @default []
*/
workers: components["schemas"]["WorkerRegistryEntry"][];
};
/**
* UpdateCustomerRequest
* @description Update a Customer, use this to update customer budgets etc
*/
UpdateCustomerRequest: {
/** Alias */
alias?: string | null;
/** Allowed Model Region */
allowed_model_region?: ("eu" | "us") | null;
/**
* Blocked
* @default false
*/
blocked: boolean;
/** Budget Id */
budget_id?: string | null;
/** Default Model */
default_model?: string | null;
/** Max Budget */
max_budget?: number | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** User Id */
user_id: string;
};
/** UpdateGuardrailRequest */
UpdateGuardrailRequest: {
guardrail: components["schemas"]["Guardrail"];
};
/** UpdateJWTKeyMappingRequest */
UpdateJWTKeyMappingRequest: {
/** Description */
description?: string | null;
/** Id */
id: string;
/** Is Active */
is_active?: boolean | null;
/** Key */
key?: string | null;
};
/** UpdateKeyRequest */
UpdateKeyRequest: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/** Auto Rotate */
auto_rotate?: boolean | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Duration */
duration?: string | null;
/** Enforced Params */
enforced_params?: string[] | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key */
key: string;
/** Key Alias */
key_alias?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Prompts */
prompts?: string[] | null;
/** Rotation Interval */
rotation_interval?: string | null;
router_settings?: components["schemas"]["UpdateRouterConfig"] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Type */
rpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** Spend */
spend?: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
/** Temp Budget Expiry */
temp_budget_expiry?: string | null;
/** Temp Budget Increase */
temp_budget_increase?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Type */
tpm_limit_type?: ("guaranteed_throughput" | "best_effort_throughput" | "dynamic") | null;
/** User Id */
user_id?: string | null;
};
/** UpdateMCPServerRequest */
UpdateMCPServerRequest: {
/** Alias */
alias?: string | null;
/**
* Allow All Keys
* @default false
*/
allow_all_keys: boolean;
/** Allowed Tools */
allowed_tools?: string[] | null;
/** Args */
args?: string[];
/** Auth Type */
auth_type?: ("none" | "api_key" | "bearer_token" | "basic" | "authorization" | "oauth2" | "aws_sigv4" | "token") | null;
/** Authorization Url */
authorization_url?: string | null;
/**
* Available On Public Internet
* @default true
*/
available_on_public_internet: boolean;
/** Byok Api Key Help Url */
byok_api_key_help_url?: string | null;
/** Byok Description */
byok_description?: string[];
/** Command */
command?: string | null;
credentials?: components["schemas"]["MCPCredentials"] | null;
/** Description */
description?: string | null;
/** Env */
env?: {
[key: string]: string;
};
/** Extra Headers */
extra_headers?: string[] | null;
/** Instructions */
instructions?: string | null;
/**
* Is Byok
* @default false
*/
is_byok: boolean;
/** Mcp Access Groups */
mcp_access_groups?: string[];
/** Mcp Info */
mcp_info?: {
[key: string]: unknown;
} | null;
/** Registration Url */
registration_url?: string | null;
/** Server Id */
server_id: string;
/** Server Name */
server_name?: string | null;
/** Source Url */
source_url?: string | null;
/** Spec Path */
spec_path?: string | null;
/** Static Headers */
static_headers?: {
[key: string]: string;
} | null;
/** Token Url */
token_url?: string | null;
/** Tool Name To Description */
tool_name_to_description?: {
[key: string]: string;
} | null;
/** Tool Name To Display Name */
tool_name_to_display_name?: {
[key: string]: string;
} | null;
/**
* Transport
* @default sse
* @enum {string}
*/
transport: "sse" | "http" | "stdio";
/** Url */
url?: string | null;
};
/** UpdateMCPToolsetRequest */
UpdateMCPToolsetRequest: {
/** Description */
description?: string | null;
/** Tools */
tools?: components["schemas"]["MCPToolsetTool"][] | null;
/** Toolset Id */
toolset_id: string;
/** Toolset Name */
toolset_name?: string | null;
};
/** UpdateModelGroupRequest */
UpdateModelGroupRequest: {
/** Model Ids */
model_ids?: string[] | null;
/** Model Names */
model_names?: string[] | null;
};
/**
* UpdateProjectRequest
* @description Request model for POST /project/update
*/
UpdateProjectRequest: {
/** Allowed Models */
allowed_models?: string[] | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Description */
description?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Max Budget */
model_max_budget?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/** Models */
models?: string[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Policies */
policies?: string[] | null;
/** Project Alias */
project_alias?: string | null;
/** Project Id */
project_id: string;
/** Rpm Limit */
rpm_limit?: number | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tags */
tags?: string[] | null;
/** Team Id */
team_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/**
* UpdatePublicModelGroupsRequest
* @description Request model for updating public model groups
*/
UpdatePublicModelGroupsRequest: {
/**
* Model Groups
* @description List of model group names to make public
*/
model_groups: string[];
};
/**
* UpdateRouterConfig
* @description Set of params that you can modify via `router.update_settings()`.
*/
UpdateRouterConfig: {
/** Allowed Fails */
allowed_fails?: number | null;
/** Context Window Fallbacks */
context_window_fallbacks?: {
[key: string]: unknown;
}[] | null;
/** Cooldown Time */
cooldown_time?: number | null;
/** Fallbacks */
fallbacks?: {
[key: string]: unknown;
}[] | null;
/** Max Retries */
max_retries?: number | null;
/** Model Group Affinity Config */
model_group_affinity_config?: {
[key: string]: string[];
} | null;
/**
* Model Group Alias
* @default {}
*/
model_group_alias: {
[key: string]: string | {
[key: string]: unknown;
};
} | null;
/** Model Group Retry Policy */
model_group_retry_policy?: {
[key: string]: unknown;
} | null;
/** Num Retries */
num_retries?: number | null;
/** Retry After */
retry_after?: number | null;
/** Routing Groups */
routing_groups?: components["schemas"]["RoutingGroup"][] | null;
/** Routing Strategy */
routing_strategy?: string | null;
/** Routing Strategy Args */
routing_strategy_args?: {
[key: string]: unknown;
} | null;
/** Timeout */
timeout?: number | null;
};
/** UpdateSearchToolRequest */
UpdateSearchToolRequest: {
search_tool: components["schemas"]["SearchTool"];
};
/**
* UpdateTeamMemberPermissionsRequest
* @description Request to update the team member permissions for a team
*/
UpdateTeamMemberPermissionsRequest: {
/** Team Id */
team_id: string;
/** Team Member Permissions */
team_member_permissions: string[];
};
/**
* UpdateTeamRequest
* @description UpdateTeamRequest, used by /team/update when you need to update a team
*
* team_id: str
* team_alias: Optional[str] = None
* organization_id: Optional[str] = None
* metadata: Optional[dict] = None
* tpm_limit: Optional[int] = None
* rpm_limit: Optional[int] = None
* max_budget: Optional[float] = None
* models: Optional[list] = None
* blocked: Optional[bool] = None
* budget_duration: Optional[str] = None
* guardrails: Optional[List[str]] = None
* policies: Optional[List[str]] = None
*/
UpdateTeamRequest: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Allowed Passthrough Routes */
allowed_passthrough_routes?: unknown[] | null;
/** Allowed Vector Store Indexes */
allowed_vector_store_indexes?: components["schemas"]["AllowedVectorStoreIndexItem"][] | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/** Default Team Member Models */
default_team_member_models?: string[] | null;
/** Disable Global Guardrails */
disable_global_guardrails?: boolean | null;
/** Enforced Batch Output Expires After */
enforced_batch_output_expires_after?: {
[key: string]: unknown;
} | null;
/** Enforced File Expires After */
enforced_file_expires_after?: {
[key: string]: unknown;
} | null;
/** Guardrails */
guardrails?: string[] | null;
/** Max Budget */
max_budget?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Model Aliases */
model_aliases?: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: number;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: number;
} | null;
/** Models */
models?: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Organization Id */
organization_id?: string | null;
/** Policies */
policies?: string[] | null;
/** Prompts */
prompts?: string[] | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Secret Manager Settings */
secret_manager_settings?: {
[key: string]: unknown;
} | null;
/** Soft Budget */
soft_budget?: number | null;
/** Tags */
tags?: unknown[] | null;
/** Team Alias */
team_alias?: string | null;
/** Team Id */
team_id: string;
/** Team Member Budget */
team_member_budget?: number | null;
/** Team Member Budget Duration */
team_member_budget_duration?: string | null;
/** Team Member Key Duration */
team_member_key_duration?: string | null;
/** Team Member Rpm Limit */
team_member_rpm_limit?: number | null;
/** Team Member Tpm Limit */
team_member_tpm_limit?: number | null;
/** Tpm Limit */
tpm_limit?: number | null;
};
/** UpdateUsefulLinksRequest */
UpdateUsefulLinksRequest: {
/** Useful Links */
useful_links: {
[key: string]: string | {
[key: string]: unknown;
};
};
};
/** UpdateUserRequest */
UpdateUserRequest: {
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Duration */
duration?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key Alias */
key_alias?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Password */
password?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Prompts */
prompts?: string[] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Spend */
spend?: number | null;
/** Team Id */
team_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** User Alias */
user_alias?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
/** User Role */
user_role?: ("proxy_admin" | "proxy_admin_viewer" | "internal_user" | "internal_user_viewer") | null;
};
/** UpdateUserRequestNoUserIDorEmail */
UpdateUserRequestNoUserIDorEmail: {
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
} | null;
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Limits */
budget_limits?: components["schemas"]["BudgetLimitEntry"][] | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
} | null;
/** Duration */
duration?: string | null;
/** Guardrails */
guardrails?: string[] | null;
/** Key Alias */
key_alias?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/** Mcp Rpm Limit */
mcp_rpm_limit?: {
[key: string]: number;
} | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
} | null;
/** Model Rpm Limit */
model_rpm_limit?: {
[key: string]: unknown;
} | null;
/** Model Tpm Limit */
model_tpm_limit?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: unknown[] | null;
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionBase"] | null;
/** Password */
password?: string | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
} | null;
/** Policies */
policies?: string[] | null;
/** Prompts */
prompts?: string[] | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Spend */
spend?: number | null;
/** Team Id */
team_id?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** User Alias */
user_alias?: string | null;
/** User Id */
user_id?: string | null;
/** User Role */
user_role?: ("proxy_admin" | "proxy_admin_viewer" | "internal_user" | "internal_user_viewer") | null;
};
/** UsageAIChatRequest */
UsageAIChatRequest: {
/**
* Messages
* @description Chat messages (user/assistant history)
*/
messages: components["schemas"]["ChatMessage"][];
/**
* Model
* @description Model to use for AI chat
*/
model?: string | null;
};
/** UsageDetailResponse */
UsageDetailResponse: {
/** Avglatency */
avgLatency: number | null;
/** Avgscore */
avgScore: number | null;
/** Description */
description: string | null;
/** Failrate */
failRate: number;
/** Guardrail Id */
guardrail_id: string;
/** Guardrail Name */
guardrail_name: string;
/** Provider */
provider: string;
/** Requestsevaluated */
requestsEvaluated: number;
/** Status */
status: string;
/** Time Series */
time_series: {
[key: string]: unknown;
}[];
/** Trend */
trend: string;
/** Type */
type: string;
};
/** UsageLogEntry */
UsageLogEntry: {
/** Action */
action: string;
/** Id */
id: string;
/** Input Snippet */
input_snippet: string | null;
/** Latency Ms */
latency_ms: number | null;
/** Model */
model: string | null;
/** Output Snippet */
output_snippet: string | null;
/** Reason */
reason: string | null;
/** Score */
score: number | null;
/** Timestamp */
timestamp: string;
};
/** UsageLogsResponse */
UsageLogsResponse: {
/** Logs */
logs: components["schemas"]["UsageLogEntry"][];
/** Page */
page: number;
/** Page Size */
page_size: number;
/** Total */
total: number;
};
/** UsageOverviewResponse */
UsageOverviewResponse: {
/** Chart */
chart: {
[key: string]: unknown;
}[];
/** Passrate */
passRate: number;
/** Rows */
rows: components["schemas"]["UsageOverviewRow"][];
/** Totalblocked */
totalBlocked: number;
/** Totalrequests */
totalRequests: number;
};
/** UsageOverviewRow */
UsageOverviewRow: {
/** Avglatency */
avgLatency: number | null;
/** Avgscore */
avgScore: number | null;
/** Failrate */
failRate: number;
/** Id */
id: string;
/** Name */
name: string;
/** Provider */
provider: string;
/** Requestsevaluated */
requestsEvaluated: number;
/** Status */
status: string;
/** Trend */
trend: string;
/** Type */
type: string;
};
/**
* UserAPIKeyAuth
* @description Return the row in the db
*/
UserAPIKeyAuth: {
/** Access Group Ids */
access_group_ids?: string[] | null;
/** Agent Id */
agent_id?: string | null;
/**
* Aliases
* @default {}
*/
aliases: {
[key: string]: unknown;
};
/**
* Allowed Cache Controls
* @default []
*/
allowed_cache_controls: unknown[] | null;
/** Allowed Model Region */
allowed_model_region?: ("eu" | "us") | null;
/**
* Allowed Routes
* @default []
*/
allowed_routes: unknown[] | null;
/** Api Key */
api_key?: string | null;
/**
* Auto Rotate
* @default false
*/
auto_rotate: boolean | null;
/** Blocked */
blocked?: boolean | null;
/** Budget Duration */
budget_duration?: string | null;
/** Budget Id */
budget_id?: string | null;
/** Budget Limits */
budget_limits?: {
[key: string]: unknown;
}[] | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/**
* Config
* @default {}
*/
config: {
[key: string]: unknown;
};
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/** Created By User */
created_by_user?: unknown | null;
/** End User Id */
end_user_id?: string | null;
/** End User Max Budget */
end_user_max_budget?: number | null;
/** End User Model Max Budget */
end_user_model_max_budget?: {
[key: string]: unknown;
} | null;
end_user_object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** End User Rpm Limit */
end_user_rpm_limit?: number | null;
/** End User Tpm Limit */
end_user_tpm_limit?: number | null;
/** Expires */
expires?: string | null;
/** Jwt Claims */
jwt_claims?: {
[key: string]: unknown;
} | null;
/** Key Alias */
key_alias?: string | null;
/** Key Name */
key_name?: string | null;
/** Key Rotation At */
key_rotation_at?: string | null;
/** Last Active */
last_active?: string | null;
/** Last Refreshed At */
last_refreshed_at?: number | null;
/** Last Rotation At */
last_rotation_at?: string | null;
/** Litellm Budget Table */
litellm_budget_table?: {
[key: string]: unknown;
} | null;
/** Max Budget */
max_budget?: number | null;
/** Max Parallel Requests */
max_parallel_requests?: number | null;
/**
* Metadata
* @default {}
*/
metadata: {
[key: string]: unknown;
};
/**
* Model Max Budget
* @default {}
*/
model_max_budget: {
[key: string]: unknown;
};
/**
* Model Spend
* @default {}
*/
model_spend: {
[key: string]: unknown;
};
/**
* Models
* @default []
*/
models: unknown[];
object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Object Permission Id */
object_permission_id?: string | null;
/** Org Id */
org_id?: string | null;
/** Organization Alias */
organization_alias?: string | null;
/** Organization Max Budget */
organization_max_budget?: number | null;
/** Organization Metadata */
organization_metadata?: {
[key: string]: unknown;
} | null;
/** Organization Rpm Limit */
organization_rpm_limit?: number | null;
/** Organization Tpm Limit */
organization_tpm_limit?: number | null;
/** Parent Otel Span */
parent_otel_span?: unknown | null;
/**
* Permissions
* @default {}
*/
permissions: {
[key: string]: unknown;
};
/** Project Alias */
project_alias?: string | null;
/** Project Id */
project_id?: string | null;
/** Project Metadata */
project_metadata?: {
[key: string]: unknown;
} | null;
/** Request Route */
request_route?: string | null;
/**
* Rotation Count
* @default 0
*/
rotation_count: number | null;
/** Rotation Interval */
rotation_interval?: string | null;
/** Router Settings */
router_settings?: {
[key: string]: unknown;
} | null;
/** Rpm Limit */
rpm_limit?: number | null;
/** Rpm Limit Per Model */
rpm_limit_per_model?: {
[key: string]: number;
} | null;
/** Soft Budget */
soft_budget?: number | null;
/**
* Soft Budget Cooldown
* @default false
*/
soft_budget_cooldown: boolean;
/**
* Spend
* @default 0
*/
spend: number;
/** Team Alias */
team_alias?: string | null;
/**
* Team Blocked
* @default false
*/
team_blocked: boolean;
/** Team Id */
team_id?: string | null;
/** Team Max Budget */
team_max_budget?: number | null;
team_member?: components["schemas"]["Member"] | null;
/** Team Member Rpm Limit */
team_member_rpm_limit?: number | null;
/** Team Member Spend */
team_member_spend?: number | null;
/** Team Member Tpm Limit */
team_member_tpm_limit?: number | null;
/** Team Metadata */
team_metadata?: {
[key: string]: unknown;
} | null;
/** Team Model Aliases */
team_model_aliases?: {
[key: string]: unknown;
} | null;
/**
* Team Models
* @default []
*/
team_models: unknown[];
team_object_permission?: components["schemas"]["LiteLLM_ObjectPermissionTable"] | null;
/** Team Object Permission Id */
team_object_permission_id?: string | null;
/** Team Rpm Limit */
team_rpm_limit?: number | null;
/** Team Soft Budget */
team_soft_budget?: number | null;
/** Team Spend */
team_spend?: number | null;
/** Team Tpm Limit */
team_tpm_limit?: number | null;
/** Token */
token?: string | null;
/** Tpm Limit */
tpm_limit?: number | null;
/** Tpm Limit Per Model */
tpm_limit_per_model?: {
[key: string]: number;
} | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
/** User */
user?: unknown | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
/** User Max Budget */
user_max_budget?: number | null;
user_role?: components["schemas"]["LitellmUserRoles"] | null;
/** User Rpm Limit */
user_rpm_limit?: number | null;
/** User Spend */
user_spend?: number | null;
/** User Tpm Limit */
user_tpm_limit?: number | null;
};
/**
* UserHeaderMapping
* @description Map an incoming HTTP header to a LiteLLM user role.
*/
UserHeaderMapping: {
/** Header Name */
header_name: string;
/**
* Litellm User Role
* @enum {string}
*/
litellm_user_role: "internal_user" | "customer";
};
/** UserInfoResponse */
UserInfoResponse: {
/** Keys */
keys: unknown[];
/** Teams */
teams: unknown[];
/** User Id */
user_id: string | null;
/** User Info */
user_info: {
[key: string]: unknown;
} | components["schemas"]["BaseModel"] | null;
};
/**
* UserInfoV2Response
* @description Response model for GET /v2/user/info
*
* Returns ONLY the user object - no keys, no teams objects.
* This is a lightweight alternative to UserInfoResponse.
*/
UserInfoV2Response: {
/** Budget Duration */
budget_duration?: string | null;
/** Budget Reset At */
budget_reset_at?: string | null;
/** Created At */
created_at?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/**
* Models
* @default []
*/
models: string[];
/**
* Spend
* @default 0
*/
spend: number;
/** Sso User Id */
sso_user_id?: string | null;
/**
* Teams
* @default []
*/
teams: string[];
/** Updated At */
updated_at?: string | null;
/** User Alias */
user_alias?: string | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id: string;
/** User Role */
user_role?: string | null;
};
/**
* UserListResponse
* @description Response model for the user list endpoint
*/
UserListResponse: {
/** Page */
page: number;
/** Page Size */
page_size: number;
/** Total */
total: number;
/** Total Pages */
total_pages: number;
/** Users */
users: components["schemas"]["LiteLLM_UserTableWithKeyCount"][];
};
/**
* UserUpdateResult
* @description Result of a single user update operation
*/
UserUpdateResult: {
/** Error */
error?: string | null;
/** Success */
success: boolean;
/** Updated User */
updated_user?: {
[key: string]: unknown;
} | null;
/** User Email */
user_email?: string | null;
/** User Id */
user_id?: string | null;
};
/** ValidationError */
ValidationError: {
/** Context */
ctx?: Record<string, never>;
/** Input */
input?: unknown;
/** Location */
loc: (string | number)[];
/** Message */
msg: string;
/** Error Type */
type: string;
};
/**
* VantageDryRunRequest
* @description Request model for Vantage dry-run operations (capped for preview)
*/
VantageDryRunRequest: {
/**
* Limit
* @description Limit on number of records to preview (default: 500)
* @default 500
*/
limit: number | null;
};
/**
* VantageExportRequest
* @description Request model for Vantage export operations (actual export, no default limit)
*/
VantageExportRequest: {
/**
* End Time Utc
* @description End time for data export in UTC
*/
end_time_utc?: string | null;
/**
* Limit
* @description Optional limit on number of records to export (default: no limit)
*/
limit?: number | null;
/**
* Start Time Utc
* @description Start time for data export in UTC
*/
start_time_utc?: string | null;
};
/**
* VantageExportResponse
* @description Response model for Vantage export operations
*/
VantageExportResponse: {
/**
* Dry Run Data
* @description Dry run data including usage data and FOCUS transformed data
*/
dry_run_data?: {
[key: string]: unknown;
} | null;
/** Message */
message: string;
/** Status */
status: string;
/**
* Summary
* @description Summary statistics for dry run
*/
summary?: {
[key: string]: unknown;
} | null;
};
/**
* VantageInitRequest
* @description Request model for initializing Vantage settings
*/
VantageInitRequest: {
/**
* Api Key
* @description Vantage API key for authentication
*/
api_key: string;
/**
* Base Url
* @description Vantage API base URL (default: https://api.vantage.sh)
* @default https://api.vantage.sh
*/
base_url: string;
/**
* Integration Token
* @description Vantage integration token for the cost-import endpoint
*/
integration_token: string;
};
/**
* VantageInitResponse
* @description Response model for Vantage initialization
*/
VantageInitResponse: {
/** Message */
message: string;
/** Status */
status: string;
};
/**
* VantageSettingsUpdate
* @description Request model for updating Vantage settings
*/
VantageSettingsUpdate: {
/**
* Api Key
* @description New Vantage API key for authentication
*/
api_key?: string | null;
/**
* Base Url
* @description New Vantage API base URL
*/
base_url?: string | null;
/**
* Integration Token
* @description New Vantage integration token
*/
integration_token?: string | null;
};
/**
* VantageSettingsView
* @description Response model for viewing Vantage settings with masked API key
*/
VantageSettingsView: {
/**
* Api Key Masked
* @description Masked API key showing only first 4 and last 4 characters
*/
api_key_masked?: string | null;
/**
* Base Url
* @description Vantage API base URL
*/
base_url?: string | null;
/**
* Integration Token Masked
* @description Masked integration token showing only first 4 and last 4 characters
*/
integration_token_masked?: string | null;
/**
* Status
* @description Configuration status
*/
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 */
name: string;
/** Url */
url: string;
/** Worker Id */
worker_id: string;
};
/** WorkflowEventCreateRequest */
WorkflowEventCreateRequest: {
/** Data */
data?: {
[key: string]: unknown;
} | null;
/** Event Type */
event_type: string;
/** Step Name */
step_name: string;
};
/** WorkflowMessageCreateRequest */
WorkflowMessageCreateRequest: {
/** Content */
content: string;
/** Role */
role: string;
/** Session Id */
session_id?: string | null;
};
/** WorkflowRunCreateRequest */
WorkflowRunCreateRequest: {
/** Input */
input?: {
[key: string]: unknown;
} | null;
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Workflow Type */
workflow_type: string;
};
/** WorkflowRunUpdateRequest */
WorkflowRunUpdateRequest: {
/** Metadata */
metadata?: {
[key: string]: unknown;
} | null;
/** Output */
output?: {
[key: string]: unknown;
} | null;
/** Status */
status?: ("pending" | "running" | "paused" | "completed" | "failed") | null;
};
/** ModelInfo */
litellm__proxy___types__ModelInfo: {
/** Base Model */
base_model: ("gpt-4-1106-preview" | "gpt-4-32k" | "gpt-4" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo" | "text-embedding-ada-002") | null;
/** Id */
id: string | null;
/**
* Input Cost Per Token
* @default 0
*/
input_cost_per_token: number | null;
/**
* Max Tokens
* @default 2048
*/
max_tokens: number | null;
/** Mode */
mode: ("embedding" | "chat" | "completion") | null;
/**
* Output Cost Per Token
* @default 0
*/
output_cost_per_token: number | null;
} & {
[key: string]: unknown;
};
/** ModelInfo */
litellm__types__router__ModelInfo: {
/** Base Model */
base_model?: string | null;
/** Blocked */
blocked?: boolean | null;
/** Created At */
created_at?: string | null;
/** Created By */
created_by?: string | null;
/**
* Db Model
* @default false
*/
db_model: boolean;
/** Id */
id: string | null;
/** Team Id */
team_id?: string | null;
/** Team Public Model Name */
team_public_model_name?: string | null;
/** Tier */
tier?: ("free" | "paid") | null;
/** Updated At */
updated_at?: string | null;
/** Updated By */
updated_by?: string | null;
} & {
[key: string]: unknown;
};
/** updateDeployment */
updateDeployment: {
/** Blocked */
blocked?: boolean | null;
litellm_params?: components["schemas"]["updateLiteLLMParams"] | null;
model_info?: components["schemas"]["litellm__types__router__ModelInfo"] | null;
/** Model Name */
model_name?: string | null;
};
/** updateLiteLLMParams */
updateLiteLLMParams: {
/** Adaptive Router Config */
adaptive_router_config?: {
[key: string]: unknown;
} | null;
/** Adaptive Router Default Model */
adaptive_router_default_model?: string | null;
/** Api Base */
api_base?: string | null;
/** Api Key */
api_key?: string | null;
/** Api Version */
api_version?: string | null;
/** Auto Router Config */
auto_router_config?: string | null;
/** Auto Router Config Path */
auto_router_config_path?: string | null;
/** Auto Router Default Model */
auto_router_default_model?: string | null;
/** Auto Router Embedding Model */
auto_router_embedding_model?: string | null;
/** Aws Access Key Id */
aws_access_key_id?: string | null;
/** Aws Bedrock Runtime Endpoint */
aws_bedrock_runtime_endpoint?: string | null;
/** Aws Region Name */
aws_region_name?: string | null;
/** Aws Secret Access Key */
aws_secret_access_key?: string | null;
/** Budget Duration */
budget_duration?: string | null;
/** Cache Creation Input Audio Token Cost */
cache_creation_input_audio_token_cost?: number | null;
/** Cache Creation Input Token Cost */
cache_creation_input_token_cost?: number | null;
/** Cache Creation Input Token Cost Above 1Hr */
cache_creation_input_token_cost_above_1hr?: number | null;
/** Cache Creation Input Token Cost Above 200K Tokens */
cache_creation_input_token_cost_above_200k_tokens?: number | null;
/** Cache Read Input Audio Token Cost */
cache_read_input_audio_token_cost?: number | null;
/** Cache Read Input Token Cost */
cache_read_input_token_cost?: number | null;
/** Cache Read Input Token Cost Above 200K Tokens */
cache_read_input_token_cost_above_200k_tokens?: number | null;
/** Cache Read Input Token Cost Flex */
cache_read_input_token_cost_flex?: number | null;
/** Cache Read Input Token Cost Priority */
cache_read_input_token_cost_priority?: number | null;
/** Citation Cost Per Token */
citation_cost_per_token?: number | null;
/** Complexity Router Config */
complexity_router_config?: {
[key: string]: unknown;
} | null;
/** Complexity Router Default Model */
complexity_router_default_model?: string | null;
/** Configurable Clientside Auth Params */
configurable_clientside_auth_params?: (string | components["schemas"]["ConfigurableClientsideParamsCustomAuth-Input"])[] | null;
/** Custom Llm Provider */
custom_llm_provider?: string | null;
/** Default Api Key Rpm Limit */
default_api_key_rpm_limit?: number | null;
/** Default Api Key Tpm Limit */
default_api_key_tpm_limit?: number | null;
/** Gcs Bucket Name */
gcs_bucket_name?: string | null;
/** Input Cost Per Audio Per Second */
input_cost_per_audio_per_second?: number | null;
/** Input Cost Per Audio Per Second Above 128K Tokens */
input_cost_per_audio_per_second_above_128k_tokens?: number | null;
/** Input Cost Per Audio Token */
input_cost_per_audio_token?: number | null;
/** Input Cost Per Character */
input_cost_per_character?: number | null;
/** Input Cost Per Character Above 128K Tokens */
input_cost_per_character_above_128k_tokens?: number | null;
/** Input Cost Per Image */
input_cost_per_image?: number | null;
/** Input Cost Per Image Above 128K Tokens */
input_cost_per_image_above_128k_tokens?: number | null;
/** Input Cost Per Pixel */
input_cost_per_pixel?: number | null;
/** Input Cost Per Query */
input_cost_per_query?: number | null;
/** Input Cost Per Second */
input_cost_per_second?: number | null;
/** Input Cost Per Token */
input_cost_per_token?: number | null;
/** Input Cost Per Token Above 128K Tokens */
input_cost_per_token_above_128k_tokens?: number | null;
/** Input Cost Per Token Above 200K Tokens */
input_cost_per_token_above_200k_tokens?: number | null;
/** Input Cost Per Token Batches */
input_cost_per_token_batches?: number | null;
/** Input Cost Per Token Cache Hit */
input_cost_per_token_cache_hit?: number | null;
/** Input Cost Per Token Flex */
input_cost_per_token_flex?: number | null;
/** Input Cost Per Token Priority */
input_cost_per_token_priority?: number | null;
/** Input Cost Per Video Per Second */
input_cost_per_video_per_second?: number | null;
/** Input Cost Per Video Per Second Above 128K Tokens */
input_cost_per_video_per_second_above_128k_tokens?: number | null;
/** Input Cost Per Video Per Second Above 15S Interval */
input_cost_per_video_per_second_above_15s_interval?: number | null;
/** Input Cost Per Video Per Second Above 8S Interval */
input_cost_per_video_per_second_above_8s_interval?: number | null;
/** Litellm Credential Name */
litellm_credential_name?: string | null;
/** Litellm Trace Id */
litellm_trace_id?: string | null;
/** Max Budget */
max_budget?: number | null;
/** Max File Size Mb */
max_file_size_mb?: number | null;
/** Max Retries */
max_retries?: number | null;
/**
* Merge Reasoning Content In Choices
* @default false
*/
merge_reasoning_content_in_choices: boolean | null;
/** Milvus Db Name */
milvus_db_name?: string | null;
/** Milvus Partition Names */
milvus_partition_names?: string[] | null;
/** Milvus Text Field */
milvus_text_field?: string | null;
/** Mock Response */
mock_response?: string | components["schemas"]["ModelResponse"] | unknown | null;
/** Model */
model?: string | null;
/** Model Info */
model_info?: {
[key: string]: unknown;
} | null;
/** Organization */
organization?: string | null;
/** Output Cost Per Audio Per Second */
output_cost_per_audio_per_second?: number | null;
/** Output Cost Per Audio Token */
output_cost_per_audio_token?: number | null;
/** Output Cost Per Character */
output_cost_per_character?: number | null;
/** Output Cost Per Character Above 128K Tokens */
output_cost_per_character_above_128k_tokens?: number | null;
/** Output Cost Per Image */
output_cost_per_image?: number | null;
/** Output Cost Per Image Token */
output_cost_per_image_token?: number | null;
/** Output Cost Per Pixel */
output_cost_per_pixel?: number | null;
/** Output Cost Per Reasoning Token */
output_cost_per_reasoning_token?: number | null;
/** Output Cost Per Second */
output_cost_per_second?: number | null;
/** Output Cost Per Second 1080P */
output_cost_per_second_1080p?: number | null;
/** Output Cost Per Token */
output_cost_per_token?: number | null;
/** Output Cost Per Token Above 128K Tokens */
output_cost_per_token_above_128k_tokens?: number | null;
/** Output Cost Per Token Above 200K Tokens */
output_cost_per_token_above_200k_tokens?: number | null;
/** Output Cost Per Token Batches */
output_cost_per_token_batches?: number | null;
/** Output Cost Per Token Flex */
output_cost_per_token_flex?: number | null;
/** Output Cost Per Token Priority */
output_cost_per_token_priority?: number | null;
/** Output Cost Per Video Per Second */
output_cost_per_video_per_second?: number | null;
/** Quality Router Config */
quality_router_config?: {
[key: string]: unknown;
} | null;
/** Quality Router Default Model */
quality_router_default_model?: string | null;
/** Region Name */
region_name?: string | null;
/** Rpm */
rpm?: number | null;
/** S3 Bucket Name */
s3_bucket_name?: string | null;
/** S3 Encryption Key Id */
s3_encryption_key_id?: string | null;
/** Search Context Cost Per Query */
search_context_cost_per_query?: {
[key: string]: unknown;
} | null;
/** Stream Timeout */
stream_timeout?: number | string | null;
/** Tag Regex */
tag_regex?: string[] | null;
/** Tags */
tags?: string[] | null;
/** Tiered Pricing */
tiered_pricing?: {
[key: string]: unknown;
}[] | null;
/** Timeout */
timeout?: number | string | null;
/** Tpm */
tpm?: number | null;
/** Use Chat Completions Api */
use_chat_completions_api?: boolean | null;
/**
* Use In Pass Through
* @default false
*/
use_in_pass_through: boolean | null;
/**
* Use Litellm Proxy
* @default false
*/
use_litellm_proxy: boolean | null;
/**
* Use Xai Oauth
* @description Use stored xAI OAuth credentials when no xAI API key is configured.
* @default false
*/
use_xai_oauth: boolean | null;
/** Vector Store Id */
vector_store_id?: string | null;
/** Vertex Credentials */
vertex_credentials?: string | {
[key: string]: unknown;
} | null;
/** Vertex Location */
vertex_location?: string | null;
/** Vertex Project */
vertex_project?: string | null;
/** Watsonx Region Name */
watsonx_region_name?: string | null;
} & {
[key: string]: unknown;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
home__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;
};
};
};
};
get_ui_config__well_known_litellm_ui_config_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"]["UiDiscoveryEndpoints"];
};
};
};
};
invoke_agent_a2a_a2a__agent_id__post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: 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"];
};
};
};
};
get_agent_card_a2a__agent_id___well_known_agent_card_json_get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: 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"];
};
};
};
};
get_agent_card_a2a__agent_id___well_known_agent_json_get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: 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"];
};
};
};
};
invoke_agent_a2a_a2a__agent_id__message_send_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: 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_access_groups_access_group_list_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"]["ListAccessGroupsResponse"];
};
};
};
};
create_model_group_access_group_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewModelGroupRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NewModelGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_access_group_access_group__access_group__delete_delete: {
parameters: {
query?: never;
header?: never;
path: {
access_group: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DeleteModelGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_access_group_info_access_group__access_group__info_get: {
parameters: {
query?: never;
header?: never;
path: {
access_group: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupInfo"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_access_group_access_group__access_group__update_put: {
parameters: {
query?: never;
header?: never;
path: {
access_group: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateModelGroupRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NewModelGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
active_callbacks_active_callbacks_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;
};
};
};
};
get_adaptive_router_state_adaptive_router_state_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;
};
};
};
};
add_allowed_ip_add_allowed_ip_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IPAddress"];
};
};
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_agent_daily_activity_agent_daily_activity_get: {
parameters: {
query?: {
agent_ids?: string | null;
start_date?: string | null;
end_date?: string | null;
model?: string | null;
api_key?: string | null;
page?: number;
page_size?: number;
exclude_agent_ids?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
alerting_settings_alerting_settings_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;
};
};
};
};
anthropic_proxy_route_anthropic__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
anthropic_proxy_route_anthropic__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
anthropic_proxy_route_anthropic__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
anthropic_proxy_route_anthropic__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
anthropic_proxy_route_anthropic__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
event_logging_batch_api_event_logging_batch_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;
};
};
};
};
apply_guardrail_apply_guardrail_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ApplyGuardrailRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApplyGuardrailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
assemblyai_proxy_route_assemblyai__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_assemblyai__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_assemblyai__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_assemblyai__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_assemblyai__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
get_assistants_assistants_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_assistant_assistants_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;
};
};
};
};
delete_assistant_assistants__assistant_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
assistant_id: 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"];
};
};
};
};
audio_speech_audio_speech_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;
};
};
};
};
audio_transcriptions_audio_transcriptions_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_audio_transcriptions_audio_transcriptions_post"];
};
};
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_audit_logs_audit_get: {
parameters: {
query?: {
page?: number;
page_size?: number;
/** @description Filter by user or system that performed the action */
changed_by?: string | null;
/** @description Filter by API key hash that performed the action */
changed_by_api_key?: string | null;
/** @description Filter by action type (create, update, delete) */
action?: string | null;
/** @description Filter by table name that was modified */
table_name?: string | null;
/** @description Filter by ID of the object that was modified */
object_id?: string | null;
/** @description Filter logs after this date */
start_date?: string | null;
/** @description Filter logs before this date */
end_date?: string | null;
/** @description Filter by team_id present in before_value or updated_values JSON (PostgreSQL only) */
object_team_id?: string | null;
/** @description Filter by token (key hash) present in before_value or updated_values JSON (PostgreSQL only) */
object_key_hash?: string | null;
/** @description Column to sort by (e.g. 'updated_at', 'action', 'table_name') */
sort_by?: string | null;
/** @description Sort order ('asc' or 'desc') */
sort_order?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedAuditLogResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_audit_log_by_id_audit__id__get: {
parameters: {
query?: never;
header?: never;
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AuditLogResponse"];
};
};
/** @description Audit log not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
/** @description Database connection error */
500: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
azure_proxy_route_azure__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure_ai__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure_ai__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure_ai__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure_ai__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
azure_proxy_route_azure_ai__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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_batches_batches_get: {
parameters: {
query?: {
provider?: string | null;
limit?: number | null;
after?: string | null;
target_model_names?: string | null;
};
header?: never;
path?: never;
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_batch_batches_post: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
retrieve_batch_batches__batch_id__get: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
/** @description The ID of the batch to retrieve */
batch_id: 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"];
};
};
};
};
cancel_batch_batches__batch_id__cancel_post: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
batch_id: 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"];
};
};
};
};
bedrock_proxy_route_bedrock__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
bedrock_proxy_route_bedrock__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
bedrock_proxy_route_bedrock__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
bedrock_proxy_route_bedrock__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
bedrock_proxy_route_bedrock__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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_budget_budget_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BudgetDeleteRequest"];
};
};
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"];
};
};
};
};
info_budget_budget_info_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BudgetRequest"];
};
};
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_budget_budget_list_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;
};
};
};
};
new_budget_budget_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BudgetNewRequest"];
};
};
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"];
};
};
};
};
budget_settings_budget_settings_get: {
parameters: {
query: {
budget_id: string;
};
header?: never;
path?: never;
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"];
};
};
};
};
update_budget_budget_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BudgetNewRequest"];
};
};
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"];
};
};
};
};
cache_delete_cache_delete_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;
};
};
};
};
cache_flushall_cache_flushall_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;
};
};
};
};
cache_ping_cache_ping_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"]["CachePingResponse"];
};
};
};
};
cache_redis_info_cache_redis_info_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;
};
};
};
};
get_cache_settings_cache_settings_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"]["CacheSettingsResponse"];
};
};
};
};
update_cache_settings_cache_settings_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["CacheSettingsUpdateRequest"];
};
};
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"];
};
};
};
};
test_cache_connection_cache_settings_test_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CacheTestRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CacheTestResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_callback_configs_callbacks_configs_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;
};
};
};
};
list_callbacks_callbacks_list_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"]["CallbacksByType"];
};
};
};
};
chat_completion_chat_completions_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Caching
* @default null
*/
caching?: boolean | null;
/**
* Context Window Fallback Dict
* @default null
*/
context_window_fallback_dict?: {
[key: string]: string;
} | null;
/**
* Fallbacks
* @default null
*/
fallbacks?: string[] | null;
/**
* Frequency Penalty
* @default null
*/
frequency_penalty?: number | null;
/**
* Function Call
* @default null
*/
function_call?: string | {
[key: string]: unknown;
} | null;
/**
* Functions
* @default null
*/
functions?: {
[key: string]: unknown;
}[] | null;
/**
* Guardrails
* @default null
*/
guardrails?: string[] | null;
/**
* Logit Bias
* @default null
*/
logit_bias?: {
[key: string]: number;
} | null;
/**
* Logprobs
* @default null
*/
logprobs?: boolean | null;
/**
* Max Tokens
* @default null
*/
max_tokens?: number | null;
/**
* Messages
* @example [
* {
* "content": "Hello, how are you?",
* "role": "user"
* }
* ]
*/
messages: (components["schemas"]["ChatCompletionUserMessage"] | components["schemas"]["ChatCompletionAssistantMessage"] | components["schemas"]["ChatCompletionToolMessage"] | components["schemas"]["ChatCompletionSystemMessage"] | components["schemas"]["ChatCompletionFunctionMessage"] | components["schemas"]["ChatCompletionDeveloperMessage"])[];
/**
* Metadata
* @default null
*/
metadata?: {
[key: string]: unknown;
} | null;
/** Model */
model: string;
/**
* N
* @default null
*/
n?: number | null;
/**
* Num Retries
* @default null
*/
num_retries?: number | null;
/**
* Parallel Tool Calls
* @default null
*/
parallel_tool_calls?: boolean | null;
/**
* Presence Penalty
* @default null
*/
presence_penalty?: number | null;
/**
* Response Format
* @default null
*/
response_format?: {
[key: string]: unknown;
} | null;
/**
* Seed
* @default null
*/
seed?: number | null;
/**
* Service Tier
* @default null
*/
service_tier?: string | null;
/**
* Stop
* @default null
*/
stop?: string | string[] | null;
/**
* Stream
* @default null
*/
stream?: boolean | null;
/**
* Stream Options
* @default null
*/
stream_options?: {
[key: string]: unknown;
} | null;
/**
* Temperature
* @default null
*/
temperature?: number | null;
/**
* Tool Choice
* @default null
*/
tool_choice?: string | {
[key: string]: unknown;
} | null;
/**
* Tools
* @default null
*/
tools?: {
[key: string]: unknown;
}[] | null;
/**
* Top Logprobs
* @default null
*/
top_logprobs?: number | null;
/**
* Top P
* @default null
*/
top_p?: number | null;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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_marketplace_claude_code_marketplace_json_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;
};
};
};
};
list_plugins_claude_code_plugins_get: {
parameters: {
query?: {
enabled_only?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListPluginsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
register_plugin_claude_code_plugins_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["RegisterPluginRequest"];
};
};
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_plugin_claude_code_plugins__plugin_name__get: {
parameters: {
query?: never;
header?: never;
path: {
plugin_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_plugin_claude_code_plugins__plugin_name__delete: {
parameters: {
query?: never;
header?: never;
path: {
plugin_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"];
};
};
};
};
disable_plugin_claude_code_plugins__plugin_name__disable_post: {
parameters: {
query?: never;
header?: never;
path: {
plugin_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"];
};
};
};
};
enable_plugin_claude_code_plugins__plugin_name__enable_post: {
parameters: {
query?: never;
header?: never;
path: {
plugin_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_cloudzero_settings_cloudzero_delete_delete: {
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"]["CloudZeroInitResponse"];
};
};
};
};
cloudzero_dry_run_export_cloudzero_dry_run_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CloudZeroExportRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CloudZeroExportResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
cloudzero_export_cloudzero_export_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CloudZeroExportRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CloudZeroExportResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
init_cloudzero_settings_cloudzero_init_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CloudZeroInitRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CloudZeroInitResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_cloudzero_settings_cloudzero_settings_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"]["CloudZeroSettingsView"];
};
};
};
};
update_cloudzero_settings_cloudzero_settings_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CloudZeroSettingsUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CloudZeroInitResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
cohere_proxy_route_cohere__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cohere_proxy_route_cohere__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cohere_proxy_route_cohere__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cohere_proxy_route_cohere__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cohere_proxy_route_cohere__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
completion_completions_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
check_eu_ai_act_compliance_compliance_eu_ai_act_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ComplianceCheckRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ComplianceResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
check_gdpr_compliance_compliance_gdpr_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ComplianceCheckRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ComplianceResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_callback_config_callback_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CallbackDelete"];
};
};
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_cost_discount_config_config_cost_discount_config_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;
};
};
};
};
update_cost_discount_config_config_cost_discount_config_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
[key: string]: number;
};
};
};
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_cost_margin_config_config_cost_margin_config_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;
};
};
};
};
update_cost_margin_config_config_cost_margin_config_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
[key: string]: number | {
[key: string]: number;
};
};
};
};
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_config_general_settings_config_field_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ConfigFieldDelete"];
};
};
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_config_general_settings_config_field_info_get: {
parameters: {
query: {
field_name: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ConfigFieldInfo"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_config_general_settings_config_field_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ConfigFieldUpdate"];
};
};
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_config_list_config_list_get: {
parameters: {
query: {
config_type: "general_settings";
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ConfigList"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_pass_through_endpoints_config_pass_through_endpoint_get: {
parameters: {
query?: {
endpoint_id?: string | null;
team_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PassThroughEndpointResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_pass_through_endpoints_config_pass_through_endpoint_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PassThroughGenericEndpoint"];
};
};
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_pass_through_endpoints_config_pass_through_endpoint_delete: {
parameters: {
query: {
endpoint_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PassThroughEndpointResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_pass_through_endpoints_config_pass_through_endpoint_team__team_id__get: {
parameters: {
query?: {
endpoint_id?: string | null;
};
header?: never;
path: {
team_id: string | null;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PassThroughEndpointResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_pass_through_endpoints_config_pass_through_endpoint__endpoint_id__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PassThroughGenericEndpoint"];
};
};
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_config_config_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ConfigYAML"];
};
};
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"];
};
};
};
};
config_yaml_endpoint_config_yaml_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ConfigYAML"];
};
};
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_hashicorp_vault_config_config_overrides_hashicorp_vault_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"]["ConfigOverrideSettingsResponse"];
};
};
};
};
update_hashicorp_vault_config_config_overrides_hashicorp_vault_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["HashicorpVaultConfig"];
};
};
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_hashicorp_vault_config_config_overrides_hashicorp_vault_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
test_hashicorp_vault_connection_config_overrides_hashicorp_vault_test_connection_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;
};
};
};
};
list_containers_containers_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_container_containers_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;
};
};
};
};
retrieve_container_containers__container_id__get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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_container_containers__container_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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"];
};
};
};
};
handler_container_id_containers__container_id__files_get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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"];
};
};
};
};
handler_multipart_upload_containers__container_id__files_post: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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"];
};
};
};
};
handler_container_file_containers__container_id__files__file_id__get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: string;
file_id: 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"];
};
};
};
};
handler_container_file_containers__container_id__files__file_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
container_id: string;
file_id: 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"];
};
};
};
};
handler_binary_content_containers__container_id__files__file_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: string;
file_id: 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"];
};
};
};
};
estimate_cost_cost_estimate_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CostEstimateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CostEstimateResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_credentials_credentials_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_credential_credentials_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateCredentialItem"];
};
};
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_credential_by_model_credentials_by_model__model_id__get: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The model ID to look up credentials for */
model_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CredentialItem"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_credential_by_name_credentials_by_name__credential_name__get: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The credential name, percent-decoded; may contain slashes */
credential_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CredentialItem"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_credential_credentials__credential_name__delete: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The credential name, percent-decoded; may contain slashes */
credential_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"];
};
};
};
};
update_credential_credentials__credential_name__patch: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The credential name, percent-decoded; may contain slashes */
credential_name: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CredentialItem"];
};
};
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"];
};
};
};
};
cursor_chat_completions_cursor_chat_completions_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;
};
};
};
};
cursor_proxy_route_cursor__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cursor_proxy_route_cursor__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cursor_proxy_route_cursor__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cursor_proxy_route_cursor__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
cursor_proxy_route_cursor__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
block_user_customer_block_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockUsers"];
};
};
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_customer_daily_activity_customer_daily_activity_get: {
parameters: {
query?: {
end_user_ids?: string | null;
start_date?: string | null;
end_date?: string | null;
model?: string | null;
api_key?: string | null;
page?: number;
page_size?: number;
exclude_end_user_ids?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_end_user_customer_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteCustomerRequest"];
};
};
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"];
};
};
};
};
end_user_info_customer_info_get: {
parameters: {
query: {
/** @description End User ID in the request parameters */
end_user_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_EndUserTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_end_user_customer_list_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"]["LiteLLM_EndUserTable"][];
};
};
};
};
new_end_user_customer_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewCustomerRequest"];
};
};
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"];
};
};
};
};
unblock_user_customer_unblock_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockUsers"];
};
};
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_end_user_customer_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateCustomerRequest"];
};
};
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_active_tasks_stats_debug_asyncio_tasks_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;
};
};
};
};
get_memory_details_debug_memory_details_get: {
parameters: {
query?: {
/** @description Number of top object types to return */
top_n?: number;
/** @description Include process memory info */
include_process_info?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
configure_gc_thresholds_endpoint_debug_memory_gc_configure_post: {
parameters: {
query?: {
/** @description Generation 0 threshold (default: 700) */
generation_0?: number;
/** @description Generation 1 threshold (default: 10) */
generation_1?: number;
/** @description Generation 2 threshold (default: 10) */
generation_2?: number;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_memory_summary_debug_memory_summary_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
};
};
delete_allowed_ip_delete_allowed_ip_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IPAddress"];
};
};
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_email_event_settings_email_event_settings_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"]["EmailEventSettingsResponse"];
};
};
};
};
update_event_settings_email_event_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EmailEventSettingsUpdateRequest"];
};
};
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"];
};
};
};
};
reset_event_settings_email_event_settings_reset_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;
};
};
};
};
embeddings_embeddings_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Api Base
* @default null
*/
api_base?: string | null;
/**
* Api Key
* @default null
*/
api_key?: string | null;
/**
* Api Type
* @default null
*/
api_type?: string | null;
/**
* Api Version
* @default null
*/
api_version?: string | null;
/**
* Caching
* @default false
*/
caching?: boolean;
/**
* Custom Llm Provider
* @default null
*/
custom_llm_provider?: string | {
[key: string]: unknown;
} | null;
/**
* Input
* @default []
*/
input?: string[];
/**
* Litellm Call Id
* @default null
*/
litellm_call_id?: string | null;
/**
* Litellm Logging Obj
* @default null
*/
litellm_logging_obj?: {
[key: string]: unknown;
} | null;
/**
* Logger Fn
* @default null
*/
logger_fn?: string | null;
/** Model */
model: string;
/**
* Timeout
* @default 600
*/
timeout?: number;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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"];
};
};
};
};
block_user_end_user_block_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockUsers"];
};
};
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_customer_daily_activity_end_user_daily_activity_get: {
parameters: {
query?: {
end_user_ids?: string | null;
start_date?: string | null;
end_date?: string | null;
model?: string | null;
api_key?: string | null;
page?: number;
page_size?: number;
exclude_end_user_ids?: string | null;
};
header?: never;
path?: never;
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_end_user_end_user_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteCustomerRequest"];
};
};
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"];
};
};
};
};
end_user_info_end_user_info_get: {
parameters: {
query: {
/** @description End User ID in the request parameters */
end_user_id: string;
};
header?: never;
path?: never;
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_end_user_end_user_list_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;
};
};
};
};
new_end_user_end_user_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewCustomerRequest"];
};
};
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"];
};
};
};
};
unblock_user_end_user_unblock_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockUsers"];
};
};
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_end_user_end_user_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateCustomerRequest"];
};
};
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"];
};
};
};
};
chat_completion_engines__model__chat_completions_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Caching
* @default null
*/
caching?: boolean | null;
/**
* Context Window Fallback Dict
* @default null
*/
context_window_fallback_dict?: {
[key: string]: string;
} | null;
/**
* Fallbacks
* @default null
*/
fallbacks?: string[] | null;
/**
* Frequency Penalty
* @default null
*/
frequency_penalty?: number | null;
/**
* Function Call
* @default null
*/
function_call?: string | {
[key: string]: unknown;
} | null;
/**
* Functions
* @default null
*/
functions?: {
[key: string]: unknown;
}[] | null;
/**
* Guardrails
* @default null
*/
guardrails?: string[] | null;
/**
* Logit Bias
* @default null
*/
logit_bias?: {
[key: string]: number;
} | null;
/**
* Logprobs
* @default null
*/
logprobs?: boolean | null;
/**
* Max Tokens
* @default null
*/
max_tokens?: number | null;
/**
* Messages
* @example [
* {
* "content": "Hello, how are you?",
* "role": "user"
* }
* ]
*/
messages: (components["schemas"]["ChatCompletionUserMessage"] | components["schemas"]["ChatCompletionAssistantMessage"] | components["schemas"]["ChatCompletionToolMessage"] | components["schemas"]["ChatCompletionSystemMessage"] | components["schemas"]["ChatCompletionFunctionMessage"] | components["schemas"]["ChatCompletionDeveloperMessage"])[];
/**
* Metadata
* @default null
*/
metadata?: {
[key: string]: unknown;
} | null;
/** Model */
model: string;
/**
* N
* @default null
*/
n?: number | null;
/**
* Num Retries
* @default null
*/
num_retries?: number | null;
/**
* Parallel Tool Calls
* @default null
*/
parallel_tool_calls?: boolean | null;
/**
* Presence Penalty
* @default null
*/
presence_penalty?: number | null;
/**
* Response Format
* @default null
*/
response_format?: {
[key: string]: unknown;
} | null;
/**
* Seed
* @default null
*/
seed?: number | null;
/**
* Service Tier
* @default null
*/
service_tier?: string | null;
/**
* Stop
* @default null
*/
stop?: string | string[] | null;
/**
* Stream
* @default null
*/
stream?: boolean | null;
/**
* Stream Options
* @default null
*/
stream_options?: {
[key: string]: unknown;
} | null;
/**
* Temperature
* @default null
*/
temperature?: number | null;
/**
* Tool Choice
* @default null
*/
tool_choice?: string | {
[key: string]: unknown;
} | null;
/**
* Tools
* @default null
*/
tools?: {
[key: string]: unknown;
}[] | null;
/**
* Top Logprobs
* @default null
*/
top_logprobs?: number | null;
/**
* Top P
* @default null
*/
top_p?: number | null;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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"];
};
};
};
};
completion_engines__model__completions_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
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"];
};
};
};
};
embeddings_engines__model__embeddings_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Api Base
* @default null
*/
api_base?: string | null;
/**
* Api Key
* @default null
*/
api_key?: string | null;
/**
* Api Type
* @default null
*/
api_type?: string | null;
/**
* Api Version
* @default null
*/
api_version?: string | null;
/**
* Caching
* @default false
*/
caching?: boolean;
/**
* Custom Llm Provider
* @default null
*/
custom_llm_provider?: string | {
[key: string]: unknown;
} | null;
/**
* Input
* @default []
*/
input?: string[];
/**
* Litellm Call Id
* @default null
*/
litellm_call_id?: string | null;
/**
* Litellm Logging Obj
* @default null
*/
litellm_logging_obj?: {
[key: string]: unknown;
} | null;
/**
* Logger Fn
* @default null
*/
logger_fn?: string | null;
/** Model */
model: string;
/**
* Timeout
* @default 600
*/
timeout?: number;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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"];
};
};
};
};
assemblyai_proxy_route_eu_assemblyai__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_eu_assemblyai__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_eu_assemblyai__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_eu_assemblyai__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
assemblyai_proxy_route_eu_assemblyai__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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_fallback_fallback_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["FallbackCreateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["FallbackResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
fallback_login_fallback_login_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;
};
};
};
};
get_fallback_fallback__model__get: {
parameters: {
query?: {
fallback_type?: "general" | "context_window" | "content_policy";
};
header?: never;
path: {
model: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["FallbackGetResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_fallback_fallback__model__delete: {
parameters: {
query?: {
fallback_type?: "general" | "context_window" | "content_policy";
};
header?: never;
path: {
model: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["FallbackDeleteResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_files_files_get: {
parameters: {
query?: {
provider?: string | null;
target_model_names?: string | null;
purpose?: string | null;
};
header?: never;
path?: never;
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_file_files_post: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_create_file_files_post"];
};
};
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_file_files__file_id__get: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
file_id: 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_file_files__file_id__delete: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
file_id: 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"];
};
};
};
};
get_file_content_files__file_id__content_get: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
file_id: 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_fine_tuning_jobs_fine_tuning_jobs_get: {
parameters: {
query?: {
custom_llm_provider?: ("openai" | "azure") | null;
/** @description Comma separated list of model names to filter by. Example: 'gpt-4o,gpt-4o-mini' */
target_model_names?: string | null;
after?: string | null;
limit?: number | null;
};
header?: never;
path?: never;
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_fine_tuning_job_fine_tuning_jobs_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["LiteLLMFineTuningJobCreate"];
};
};
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"];
};
};
};
};
retrieve_fine_tuning_job_fine_tuning_jobs__fine_tuning_job_id__get: {
parameters: {
query?: {
custom_llm_provider?: ("openai" | "azure") | null;
};
header?: never;
path: {
fine_tuning_job_id: 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"];
};
};
};
};
cancel_fine_tuning_job_fine_tuning_jobs__fine_tuning_job_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
fine_tuning_job_id: 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"];
};
};
};
};
gemini_proxy_route_gemini__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
gemini_proxy_route_gemini__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
gemini_proxy_route_gemini__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
gemini_proxy_route_gemini__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
gemini_proxy_route_gemini__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
get_allowed_ips_get_allowed_ips_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;
};
};
};
};
get_config_get_config_callbacks_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;
};
};
};
};
get_default_team_settings_get_default_team_settings_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"]["DefaultTeamSettingsResponse"];
};
};
};
};
get_internal_user_settings_get_internal_user_settings_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"]["InternalUserSettingsResponse"];
};
};
};
};
get_mcp_semantic_filter_settings_get_mcp_semantic_filter_settings_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"]["MCPSemanticFilterSettingsResponse"];
};
};
};
};
get_sso_settings_get_sso_settings_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"]["SSOSettingsResponse"];
};
};
};
};
get_ui_settings_get_ui_settings_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"]["UISettingsResponse"];
};
};
};
};
get_ui_theme_settings_get_ui_theme_settings_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"]["UIThemeSettingsResponse"];
};
};
};
};
get_favicon_get_favicon_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;
};
};
};
};
get_image_get_image_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;
};
};
};
};
get_logo_url_get_logo_url_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;
};
};
};
};
get_global_activity_global_activity_get: {
parameters: {
query?: {
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_global_activity_global_activity_cache_hits_get: {
parameters: {
query?: {
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_global_activity_exceptions_global_activity_exceptions_get: {
parameters: {
query: {
/** @description Filter by model group */
model_group: string;
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_global_activity_exceptions_per_deployment_global_activity_exceptions_deployment_get: {
parameters: {
query: {
/** @description Filter by model group */
model_group: string;
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_global_activity_model_global_activity_model_get: {
parameters: {
query?: {
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
global_view_all_end_users_global_all_end_users_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;
};
};
};
};
global_spend_global_spend_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;
};
};
};
};
global_get_all_tag_names_global_spend_all_tag_names_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"]["LiteLLM_SpendLogs"][];
};
};
};
};
global_spend_end_users_global_spend_end_users_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"application/json": components["schemas"]["GlobalEndUsersSpend"] | null;
};
};
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"];
};
};
};
};
global_spend_keys_global_spend_keys_get: {
parameters: {
query?: {
/** @description Number of keys to get. Will return Top 'n' keys. */
limit?: number;
};
header?: never;
path?: never;
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"];
};
};
};
};
global_spend_logs_global_spend_logs_get: {
parameters: {
query?: {
/** @description API Key to get global spend (spend per day for last 30d). Admin-only endpoint */
api_key?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
global_spend_models_global_spend_models_get: {
parameters: {
query?: {
/** @description Number of models to get. Will return Top 'n' models. */
limit?: number;
};
header?: never;
path?: never;
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"];
};
};
};
};
get_global_spend_provider_global_spend_provider_get: {
parameters: {
query?: {
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
global_spend_refresh_global_spend_refresh_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_global_spend_report_global_spend_report_get: {
parameters: {
query?: {
/** @description Time from which to start viewing spend */
start_date?: string | null;
/** @description Time till which to view spend */
end_date?: string | null;
/** @description Group spend by internal team or customer or api_key */
group_by?: ("team" | "customer" | "api_key") | null;
/** @description View spend for a specific api_key. Example api_key='sk-1234 */
api_key?: string | null;
/** @description View spend for a specific internal_user_id. Example internal_user_id='1234 */
internal_user_id?: string | null;
/** @description View spend for a specific team_id. Example team_id='1234 */
team_id?: string | null;
/** @description View spend for a specific customer_id. Example customer_id='1234. Can be used in conjunction with team_id as well. */
customer_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
global_spend_reset_global_spend_reset_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;
};
};
};
};
global_view_spend_tags_global_spend_tags_get: {
parameters: {
query?: {
/** @description Time from which to start viewing key spend */
start_date?: string | null;
/** @description Time till which to view key spend */
end_date?: string | null;
/** @description comman separated tags to filter on */
tags?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
global_spend_per_team_global_spend_teams_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_guardrail_guardrails_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateGuardrailRequest"];
};
};
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"];
};
};
};
};
apply_guardrail_guardrails_apply_guardrail_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ApplyGuardrailRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApplyGuardrailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_guardrails_guardrails_list_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"]["ListGuardrailsResponse"];
};
};
};
};
register_guardrail_guardrails_register_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["RegisterGuardrailRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RegisterGuardrailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_guardrail_submissions_guardrails_submissions_get: {
parameters: {
query?: {
status?: string | null;
team_id?: string | null;
search?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListGuardrailSubmissionsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_guardrail_submission_guardrails_submissions__guardrail_id__get: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GuardrailSubmissionItem"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
approve_guardrail_submission_guardrails_submissions__guardrail_id__approve_post: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: 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"];
};
};
};
};
reject_guardrail_submission_guardrails_submissions__guardrail_id__reject_post: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: 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"];
};
};
};
};
test_custom_code_guardrail_guardrails_test_custom_code_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TestCustomCodeGuardrailRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TestCustomCodeGuardrailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_guardrail_ui_settings_guardrails_ui_add_guardrail_settings_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;
};
};
};
};
get_category_yaml_guardrails_ui_category_yaml__category_name__get: {
parameters: {
query?: never;
header?: never;
path: {
category_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"];
};
};
};
};
get_major_airlines_guardrails_ui_major_airlines_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;
};
};
};
};
get_provider_specific_params_guardrails_ui_provider_specific_params_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;
};
};
};
};
guardrails_usage_detail_guardrails_usage_detail__guardrail_id__get: {
parameters: {
query?: {
start_date?: string | null;
end_date?: string | null;
};
header?: never;
path: {
guardrail_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UsageDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
guardrails_usage_logs_guardrails_usage_logs_get: {
parameters: {
query?: {
guardrail_id?: string | null;
policy_id?: string | null;
page?: number;
page_size?: number;
action?: string | null;
start_date?: string | null;
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UsageLogsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
guardrails_usage_overview_guardrails_usage_overview_get: {
parameters: {
query?: {
/** @description YYYY-MM-DD */
start_date?: string | null;
/** @description YYYY-MM-DD */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UsageOverviewResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
validate_blocked_words_file_guardrails_validate_blocked_words_file_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
[key: string]: string;
};
};
};
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_guardrail_info_guardrails__guardrail_id__get: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: 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"];
};
};
};
};
update_guardrail_guardrails__guardrail_id__put: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateGuardrailRequest"];
};
};
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_guardrail_guardrails__guardrail_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: 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"];
};
};
};
};
patch_guardrail_guardrails__guardrail_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PatchGuardrailRequest"];
};
};
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_guardrail_info_guardrails__guardrail_id__info_get: {
parameters: {
query?: never;
header?: never;
path: {
guardrail_id: 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"];
};
};
};
};
health_endpoint_health_get: {
parameters: {
query?: {
/** @description Specify the model name (optional) */
model?: string | null;
/** @description Specify the model ID (optional) */
model_id?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
health_backlog_health_backlog_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;
};
};
};
};
health_drain_health_drain_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;
};
};
};
};
health_check_history_endpoint_health_history_get: {
parameters: {
query?: {
/** @description Filter by specific model name */
model?: string | null;
/** @description Filter by status (healthy/unhealthy) */
status_filter?: string | null;
/** @description Number of records to return */
limit?: number;
/** @description Number of records to skip */
offset?: number;
};
header?: never;
path?: never;
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"];
};
};
};
};
latest_health_checks_endpoint_health_latest_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;
};
};
};
};
health_license_endpoint_health_license_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;
};
};
};
};
health_liveliness_health_liveliness_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;
};
};
};
};
health_liveliness_options_health_liveliness_options: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
health_liveliness_health_liveness_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;
};
};
};
};
health_liveliness_options_health_liveness_options: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
health_readiness_health_readiness_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;
};
};
};
};
health_readiness_options_health_readiness_options: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
health_readiness_details_health_readiness_details_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;
};
};
};
};
health_services_endpoint_health_services_get: {
parameters: {
query: {
/** @description Specify the service being hit. */
service: ("slack_budget_alerts" | "langfuse" | "langfuse_otel" | "slack" | "openmeter" | "webhook" | "email" | "braintrust" | "datadog" | "datadog_llm_observability" | "generic_api" | "arize" | "galileo" | "sqs") | string;
};
header?: never;
path?: never;
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"];
};
};
};
};
shared_health_check_status_endpoint_health_shared_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": unknown;
};
};
};
};
test_model_connection_health_test_connection_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"application/json": components["schemas"]["Body_test_model_connection_health_test_connection_post"];
};
};
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"];
};
};
};
};
image_edit_api_images_edits_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"multipart/form-data": components["schemas"]["Body_image_edit_api_images_edits_post"];
};
};
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"];
};
};
};
};
image_generation_images_generations_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
get_in_product_nudges_in_product_nudges_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"]["InProductNudgeResponse"];
};
};
};
};
create_interaction_interactions_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_interaction_interactions__interaction_id__get: {
parameters: {
query?: never;
header?: never;
path: {
interaction_id: 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_interaction_interactions__interaction_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
interaction_id: 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"];
};
};
};
};
cancel_interaction_interactions__interaction_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
interaction_id: 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"];
};
};
};
};
invitation_delete_invitation_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["InvitationDelete"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InvitationModel"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
invitation_info_invitation_info_get: {
parameters: {
query: {
invitation_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InvitationModel"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
new_invitation_invitation_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["InvitationNew"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InvitationModel"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
invitation_update_invitation_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["InvitationUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InvitationModel"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_jwt_key_mapping_jwt_key_mapping_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteJWTKeyMappingRequest"];
};
};
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"];
};
};
};
};
info_jwt_key_mapping_jwt_key_mapping_info_get: {
parameters: {
query: {
id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["JWTKeyMappingResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_jwt_key_mappings_jwt_key_mapping_list_get: {
parameters: {
query?: {
/** @description Page number */
page?: number;
/** @description Page size */
size?: number;
};
header?: never;
path?: never;
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_jwt_key_mapping_jwt_key_mapping_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateJWTKeyMappingRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["JWTKeyMappingResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_jwt_key_mapping_jwt_key_mapping_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateJWTKeyMappingRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["JWTKeyMappingResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
key_aliases_key_aliases_get: {
parameters: {
query?: {
/** @description Page number */
page?: number;
/** @description Page size */
size?: number;
/** @description Search key aliases (case-insensitive partial match) */
search?: string | null;
/** @description Filter aliases to keys belonging to this team */
team_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
block_key_key_block_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockKeyRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_VerificationToken"] | null;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
bulk_update_keys_key_bulk_update_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkUpdateKeyRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BulkUpdateKeyResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_key_fn_key_delete_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["KeyRequest"];
};
};
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"];
};
};
};
};
generate_key_fn_key_generate_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["GenerateKeyRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerateKeyResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
key_health_key_health_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"]["KeyHealthResponse"];
};
};
};
};
info_key_fn_key_info_get: {
parameters: {
query?: {
/** @description Key in the request parameters */
key?: string | null;
};
header?: never;
path?: never;
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_keys_key_list_get: {
parameters: {
query?: {
/** @description Page number */
page?: number;
/** @description Page size */
size?: number;
/** @description Filter keys by user ID. Supports partial matching (substring, case-insensitive). */
user_id?: string | null;
/** @description Filter keys by team ID */
team_id?: string | null;
/** @description Filter keys by organization ID */
organization_id?: string | null;
/** @description Filter keys by key hash */
key_hash?: string | null;
/** @description Filter keys by key alias. Supports partial matching (substring, case-insensitive). */
key_alias?: string | null;
/** @description Return full key object */
return_full_object?: boolean;
/** @description Include all keys for teams that user is an admin of. */
include_team_keys?: boolean;
/** @description Include keys created by the user */
include_created_by_keys?: boolean;
/** @description Column to sort by (e.g. 'user_id', 'created_at', 'spend') */
sort_by?: string | null;
/** @description Sort order ('asc' or 'desc') */
sort_order?: string;
/** @description Expand related objects (e.g. 'user') */
expand?: string[] | null;
/** @description Filter by status (e.g. 'deleted') */
status?: string | null;
/** @description Filter keys by project ID */
project_id?: string | null;
/** @description Filter keys by access group ID */
access_group_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["KeyListResponseObject"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
regenerate_key_fn_key_regenerate_post: {
parameters: {
query?: {
key?: string | null;
};
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;
};
requestBody?: {
content: {
"application/json": components["schemas"]["RegenerateKeyRequest"] | null;
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerateKeyResponse"] | null;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
generate_service_account_key_fn_key_service_account_generate_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["GenerateKeyRequest"];
};
};
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"];
};
};
};
};
unblock_key_key_unblock_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockKeyRequest"];
};
};
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_key_fn_key_update_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateKeyRequest"];
};
};
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"];
};
};
};
};
regenerate_key_fn_key__key__regenerate_post: {
parameters: {
query?: 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: {
key: string | null;
};
cookie?: never;
};
requestBody?: {
content: {
"application/json": components["schemas"]["RegenerateKeyRequest"] | null;
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerateKeyResponse"] | null;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
reset_key_spend_fn_key__key__reset_spend_post: {
parameters: {
query?: 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: {
key: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ResetSpendRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
langfuse_proxy_route_langfuse__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
langfuse_proxy_route_langfuse__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
langfuse_proxy_route_langfuse__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
langfuse_proxy_route_langfuse__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
langfuse_proxy_route_langfuse__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
warm_lazy_warm__name__post: {
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"];
};
};
};
};
get_ui_config_litellm__well_known_litellm_ui_config_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"]["UiDiscoveryEndpoints"];
};
};
};
};
login_login_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;
};
};
};
};
test_connection_mcp_rest_test_connection_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewMCPServerRequest"];
};
};
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"];
};
};
};
};
test_tools_list_mcp_rest_test_tools_list_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewMCPServerRequest"];
};
};
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"];
};
};
};
};
call_tool_rest_api_mcp_rest_tools_call_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;
};
};
};
};
list_tool_rest_api_mcp_rest_tools_list_get: {
parameters: {
query?: {
/** @description The server id to list tools for */
server_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
memory_usage_in_mem_cache_memory_usage_in_mem_cache_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;
};
};
};
};
memory_usage_in_mem_cache_items_memory_usage_in_mem_cache_items_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;
};
};
};
};
milvus_proxy_route_milvus__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
milvus_proxy_route_milvus__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
milvus_proxy_route_milvus__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
milvus_proxy_route_milvus__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
milvus_proxy_route_milvus__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
mistral_proxy_route_mistral__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
mistral_proxy_route_mistral__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
mistral_proxy_route_mistral__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
mistral_proxy_route_mistral__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
mistral_proxy_route_mistral__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
get_model_cost_map_source_model_cost_map_source_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;
};
};
};
};
delete_model_model_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ModelInfoDelete"];
};
};
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"];
};
};
};
};
model_info_v1_model_info_get: {
parameters: {
query?: {
litellm_model_id?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
model_metrics_model_metrics_get: {
parameters: {
query?: {
_selected_model_group?: string | null;
startTime?: string | null;
endTime?: string | null;
api_key?: string | null;
customer?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
model_metrics_exceptions_model_metrics_exceptions_get: {
parameters: {
query?: {
_selected_model_group?: string | null;
startTime?: string | null;
endTime?: string | null;
api_key?: string | null;
customer?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
model_metrics_slow_responses_model_metrics_slow_responses_get: {
parameters: {
query?: {
_selected_model_group?: string | null;
startTime?: string | null;
endTime?: string | null;
api_key?: string | null;
customer?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
add_new_model_model_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["Deployment"];
};
};
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"];
};
};
};
};
model_settings_model_settings_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;
};
};
};
};
model_streaming_metrics_model_streaming_metrics_get: {
parameters: {
query?: {
_selected_model_group?: string | null;
startTime?: string | null;
endTime?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
update_model_model_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["updateDeployment"];
};
};
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"];
};
};
};
};
patch_model_model__model_id__update_patch: {
parameters: {
query?: never;
header?: never;
path: {
model_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["updateDeployment"];
};
};
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"];
};
};
};
};
model_group_info_model_group_info_get: {
parameters: {
query?: {
model_group?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
update_public_model_groups_model_group_make_public_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdatePublicModelGroupsRequest"];
};
};
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_useful_links_model_hub_update_useful_links_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateUsefulLinksRequest"];
};
};
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"];
};
};
};
};
model_list_models_get: {
parameters: {
query?: {
return_wildcard_routes?: boolean | null;
team_id?: string | null;
include_model_access_groups?: boolean | null;
only_model_access_groups?: boolean | null;
include_metadata?: boolean | null;
fallback_type?: string | null;
scope?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
model_info_models__model_id__get: {
parameters: {
query?: never;
header?: never;
path: {
model_id: 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"];
};
};
};
};
google_count_tokens_models__model_name__countTokens_post: {
parameters: {
query?: never;
header?: never;
path: {
model_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TokenCountDetailsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
google_generate_content_models__model_name__generateContent_post: {
parameters: {
query?: never;
header?: never;
path: {
model_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"];
};
};
};
};
google_stream_generate_content_models__model_name__streamGenerateContent_post: {
parameters: {
query?: never;
header?: never;
path: {
model_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"];
};
};
};
};
moderations_moderations_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;
};
};
};
};
ocr_ocr_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;
};
};
};
};
claim_onboarding_link_onboarding_claim_token_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["InvitationClaim"];
};
};
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"];
};
};
};
};
onboarding_onboarding_get_token_get: {
parameters: {
query: {
invite_link: string;
};
header?: never;
path?: never;
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"];
};
};
};
};
chat_completion_openai_deployments__model__chat_completions_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Caching
* @default null
*/
caching?: boolean | null;
/**
* Context Window Fallback Dict
* @default null
*/
context_window_fallback_dict?: {
[key: string]: string;
} | null;
/**
* Fallbacks
* @default null
*/
fallbacks?: string[] | null;
/**
* Frequency Penalty
* @default null
*/
frequency_penalty?: number | null;
/**
* Function Call
* @default null
*/
function_call?: string | {
[key: string]: unknown;
} | null;
/**
* Functions
* @default null
*/
functions?: {
[key: string]: unknown;
}[] | null;
/**
* Guardrails
* @default null
*/
guardrails?: string[] | null;
/**
* Logit Bias
* @default null
*/
logit_bias?: {
[key: string]: number;
} | null;
/**
* Logprobs
* @default null
*/
logprobs?: boolean | null;
/**
* Max Tokens
* @default null
*/
max_tokens?: number | null;
/**
* Messages
* @example [
* {
* "content": "Hello, how are you?",
* "role": "user"
* }
* ]
*/
messages: (components["schemas"]["ChatCompletionUserMessage"] | components["schemas"]["ChatCompletionAssistantMessage"] | components["schemas"]["ChatCompletionToolMessage"] | components["schemas"]["ChatCompletionSystemMessage"] | components["schemas"]["ChatCompletionFunctionMessage"] | components["schemas"]["ChatCompletionDeveloperMessage"])[];
/**
* Metadata
* @default null
*/
metadata?: {
[key: string]: unknown;
} | null;
/** Model */
model: string;
/**
* N
* @default null
*/
n?: number | null;
/**
* Num Retries
* @default null
*/
num_retries?: number | null;
/**
* Parallel Tool Calls
* @default null
*/
parallel_tool_calls?: boolean | null;
/**
* Presence Penalty
* @default null
*/
presence_penalty?: number | null;
/**
* Response Format
* @default null
*/
response_format?: {
[key: string]: unknown;
} | null;
/**
* Seed
* @default null
*/
seed?: number | null;
/**
* Service Tier
* @default null
*/
service_tier?: string | null;
/**
* Stop
* @default null
*/
stop?: string | string[] | null;
/**
* Stream
* @default null
*/
stream?: boolean | null;
/**
* Stream Options
* @default null
*/
stream_options?: {
[key: string]: unknown;
} | null;
/**
* Temperature
* @default null
*/
temperature?: number | null;
/**
* Tool Choice
* @default null
*/
tool_choice?: string | {
[key: string]: unknown;
} | null;
/**
* Tools
* @default null
*/
tools?: {
[key: string]: unknown;
}[] | null;
/**
* Top Logprobs
* @default null
*/
top_logprobs?: number | null;
/**
* Top P
* @default null
*/
top_p?: number | null;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
responses: {
/** @description Successful response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description ContentPolicyViolationError */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description AuthenticationError */
401: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description PermissionDeniedError */
403: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description NotFoundError */
404: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description Timeout */
408: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description UnprocessableEntityError */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/**
* @description Unified rate-limit error.
*
* Every rate-limit condition surfaced by litellm — whether it originated from
* an upstream LLM provider, a vendor batch endpoint, or one of litellm's own
* proxy-side limiters (parallel-requests, dynamic-rate, batch-rate, budget,
* max-iterations, etc.) — is raised as an instance of this class.
*
* The :attr:`category` attribute lets callers distinguish the source. See
* :class:`RateLimitErrorCategory` for the available values.
*/
429: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description JSONSchemaValidationError */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description APIConnectionError */
503: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
};
completion_openai_deployments__model__completions_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
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"];
};
};
};
};
embeddings_openai_deployments__model__embeddings_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Api Base
* @default null
*/
api_base?: string | null;
/**
* Api Key
* @default null
*/
api_key?: string | null;
/**
* Api Type
* @default null
*/
api_type?: string | null;
/**
* Api Version
* @default null
*/
api_version?: string | null;
/**
* Caching
* @default false
*/
caching?: boolean;
/**
* Custom Llm Provider
* @default null
*/
custom_llm_provider?: string | {
[key: string]: unknown;
} | null;
/**
* Input
* @default []
*/
input?: string[];
/**
* Litellm Call Id
* @default null
*/
litellm_call_id?: string | null;
/**
* Litellm Logging Obj
* @default null
*/
litellm_logging_obj?: {
[key: string]: unknown;
} | null;
/**
* Logger Fn
* @default null
*/
logger_fn?: string | null;
/** Model */
model: string;
/**
* Timeout
* @default 600
*/
timeout?: number;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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"];
};
};
};
};
image_edit_api_openai_deployments__model__images_edits_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
cookie?: never;
};
requestBody?: {
content: {
"multipart/form-data": components["schemas"]["Body_image_edit_api_openai_deployments__model__images_edits_post"];
};
};
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"];
};
};
};
};
image_generation_openai_deployments__model__images_generations_post: {
parameters: {
query?: never;
header?: never;
path: {
model: string | null;
};
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"];
};
};
};
};
websocket_realtime_websocket_endpoint_get_3: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description WebSocket Protocol Switched */
101: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
proxy_realtime_calls_openai_v1_realtime_calls_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;
};
};
};
};
create_realtime_client_secret_openai_v1_realtime_client_secrets_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"]["RealtimeClientSecretResponse"];
};
};
};
};
responses_api_openai_v1_responses_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;
};
};
};
};
compact_response_openai_v1_responses_compact_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_response_openai_v1_responses__response_id__get: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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_response_openai_v1_responses__response_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
cancel_response_openai_v1_responses__response_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
get_response_input_items_openai_v1_responses__response_id__input_items_get: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
openai_proxy_route_openai__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai_passthrough__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai_passthrough__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai_passthrough__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai_passthrough__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
openai_proxy_route_openai_passthrough__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
get_organization_daily_activity_organization_daily_activity_get: {
parameters: {
query?: {
organization_ids?: string | null;
start_date?: string | null;
end_date?: string | null;
model?: string | null;
api_key?: string | null;
page?: number;
page_size?: number;
exclude_organization_ids?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_organization_organization_delete_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteOrganizationRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_OrganizationTableWithMembers"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
info_organization_organization_info_get: {
parameters: {
query: {
organization_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_OrganizationTableWithMembers"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
deprecated_info_organization_organization_info_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["OrganizationRequest"];
};
};
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_organization_organization_list_get: {
parameters: {
query?: {
/** @description Filter organizations by exact organization_id match */
org_id?: string | null;
/** @description Filter organizations by partial organization_alias match. Supports case-insensitive search. */
org_alias?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_OrganizationTableWithMembers"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
organization_member_add_organization_member_add_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["OrganizationMemberAddRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["OrganizationAddMemberResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
organization_member_delete_organization_member_delete_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["OrganizationMemberDeleteRequest"];
};
};
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"];
};
};
};
};
organization_member_update_organization_member_update_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["OrganizationMemberUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_OrganizationMembershipTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
new_organization_organization_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewOrganizationRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NewOrganizationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_organization_organization_update_patch: {
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"]["LiteLLM_OrganizationTableWithMembers"];
};
};
};
};
get_otel_spans_otel_spans_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_policy_policies_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyCreateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_policy_attachment_policies_attachments_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyAttachmentCreateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyAttachmentDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
estimate_attachment_impact_policies_attachments_estimate_impact_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyAttachmentCreateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AttachmentImpactResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_policy_attachments_policies_attachments_list_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"]["PolicyAttachmentListResponse"];
};
};
};
};
get_policy_attachment_policies_attachments__attachment_id__get: {
parameters: {
query?: never;
header?: never;
path: {
attachment_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyAttachmentDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_policy_attachment_policies_attachments__attachment_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
attachment_id: 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"];
};
};
};
};
compare_policy_versions_policies_compare_get: {
parameters: {
query: {
version_a: string;
version_b: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyVersionCompareResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_policies_policies_list_get: {
parameters: {
query?: {
version_status?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyListDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_all_policy_versions_policies_name__policy_name__all_versions_delete: {
parameters: {
query?: never;
header?: never;
path: {
policy_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_policy_versions_policies_name__policy_name__versions_get: {
parameters: {
query?: never;
header?: never;
path: {
policy_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyVersionListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_policy_version_policies_name__policy_name__versions_post: {
parameters: {
query?: never;
header?: never;
path: {
policy_name: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyVersionCreateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
resolve_policies_for_context_policies_resolve_post: {
parameters: {
query?: {
/** @description Force a DB sync before resolving. Default uses in-memory cache. */
force_sync?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyResolveRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyResolveResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_pipeline_policies_test_pipeline_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PipelineTestRequest"];
};
};
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"];
};
};
};
};
policies_usage_overview_policies_usage_overview_get: {
parameters: {
query?: {
/** @description YYYY-MM-DD */
start_date?: string | null;
/** @description YYYY-MM-DD */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UsageOverviewResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_policy_policies__policy_id__get: {
parameters: {
query?: never;
header?: never;
path: {
policy_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_policy_policies__policy_id__put: {
parameters: {
query?: never;
header?: never;
path: {
policy_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_policy_policies__policy_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
policy_id: 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"];
};
};
};
};
get_resolved_guardrails_policies__policy_id__resolved_guardrails_get: {
parameters: {
query?: never;
header?: never;
path: {
policy_id: 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"];
};
};
};
};
update_policy_version_status_policies__policy_id__status_put: {
parameters: {
query?: never;
header?: never;
path: {
policy_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyVersionStatusUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyDBResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_policy_info_policy_info__policy_name__get: {
parameters: {
query?: never;
header?: never;
path: {
policy_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyInfoResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_policies_policy_list_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"]["PolicyListResponse"];
};
};
};
};
get_policy_templates_policy_templates_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[];
};
};
};
};
enrich_policy_template_policy_templates_enrich_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EnrichTemplateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
enrich_policy_template_stream_policy_templates_enrich_stream_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EnrichTemplateRequest"];
};
};
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"];
};
};
};
};
suggest_policy_templates_policy_templates_suggest_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SuggestTemplatesRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_policy_template_policy_templates_test_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TestPolicyTemplateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TestPolicyTemplateResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_policy_matching_policy_test_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyMatchContext"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyTestResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
validate_policy_policy_validate_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PolicyValidateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PolicyValidationResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_project_project_delete_delete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteProjectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_ProjectTable"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
project_info_project_info_get: {
parameters: {
query: {
project_id: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_ProjectTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_projects_project_list_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"]["LiteLLM_ProjectTable"][];
};
};
};
};
new_project_project_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewProjectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NewProjectResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_project_project_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateProjectRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_ProjectTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_prompt_prompts_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["Prompt"];
};
};
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_prompts_prompts_list_get: {
parameters: {
query?: {
environment?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListPromptsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_prompt_prompts_test_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TestPromptRequest"];
};
};
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_prompt_info_prompts__prompt_id__get: {
parameters: {
query?: {
environment?: string | null;
};
header?: never;
path: {
prompt_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PromptInfoResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_prompt_prompts__prompt_id__put: {
parameters: {
query?: never;
header?: never;
path: {
prompt_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["Prompt"];
};
};
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_prompt_prompts__prompt_id__delete: {
parameters: {
query?: {
environment?: string | null;
};
header?: never;
path: {
prompt_id: 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"];
};
};
};
};
patch_prompt_prompts__prompt_id__patch: {
parameters: {
query?: {
environment?: string | null;
};
header?: never;
path: {
prompt_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PatchPromptRequest"];
};
};
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_prompt_info_prompts__prompt_id__info_get: {
parameters: {
query?: {
environment?: string | null;
};
header?: never;
path: {
prompt_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PromptInfoResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_prompt_versions_prompts__prompt_id__versions_get: {
parameters: {
query?: {
environment?: string | null;
};
header?: never;
path: {
prompt_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListPromptsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
provider_budgets_provider_budgets_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"]["ProviderBudgetResponse"];
};
};
};
};
get_agents_public_agent_hub_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"]["AgentCard"][];
};
};
};
};
get_agent_fields_public_agents_fields_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"]["AgentCreateInfo"][];
};
};
};
};
get_supported_endpoints_public_endpoints_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"]["SupportedEndpointsResponse"];
};
};
};
};
get_litellm_blog_posts_public_litellm_blog_posts_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"]["BlogPostsResponse"];
};
};
};
};
get_litellm_model_cost_map_public_litellm_model_cost_map_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;
};
};
};
};
get_mcp_servers_public_mcp_hub_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"]["MCPPublicServer"][];
};
};
};
};
public_model_hub_public_model_hub_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"]["ModelGroupInfoProxy"][];
};
};
};
};
public_model_hub_info_public_model_hub_info_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"]["PublicModelHubInfo"];
};
};
};
};
get_supported_providers_public_providers_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string[];
};
};
};
};
get_provider_fields_public_providers_fields_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"]["ProviderCreateInfo"][];
};
};
};
};
public_skill_hub_public_skill_hub_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;
};
};
};
};
async_queue_request_queue_chat_completions_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
rag_ingest_rag_ingest_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;
};
};
};
};
rag_query_rag_query_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;
};
};
};
};
websocket_realtime_websocket_endpoint_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description WebSocket Protocol Switched */
101: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
proxy_realtime_calls_realtime_calls_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;
};
};
};
};
create_realtime_client_secret_realtime_client_secrets_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"]["RealtimeClientSecretResponse"];
};
};
};
};
reload_anthropic_beta_headers_reload_anthropic_beta_headers_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;
};
};
};
};
reload_model_cost_map_reload_model_cost_map_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;
};
};
};
};
rerank_rerank_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;
};
};
};
};
websocket_responses_websocket_endpoint_get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description WebSocket Protocol Switched */
101: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
responses_api_responses_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;
};
};
};
};
compact_response_responses_compact_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_response_responses__response_id__get: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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_response_responses__response_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
cancel_response_responses__response_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
get_response_input_items_responses__response_id__input_items_get: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
get_robots_robots_txt_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;
};
};
};
};
get_router_fields_router_fields_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"]["RouterFieldsResponse"];
};
};
};
};
get_router_settings_router_settings_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"]["RouterSettingsResponse"];
};
};
};
};
get_routes_routes_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;
};
};
};
};
schedule_anthropic_beta_headers_reload_schedule_anthropic_beta_headers_reload_post: {
parameters: {
query: {
hours: number;
};
header?: never;
path?: never;
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"];
};
};
};
};
cancel_anthropic_beta_headers_reload_schedule_anthropic_beta_headers_reload_delete: {
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_anthropic_beta_headers_reload_status_schedule_anthropic_beta_headers_reload_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": unknown;
};
};
};
};
schedule_model_cost_map_reload_schedule_model_cost_map_reload_post: {
parameters: {
query: {
hours: number;
};
header?: never;
path?: never;
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"];
};
};
};
};
cancel_model_cost_map_reload_schedule_model_cost_map_reload_delete: {
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_model_cost_map_reload_status_schedule_model_cost_map_reload_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": unknown;
};
};
};
};
get_scim_base_scim_v2_get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
get_groups_scim_v2_Groups_get: {
parameters: {
query?: {
startIndex?: number;
count?: number;
filter?: string | null;
feature?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_group_scim_v2_Groups_post: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SCIMGroup"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMGroup"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_group_scim_v2_Groups__group_id__get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
group_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMGroup"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_group_scim_v2_Groups__group_id__put: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
group_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SCIMGroup"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMGroup"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_group_scim_v2_Groups__group_id__delete: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
group_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
patch_group_scim_v2_Groups__group_id__patch: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
group_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SCIMPatchOp"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMGroup"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_resource_types_scim_v2_ResourceTypes_get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
get_resource_type_scim_v2_ResourceTypes__resource_type_id__get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
resource_type_id: 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"];
};
};
};
};
get_schemas_scim_v2_Schemas_get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
get_schema_scim_v2_Schemas__schema_id__get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
schema_id: 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"];
};
};
};
};
get_service_provider_config_scim_v2_ServiceProviderConfig_get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMServiceProviderConfig"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_users_scim_v2_Users_get: {
parameters: {
query?: {
startIndex?: number;
count?: number;
filter?: string | null;
feature?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_user_scim_v2_Users_post: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SCIMUser"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMUser"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_user_scim_v2_Users__user_id__get: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
user_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMUser"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_user_scim_v2_Users__user_id__put: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
user_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SCIMUser"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMUser"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_user_scim_v2_Users__user_id__delete: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
user_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
patch_user_scim_v2_Users__user_id__patch: {
parameters: {
query?: {
feature?: string | null;
};
header?: never;
path: {
user_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SCIMPatchOp"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SCIMUser"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
search_search_post: {
parameters: {
query?: {
search_tool_name?: string | null;
};
header?: never;
path?: never;
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_search_tools_search_tools_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;
};
};
};
};
search_search__search_tool_name__post: {
parameters: {
query?: never;
header?: never;
path: {
search_tool_name: string | null;
};
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_search_tool_search_tools_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateSearchToolRequest"];
};
};
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_search_tools_search_tools_list_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"]["ListSearchToolsResponse"];
};
};
};
};
test_search_tool_connection_search_tools_test_connection_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TestSearchToolConnectionRequest"];
};
};
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_available_search_providers_search_tools_ui_available_providers_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;
};
};
};
};
get_search_tool_info_search_tools__search_tool_id__get: {
parameters: {
query?: never;
header?: never;
path: {
search_tool_id: 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"];
};
};
};
};
update_search_tool_search_tools__search_tool_id__put: {
parameters: {
query?: never;
header?: never;
path: {
search_tool_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateSearchToolRequest"];
};
};
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_search_tool_search_tools__search_tool_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
search_tool_id: 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"];
};
};
};
};
active_callbacks_settings_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;
};
};
};
};
calculate_spend_spend_calculate_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SpendCalculateRequest"];
};
};
responses: {
/** @description The calculated cost */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
/**
* @description The calculated cost
* @example 0
*/
cost?: number;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
spend_key_fn_spend_keys_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;
};
};
};
};
view_spend_logs_spend_logs_get: {
parameters: {
query?: {
/** @description Get spend logs based on api key */
api_key?: string | null;
/** @description Get spend logs based on user_id */
user_id?: string | null;
/** @description request_id to get spend logs for specific request_id. If none passed then pass spend logs for all requests */
request_id?: string | null;
/** @description Time from which to start viewing key spend */
start_date?: string | null;
/** @description Time till which to view key spend */
end_date?: string | null;
/** @description When start_date and end_date are provided, summarize=true returns aggregated data by date (legacy behavior), summarize=false returns filtered individual logs */
summarize?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
ui_view_session_spend_logs_spend_logs_session_ui_get: {
parameters: {
query: {
/** @description Get all spend logs for a particular session */
session_id: string;
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
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_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
ui_view_spend_logs_spend_logs_ui_get: {
parameters: {
query?: {
/** @description Get spend logs based on api key */
api_key?: string | null;
/** @description Get spend logs based on user_id */
user_id?: string | null;
/** @description request_id to get spend logs for specific request_id */
request_id?: string | null;
/** @description Filter spend logs by team_id */
team_id?: string | null;
/** @description Filter logs with spend greater than or equal to this value */
min_spend?: number | null;
/** @description Filter logs with spend less than or equal to this value */
max_spend?: number | null;
/** @description Time from which to start viewing key spend */
start_date?: string | null;
/** @description Time till which to view key spend */
end_date?: string | null;
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
page_size?: number;
/** @description Filter logs by status (e.g., success, failure) */
status_filter?: string | null;
/** @description Filter logs by model */
model?: string | null;
/** @description Filter logs by model ID (litellm model deployment id) */
model_id?: string | null;
/** @description Filter logs by model group */
model_group?: string | null;
/** @description Filter logs by key alias */
key_alias?: string | null;
/** @description Filter logs by end user */
end_user?: string | null;
/** @description Filter logs by error code (e.g., '404', '500') */
error_code?: string | null;
/** @description Filter logs by error message (partial string match) */
error_message?: string | null;
/** @description Sort logs by field: spend, total_tokens, startTime, endTime, request_duration_ms, model, or ttft_ms */
sort_by?: string;
/** @description Sort order: asc or desc */
sort_order?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
ui_view_request_response_for_request_id_spend_logs_ui__request_id__get: {
parameters: {
query?: {
/** @description Time from which to start viewing key spend */
start_date?: string | null;
/** @description Time till which to view key spend */
end_date?: string | null;
};
header?: never;
path: {
request_id: 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"];
};
};
};
};
ui_view_spend_logs_spend_logs_v2_get: {
parameters: {
query?: {
/** @description Get spend logs based on api key */
api_key?: string | null;
/** @description Get spend logs based on user_id */
user_id?: string | null;
/** @description request_id to get spend logs for specific request_id */
request_id?: string | null;
/** @description Filter spend logs by team_id */
team_id?: string | null;
/** @description Filter logs with spend greater than or equal to this value */
min_spend?: number | null;
/** @description Filter logs with spend less than or equal to this value */
max_spend?: number | null;
/** @description Time from which to start viewing key spend */
start_date?: string | null;
/** @description Time till which to view key spend */
end_date?: string | null;
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
page_size?: number;
/** @description Filter logs by status (e.g., success, failure) */
status_filter?: string | null;
/** @description Filter logs by model */
model?: string | null;
/** @description Filter logs by model ID (litellm model deployment id) */
model_id?: string | null;
/** @description Filter logs by model group */
model_group?: string | null;
/** @description Filter logs by key alias */
key_alias?: string | null;
/** @description Filter logs by end user */
end_user?: string | null;
/** @description Filter logs by error code (e.g., '404', '500') */
error_code?: string | null;
/** @description Filter logs by error message (partial string match) */
error_message?: string | null;
/** @description Sort logs by field: spend, total_tokens, startTime, endTime, request_duration_ms, model, or ttft_ms */
sort_by?: string;
/** @description Sort order: asc or desc */
sort_order?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
view_spend_tags_spend_tags_get: {
parameters: {
query?: {
/** @description Time from which to start viewing key spend */
start_date?: string | null;
/** @description Time till which to view key spend */
end_date?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_SpendLogs"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
spend_user_fn_spend_users_get: {
parameters: {
query?: {
/** @description Get User Table row for user_id */
user_id?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
auth_callback_sso_callback_get: {
parameters: {
query?: {
state?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
cli_sso_complete_sso_cli_complete__login_id__post: {
parameters: {
query?: never;
header?: never;
path: {
login_id: 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"];
};
};
};
};
cli_poll_key_sso_cli_poll__key_id__get: {
parameters: {
query?: {
team_id?: string | null;
};
header?: {
"x-litellm-cli-poll-secret"?: string | null;
};
path: {
key_id: 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"];
};
};
};
};
cli_sso_start_sso_cli_start_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;
};
};
};
};
debug_sso_callback_sso_debug_callback_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;
};
};
};
};
debug_sso_login_sso_debug_login_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;
};
};
};
};
get_ui_settings_sso_get_ui_settings_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;
};
};
};
};
google_login_sso_key_generate_get: {
parameters: {
query?: {
source?: string | null;
key?: string | null;
existing_key?: string | null;
return_to?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
sso_readiness_sso_readiness_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;
};
};
};
};
get_tag_daily_activity_tag_daily_activity_get: {
parameters: {
query?: {
tags?: string | null;
start_date?: string | null;
end_date?: string | null;
model?: string | null;
api_key?: string | null;
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"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_daily_active_users_tag_dau_get: {
parameters: {
query?: {
/** @description Filter by specific tag (optional) */
tag_filter?: string | null;
/** @description Filter by multiple specific tags (optional, takes precedence over tag_filter) */
tag_filters?: string[] | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ActiveUsersAnalyticsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_tag_tag_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TagDeleteRequest"];
};
};
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_distinct_user_agent_tags_tag_distinct_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"]["DistinctTagsResponse"];
};
};
};
};
info_tag_tag_info_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TagInfoRequest"];
};
};
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_tags_tag_list_get: {
parameters: {
query?: {
/** @description Optional start date (YYYY-MM-DD). When provided together with end_date, dynamic tags are limited to those active in the window. Stored tags are always returned. */
start_date?: string | null;
/** @description Optional end date (YYYY-MM-DD). Must be given with start_date. */
end_date?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
get_monthly_active_users_tag_mau_get: {
parameters: {
query?: {
/** @description Filter by specific tag (optional) */
tag_filter?: string | null;
/** @description Filter by multiple specific tags (optional, takes precedence over tag_filter) */
tag_filters?: string[] | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ActiveUsersAnalyticsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
new_tag_tag_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TagNewRequest"];
};
};
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_tag_summary_tag_summary_get: {
parameters: {
query: {
/** @description Start date in YYYY-MM-DD format */
start_date: string;
/** @description End date in YYYY-MM-DD format */
end_date: string;
/** @description Filter by specific tag (optional) */
tag_filter?: string | null;
/** @description Filter by multiple specific tags (optional, takes precedence over tag_filter) */
tag_filters?: string[] | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TagSummaryResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_tag_tag_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TagUpdateRequest"];
};
};
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_per_user_analytics_tag_user_agent_per_user_analytics_get: {
parameters: {
query?: {
/** @description Filter by specific tag (optional) */
tag_filter?: string | null;
/** @description Filter by multiple specific tags (optional, takes precedence over tag_filter) */
tag_filters?: string[] | null;
/** @description Page number for pagination */
page?: number;
/** @description Items per page */
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"]["PerUserAnalyticsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_weekly_active_users_tag_wau_get: {
parameters: {
query?: {
/** @description Filter by specific tag (optional) */
tag_filter?: string | null;
/** @description Filter by multiple specific tags (optional, takes precedence over tag_filter) */
tag_filters?: string[] | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ActiveUsersAnalyticsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_available_teams_team_available_get: {
parameters: {
query?: {
response_model?: unknown;
};
header?: never;
path?: never;
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"];
};
};
};
};
block_team_team_block_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockTeamRequest"];
};
};
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"];
};
};
};
};
bulk_team_member_add_team_bulk_member_add_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkTeamMemberAddRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BulkTeamMemberAddResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_team_daily_activity_team_daily_activity_get: {
parameters: {
query?: {
team_ids?: string | null;
start_date?: string | null;
end_date?: string | null;
model?: string | null;
api_key?: string | null;
page?: number;
page_size?: number;
exclude_team_ids?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_team_team_delete_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteTeamRequest"];
};
};
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"];
};
};
};
};
ui_view_teams_team_filter_ui_get: {
parameters: {
query?: {
/** @description Team ID in the request parameters */
team_id?: string | null;
/** @description Team alias in the request parameters */
team_alias?: string | null;
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
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_TeamTable"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
team_info_team_info_get: {
parameters: {
query?: {
/** @description Team ID in the request parameters */
team_id?: string;
};
header?: never;
path?: never;
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"];
};
};
};
};
bulk_update_team_keys_team_key_bulk_update_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkUpdateTeamKeysRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BulkUpdateKeyResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_team_team_list_get: {
parameters: {
query?: {
/** @description Only return teams which this 'user_id' belongs to */
user_id?: string | null;
organization_id?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
team_member_add_team_member_add_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TeamMemberAddRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TeamAddMemberResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
team_member_delete_team_member_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TeamMemberDeleteRequest"];
};
};
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"];
};
};
};
};
team_member_update_team_member_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TeamMemberUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TeamMemberUpdateResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
team_model_add_team_model_add_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TeamModelAddRequest"];
};
};
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"];
};
};
};
};
team_model_delete_team_model_delete_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TeamModelDeleteRequest"];
};
};
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"];
};
};
};
};
new_team_team_new_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewTeamRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_TeamTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
bulk_update_team_member_permissions_team_permissions_bulk_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkUpdateTeamMemberPermissionsRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BulkUpdateTeamMemberPermissionsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
team_member_permissions_team_permissions_list_get: {
parameters: {
query?: {
/** @description Team ID in the request parameters */
team_id?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetTeamMemberPermissionsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_team_member_permissions_team_permissions_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateTeamMemberPermissionsRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_TeamTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
unblock_team_team_unblock_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BlockTeamRequest"];
};
};
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_team_team_update_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateTeamRequest"];
};
};
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_team_callbacks_team__team_id__callback_get: {
parameters: {
query?: never;
header?: never;
path: {
team_id: 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"];
};
};
};
};
add_team_callbacks_team__team_id__callback_post: {
parameters: {
query?: 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: {
team_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AddTeamCallback"];
};
};
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"];
};
};
};
};
disable_team_logging_team__team_id__disable_logging_post: {
parameters: {
query?: 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: {
team_id: 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"];
};
};
};
};
team_member_me_team__team_id__members_me_get: {
parameters: {
query?: never;
header?: never;
path: {
team_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TeamMemberInfoResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
test_endpoint_test_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_threads_threads_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_thread_threads__thread_id__get: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
get_messages_threads__thread_id__messages_get: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
add_messages_threads__thread_id__messages_post: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
run_thread_threads__thread_id__runs_post: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_get: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_put: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_post: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_delete: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_options: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_head: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
toolset_mcp_route_toolset__toolset_name__mcp_patch: {
parameters: {
query?: never;
header?: never;
path: {
toolset_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"];
};
};
};
};
update_default_team_settings_update_default_team_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DefaultTeamSSOParams"];
};
};
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_internal_user_settings_update_internal_user_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["DefaultInternalUserParams"];
};
};
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_mcp_semantic_filter_settings_update_mcp_semantic_filter_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MCPSemanticFilterSettings"];
};
};
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_sso_settings_update_sso_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SSOConfig"];
};
};
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_ui_settings_update_ui_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
[key: string]: unknown;
};
};
};
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_ui_theme_settings_update_ui_theme_settings_patch: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UIThemeConfig"];
};
};
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"];
};
};
};
};
upload_logo_upload_logo_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_upload_logo_upload_logo_post"];
};
};
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"];
};
};
};
};
usage_ai_chat_usage_ai_chat_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UsageAIChatRequest"];
};
};
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"];
};
};
};
};
ui_get_available_role_user_available_roles_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;
};
};
};
};
available_enterprise_users_user_available_users_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;
};
};
};
};
bulk_user_update_user_bulk_update_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkUpdateUserRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BulkUpdateUserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_user_daily_activity_user_daily_activity_get: {
parameters: {
query?: {
/** @description Start date in YYYY-MM-DD format */
start_date?: string | null;
/** @description End date in YYYY-MM-DD format */
end_date?: string | null;
/** @description Filter by specific model */
model?: string | null;
/** @description Filter by specific API key */
api_key?: string | null;
/** @description Filter by specific user ID. Admins can filter by any user or omit for global view. Non-admins must provide their own user_id. */
user_id?: string | null;
/** @description Page number for pagination */
page?: number;
/** @description Items per page */
page_size?: number;
/** @description Timezone offset in minutes from UTC (e.g., 480 for PST). Matches JavaScript's Date.getTimezoneOffset() convention. */
timezone?: number | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_user_daily_activity_aggregated_user_daily_activity_aggregated_get: {
parameters: {
query?: {
/** @description Start date in YYYY-MM-DD format */
start_date?: string | null;
/** @description End date in YYYY-MM-DD format */
end_date?: string | null;
/** @description Filter by specific model */
model?: string | null;
/** @description Filter by specific API key */
api_key?: string | null;
/** @description Filter by specific user ID. Admins can filter by any user or omit for global view. Non-admins must provide their own user_id. */
user_id?: string | null;
/** @description Timezone offset in minutes from UTC (e.g., 480 for PST). Matches JavaScript's Date.getTimezoneOffset() convention. */
timezone?: number | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SpendAnalyticsPaginatedResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_user_user_delete_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["DeleteUserRequest"];
};
};
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"];
};
};
};
};
ui_view_users_user_filter_ui_get: {
parameters: {
query?: {
/** @description User ID in the request parameters */
user_id?: string | null;
/** @description User email in the request parameters */
user_email?: string | null;
/** @description Team ID — used when a team admin searches for users to add to their team */
team_id?: string | null;
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
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_UserTableFiltered"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
user_info_user_info_get: {
parameters: {
query?: {
/** @description User ID in the request parameters */
user_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserInfoResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_users_user_list_get: {
parameters: {
query?: {
/** @description Filter users by role */
role?: string | null;
/** @description Get list of users by user_ids */
user_ids?: string | null;
/** @description Get list of users by sso_user_id */
sso_user_ids?: string | null;
/** @description Filter users by partial email match */
user_email?: string | null;
/** @description Filter users by team id */
team?: string | null;
/** @description Page number */
page?: number;
/** @description Number of items per page */
page_size?: number;
/** @description Column to sort by (e.g. 'user_id', 'user_email', 'created_at', 'spend') */
sort_by?: string | null;
/** @description Sort order ('asc' or 'desc') */
sort_order?: string;
/** @description Filter users by organization membership. Comma-separated list of org IDs. */
organization_ids?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
new_user_user_new_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewUserRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["NewUserResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
user_update_user_update_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateUserRequest"];
};
};
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"];
};
};
};
};
convert_prompt_file_to_json_utils_dotprompt_json_converter_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_convert_prompt_file_to_json_utils_dotprompt_json_converter_post"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
[key: string]: unknown;
};
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
supported_openai_params_utils_supported_openai_params_get: {
parameters: {
query: {
model: string;
};
header?: never;
path?: never;
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"];
};
};
};
};
test_policies_and_guardrails_utils_test_policies_and_guardrails_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TestPoliciesAndGuardrailsRequest"];
};
};
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"];
};
};
};
};
token_counter_utils_token_counter_post: {
parameters: {
query?: {
call_endpoint?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TokenCountRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TokenCountResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
transform_request_utils_transform_request_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TransformRequestBody"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RawRequestTypedDict"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
invoke_agent_a2a_v1_a2a__agent_id__message_send_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: 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_access_groups_v1_access_group_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"]["AccessGroupResponse"][];
};
};
};
};
create_access_group_v1_access_group_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AccessGroupCreateRequest"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_access_group_v1_access_group__access_group_id__get: {
parameters: {
query?: never;
header?: never;
path: {
access_group_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_access_group_v1_access_group__access_group_id__put: {
parameters: {
query?: never;
header?: never;
path: {
access_group_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AccessGroupUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_access_group_v1_access_group__access_group_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
access_group_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agents_v1_agents_get: {
parameters: {
query?: {
/** @description When true, performs a GET request to each agent's URL. Agents with reachable URLs (HTTP status < 500) and agents without a URL are returned; unreachable agents are filtered out. */
health_check?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentResponse"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_agent_v1_agents_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentConfig"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
make_agents_public_v1_agents_make_public_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MakeAgentsPublicRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentMakePublicResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_agent_by_id_v1_agents__agent_id__get: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_agent_v1_agents__agent_id__put: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AgentConfig"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_agent_v1_agents__agent_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: 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"];
};
};
};
};
patch_agent_v1_agents__agent_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PatchAgentRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
make_agent_public_v1_agents__agent_id__make_public_post: {
parameters: {
query?: never;
header?: never;
path: {
agent_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AgentMakePublicResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_assistants_v1_assistants_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_assistant_v1_assistants_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;
};
};
};
};
delete_assistant_v1_assistants__assistant_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
assistant_id: 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"];
};
};
};
};
audio_speech_v1_audio_speech_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;
};
};
};
};
audio_transcriptions_v1_audio_transcriptions_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_audio_transcriptions_v1_audio_transcriptions_post"];
};
};
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_batches_v1_batches_get: {
parameters: {
query?: {
provider?: string | null;
limit?: number | null;
after?: string | null;
target_model_names?: string | null;
};
header?: never;
path?: never;
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_batch_v1_batches_post: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
retrieve_batch_v1_batches__batch_id__get: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
/** @description The ID of the batch to retrieve */
batch_id: 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"];
};
};
};
};
cancel_batch_v1_batches__batch_id__cancel_post: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
batch_id: 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"];
};
};
};
};
chat_completion_v1_chat_completions_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Caching
* @default null
*/
caching?: boolean | null;
/**
* Context Window Fallback Dict
* @default null
*/
context_window_fallback_dict?: {
[key: string]: string;
} | null;
/**
* Fallbacks
* @default null
*/
fallbacks?: string[] | null;
/**
* Frequency Penalty
* @default null
*/
frequency_penalty?: number | null;
/**
* Function Call
* @default null
*/
function_call?: string | {
[key: string]: unknown;
} | null;
/**
* Functions
* @default null
*/
functions?: {
[key: string]: unknown;
}[] | null;
/**
* Guardrails
* @default null
*/
guardrails?: string[] | null;
/**
* Logit Bias
* @default null
*/
logit_bias?: {
[key: string]: number;
} | null;
/**
* Logprobs
* @default null
*/
logprobs?: boolean | null;
/**
* Max Tokens
* @default null
*/
max_tokens?: number | null;
/**
* Messages
* @example [
* {
* "content": "Hello, how are you?",
* "role": "user"
* }
* ]
*/
messages: (components["schemas"]["ChatCompletionUserMessage"] | components["schemas"]["ChatCompletionAssistantMessage"] | components["schemas"]["ChatCompletionToolMessage"] | components["schemas"]["ChatCompletionSystemMessage"] | components["schemas"]["ChatCompletionFunctionMessage"] | components["schemas"]["ChatCompletionDeveloperMessage"])[];
/**
* Metadata
* @default null
*/
metadata?: {
[key: string]: unknown;
} | null;
/** Model */
model: string;
/**
* N
* @default null
*/
n?: number | null;
/**
* Num Retries
* @default null
*/
num_retries?: number | null;
/**
* Parallel Tool Calls
* @default null
*/
parallel_tool_calls?: boolean | null;
/**
* Presence Penalty
* @default null
*/
presence_penalty?: number | null;
/**
* Response Format
* @default null
*/
response_format?: {
[key: string]: unknown;
} | null;
/**
* Seed
* @default null
*/
seed?: number | null;
/**
* Service Tier
* @default null
*/
service_tier?: string | null;
/**
* Stop
* @default null
*/
stop?: string | string[] | null;
/**
* Stream
* @default null
*/
stream?: boolean | null;
/**
* Stream Options
* @default null
*/
stream_options?: {
[key: string]: unknown;
} | null;
/**
* Temperature
* @default null
*/
temperature?: number | null;
/**
* Tool Choice
* @default null
*/
tool_choice?: string | {
[key: string]: unknown;
} | null;
/**
* Tools
* @default null
*/
tools?: {
[key: string]: unknown;
}[] | null;
/**
* Top Logprobs
* @default null
*/
top_logprobs?: number | null;
/**
* Top P
* @default null
*/
top_p?: number | null;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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"];
};
};
};
};
completion_v1_completions_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
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_containers_v1_containers_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_container_v1_containers_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;
};
};
};
};
retrieve_container_v1_containers__container_id__get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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_container_v1_containers__container_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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"];
};
};
};
};
handler_container_id_v1_containers__container_id__files_get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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"];
};
};
};
};
handler_multipart_upload_v1_containers__container_id__files_post: {
parameters: {
query?: never;
header?: never;
path: {
container_id: 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"];
};
};
};
};
handler_container_file_v1_containers__container_id__files__file_id__get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: string;
file_id: 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"];
};
};
};
};
handler_container_file_v1_containers__container_id__files__file_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
container_id: string;
file_id: 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"];
};
};
};
};
handler_binary_content_v1_containers__container_id__files__file_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
container_id: string;
file_id: 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"];
};
};
};
};
embeddings_v1_embeddings_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Api Base
* @default null
*/
api_base?: string | null;
/**
* Api Key
* @default null
*/
api_key?: string | null;
/**
* Api Type
* @default null
*/
api_type?: string | null;
/**
* Api Version
* @default null
*/
api_version?: string | null;
/**
* Caching
* @default false
*/
caching?: boolean;
/**
* Custom Llm Provider
* @default null
*/
custom_llm_provider?: string | {
[key: string]: unknown;
} | null;
/**
* Input
* @default []
*/
input?: string[];
/**
* Litellm Call Id
* @default null
*/
litellm_call_id?: string | null;
/**
* Litellm Logging Obj
* @default null
*/
litellm_logging_obj?: {
[key: string]: unknown;
} | null;
/**
* Logger Fn
* @default null
*/
logger_fn?: string | null;
/** Model */
model: string;
/**
* Timeout
* @default 600
*/
timeout?: number;
/**
* User
* @default null
*/
user?: string | null;
};
};
};
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_evals_v1_evals_get: {
parameters: {
query?: {
limit?: number | null;
after?: string | null;
before?: string | null;
order?: string | null;
order_by?: string | null;
custom_llm_provider?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListEvalsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_eval_v1_evals_post: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Eval"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_eval_v1_evals__eval_id__get: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Eval"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_eval_v1_evals__eval_id__post: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Eval"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_eval_v1_evals__eval_id__delete: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DeleteEvalResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
cancel_eval_v1_evals__eval_id__cancel_post: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CancelEvalResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_runs_v1_evals__eval_id__runs_get: {
parameters: {
query?: {
limit?: number | null;
after?: string | null;
before?: string | null;
order?: string | null;
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListRunsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_run_v1_evals__eval_id__runs_post: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Run"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_run_v1_evals__eval_id__runs__run_id__get: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
run_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Run"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
cancel_run_v1_evals__eval_id__runs__run_id__post: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
run_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CancelRunResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_run_v1_evals__eval_id__runs__run_id__delete: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
eval_id: string;
run_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RunDeleteResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_files_v1_files_get: {
parameters: {
query?: {
provider?: string | null;
target_model_names?: string | null;
purpose?: string | null;
};
header?: never;
path?: never;
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_file_v1_files_post: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_create_file_v1_files_post"];
};
};
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_file_v1_files__file_id__get: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
file_id: 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_file_v1_files__file_id__delete: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
file_id: 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"];
};
};
};
};
get_file_content_v1_files__file_id__content_get: {
parameters: {
query?: {
provider?: string | null;
};
header?: never;
path: {
file_id: 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_fine_tuning_jobs_v1_fine_tuning_jobs_get: {
parameters: {
query?: {
custom_llm_provider?: ("openai" | "azure") | null;
/** @description Comma separated list of model names to filter by. Example: 'gpt-4o,gpt-4o-mini' */
target_model_names?: string | null;
after?: string | null;
limit?: number | null;
};
header?: never;
path?: never;
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_fine_tuning_job_v1_fine_tuning_jobs_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["LiteLLMFineTuningJobCreate"];
};
};
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"];
};
};
};
};
retrieve_fine_tuning_job_v1_fine_tuning_jobs__fine_tuning_job_id__get: {
parameters: {
query?: {
custom_llm_provider?: ("openai" | "azure") | null;
};
header?: never;
path: {
fine_tuning_job_id: 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"];
};
};
};
};
cancel_fine_tuning_job_v1_fine_tuning_jobs__fine_tuning_job_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
fine_tuning_job_id: 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"];
};
};
};
};
image_edit_api_v1_images_edits_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"multipart/form-data": components["schemas"]["Body_image_edit_api_v1_images_edits_post"];
};
};
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"];
};
};
};
};
image_generation_v1_images_generations_post: {
parameters: {
query?: {
model?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
index_create_v1_indexes_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IndexCreateRequest"];
};
};
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_mcp_access_groups_v1_mcp_access_groups_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;
};
};
};
};
discover_mcp_servers_v1_mcp_discover_get: {
parameters: {
query?: {
/** @description Search filter for server names and descriptions */
query?: string | null;
/** @description Filter by category */
category?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
make_mcp_servers_public_v1_mcp_make_public_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MakeMCPServersPublicRequest"];
};
};
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_client_ip_v1_mcp_network_client_ip_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;
};
};
};
};
get_openapi_registry_v1_mcp_openapi_registry_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;
};
};
};
};
get_mcp_registry_v1_mcp_registry_json_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;
};
};
};
};
fetch_all_mcp_servers_v1_mcp_server_get: {
parameters: {
query?: {
/** @description Filter MCP servers by team scope. When provided, returns only servers the team has access to plus globally available (allow_all_keys) servers. Used by the Create Key UI to show team-scoped MCP servers. */
team_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MCPServerTable"][];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
edit_mcp_server_v1_mcp_server_put: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateMCPServerRequest"];
};
};
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MCPServerTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
add_mcp_server_v1_mcp_server_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewMCPServerRequest"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MCPServerTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
health_check_servers_v1_mcp_server_health_get: {
parameters: {
query?: {
/** @description Server IDs to check. If not provided, checks all accessible servers. */
server_ids?: string[] | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
add_session_mcp_server_v1_mcp_server_oauth_session_post: {
parameters: {
query?: 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;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewMCPServerRequest"];
};
};
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"];
};
};
};
};
register_mcp_server_v1_mcp_server_register_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewMCPServerRequest"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MCPServerTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_mcp_server_submissions_v1_mcp_server_submissions_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"]["MCPSubmissionsSummary"];
};
};
};
};
fetch_mcp_server_v1_mcp_server__server_id__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"]["LiteLLM_MCPServerTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
remove_mcp_server_v1_mcp_server__server_id__delete: {
parameters: {
query?: 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: {
server_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
approve_mcp_server_submission_v1_mcp_server__server_id__approve_put: {
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"]["LiteLLM_MCPServerTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
store_mcp_oauth_user_credential_v1_mcp_server__server_id__oauth_user_credential_post: {
parameters: {
query?: never;
header?: never;
path: {
server_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MCPOAuthUserCredentialRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPOAuthUserCredentialStatus"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_mcp_oauth_user_credential_v1_mcp_server__server_id__oauth_user_credential_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"]["MCPOAuthUserCredentialStatus"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_mcp_oauth_user_credential_status_v1_mcp_server__server_id__oauth_user_credential_status_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"]["MCPOAuthUserCredentialStatus"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
reject_mcp_server_submission_v1_mcp_server__server_id__reject_put: {
parameters: {
query?: never;
header?: never;
path: {
server_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["RejectMCPServerRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MCPServerTable"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
store_mcp_user_credential_v1_mcp_server__server_id__user_credential_post: {
parameters: {
query?: never;
header?: never;
path: {
server_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MCPUserCredentialRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MCPUserCredentialResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_mcp_user_credential_v1_mcp_server__server_id__user_credential_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"]["MCPUserCredentialResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_mcp_tools_v1_mcp_tools_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;
};
};
};
};
fetch_mcp_toolsets_v1_mcp_toolset_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;
};
};
};
};
edit_mcp_toolset_v1_mcp_toolset_put: {
parameters: {
query?: never;
header?: {
"litellm-changed-by"?: string | null;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateMCPToolsetRequest"];
};
};
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"];
};
};
};
};
add_mcp_toolset_v1_mcp_toolset_post: {
parameters: {
query?: never;
header?: {
"litellm-changed-by"?: string | null;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["NewMCPToolsetRequest"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
fetch_mcp_toolset_v1_mcp_toolset__toolset_id__get: {
parameters: {
query?: never;
header?: never;
path: {
toolset_id: 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"];
};
};
};
};
remove_mcp_toolset_v1_mcp_toolset__toolset_id__delete: {
parameters: {
query?: never;
header?: {
"litellm-changed-by"?: string | null;
};
path: {
toolset_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
202: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
list_mcp_user_credentials_v1_mcp_user_credentials_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"]["MCPUserCredentialListItem"][];
};
};
};
};
list_memory_v1_memory_get: {
parameters: {
query?: {
/** @description Filter by exact key match. */
key?: string | null;
/** @description Filter by key prefix (Redis-style namespace scan). Mutually exclusive with `key`; if both are provided, `key_prefix` wins. */
key_prefix?: string | null;
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"]["MemoryListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_memory_v1_memory_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MemoryCreateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MemoryRow"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_memory_v1_memory__key__get: {
parameters: {
query?: never;
header?: never;
path: {
key: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MemoryRow"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
upsert_memory_v1_memory__key__put: {
parameters: {
query?: never;
header?: never;
path: {
key: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MemoryUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_MemoryRow"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_memory_v1_memory__key__delete: {
parameters: {
query?: never;
header?: never;
path: {
key: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["MemoryDeleteResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
anthropic_response_v1_messages_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;
};
};
};
};
count_tokens_v1_messages_count_tokens_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;
};
};
};
};
model_info_v1_v1_model_info_get: {
parameters: {
query?: {
litellm_model_id?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
model_list_v1_models_get: {
parameters: {
query?: {
return_wildcard_routes?: boolean | null;
team_id?: string | null;
include_model_access_groups?: boolean | null;
only_model_access_groups?: boolean | null;
include_metadata?: boolean | null;
fallback_type?: string | null;
scope?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
model_info_v1_models__model_id__get: {
parameters: {
query?: never;
header?: never;
path: {
model_id: 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"];
};
};
};
};
moderations_v1_moderations_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;
};
};
};
};
ocr_v1_ocr_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;
};
};
};
};
rag_ingest_v1_rag_ingest_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;
};
};
};
};
rag_query_v1_rag_query_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;
};
};
};
};
websocket_realtime_websocket_endpoint_get_2: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description WebSocket Protocol Switched */
101: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
proxy_realtime_calls_v1_realtime_calls_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;
};
};
};
};
create_realtime_client_secret_v1_realtime_client_secrets_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"]["RealtimeClientSecretResponse"];
};
};
};
};
rerank_v1_rerank_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;
};
};
};
};
websocket_responses_websocket_endpoint_get_2: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description WebSocket Protocol Switched */
101: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
responses_api_v1_responses_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;
};
};
};
};
compact_response_v1_responses_compact_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_response_v1_responses__response_id__get: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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_response_v1_responses__response_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
cancel_response_v1_responses__response_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
get_response_input_items_v1_responses__response_id__input_items_get: {
parameters: {
query?: never;
header?: never;
path: {
response_id: 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"];
};
};
};
};
search_v1_search_post: {
parameters: {
query?: {
search_tool_name?: string | null;
};
header?: never;
path?: never;
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_search_tools_v1_search_tools_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;
};
};
};
};
search_v1_search__search_tool_name__post: {
parameters: {
query?: never;
header?: never;
path: {
search_tool_name: string | null;
};
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_skills_v1_skills_get: {
parameters: {
query?: {
limit?: number | null;
after_id?: string | null;
before_id?: string | null;
custom_llm_provider?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ListSkillsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_skill_v1_skills_post: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Skill"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_skill_v1_skills__skill_id__get: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
skill_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["Skill"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_skill_v1_skills__skill_id__delete: {
parameters: {
query?: {
custom_llm_provider?: string | null;
};
header?: never;
path: {
skill_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DeleteSkillResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
create_threads_v1_threads_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_thread_v1_threads__thread_id__get: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
get_messages_v1_threads__thread_id__messages_get: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
add_messages_v1_threads__thread_id__messages_post: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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"];
};
};
};
};
run_thread_v1_threads__thread_id__runs_post: {
parameters: {
query?: never;
header?: never;
path: {
thread_id: 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_tools_v1_tool_list_get: {
parameters: {
query?: {
input_policy?: ("trusted" | "untrusted" | "blocked") | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ToolListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_tool_policy_v1_tool_policy_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ToolPolicyUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ToolPolicyUpdateResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_tool_policy_options_v1_tool_policy_options_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"]["ToolPolicyOptionsResponse"];
};
};
};
};
get_tool_v1_tool__tool_name__get: {
parameters: {
query?: never;
header?: never;
path: {
tool_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["LiteLLM_ToolTableRow"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_tool_detail_v1_tool__tool_name__detail_get: {
parameters: {
query?: never;
header?: never;
path: {
tool_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ToolDetailResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_tool_usage_logs_v1_tool__tool_name__logs_get: {
parameters: {
query?: {
page?: number;
page_size?: number;
/** @description YYYY-MM-DD */
start_date?: string | null;
/** @description YYYY-MM-DD */
end_date?: string | null;
};
header?: never;
path: {
tool_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ToolUsageLogsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_tool_policy_override_v1_tool__tool_name__overrides_delete: {
parameters: {
query?: {
/** @description Team ID of the override to remove */
team_id?: string | null;
/** @description Key hash of the override to remove */
key_hash?: string | null;
};
header?: never;
path: {
tool_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_access_groups_v1_unified_access_group_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"]["AccessGroupResponse"][];
};
};
};
};
create_access_group_v1_unified_access_group_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AccessGroupCreateRequest"];
};
};
responses: {
/** @description Successful Response */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_access_group_v1_unified_access_group__access_group_id__get: {
parameters: {
query?: never;
header?: never;
path: {
access_group_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
update_access_group_v1_unified_access_group__access_group_id__put: {
parameters: {
query?: never;
header?: never;
path: {
access_group_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AccessGroupUpdateRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccessGroupResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
delete_access_group_v1_unified_access_group__access_group_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
access_group_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
204: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
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?: {
after?: string | null;
before?: string | null;
limit?: number | null;
order?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
vector_store_create_v1_vector_stores_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;
};
};
};
};
vector_store_retrieve_v1_vector_stores__vector_store_id__get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_update_v1_vector_stores__vector_store_id__post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_delete_v1_vector_stores__vector_store_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_file_list_v1_vector_stores__vector_store_id__files_get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_file_create_v1_vector_stores__vector_store_id__files_post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_file_retrieve_v1_vector_stores__vector_store_id__files__file_id__get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_file_update_v1_vector_stores__vector_store_id__files__file_id__post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_file_delete_v1_vector_stores__vector_store_id__files__file_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_file_content_v1_vector_stores__vector_store_id__files__file_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_search_v1_vector_stores__vector_store_id__search_post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
video_list_v1_videos_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;
};
};
};
};
video_generation_v1_videos_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"multipart/form-data": components["schemas"]["Body_video_generation_v1_videos_post"];
};
};
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"];
};
};
};
};
video_create_character_v1_videos_characters_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_video_create_character_v1_videos_characters_post"];
};
};
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"];
};
};
};
};
video_get_character_v1_videos_characters__character_id__get: {
parameters: {
query?: never;
header?: never;
path: {
character_id: 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"];
};
};
};
};
video_edit_v1_videos_edits_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;
};
};
};
};
video_extension_v1_videos_extensions_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;
};
};
};
};
video_status_v1_videos__video_id__get: {
parameters: {
query?: never;
header?: never;
path: {
video_id: 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"];
};
};
};
};
video_content_v1_videos__video_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
video_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
video_remix_v1_videos__video_id__remix_post: {
parameters: {
query?: never;
header?: never;
path: {
video_id: 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_workflow_runs_v1_workflows_runs_get: {
parameters: {
query?: {
workflow_type?: string | null;
status?: string | null;
limit?: number;
};
header?: never;
path?: never;
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_workflow_run_v1_workflows_runs_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowRunCreateRequest"];
};
};
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_workflow_run_v1_workflows_runs__run_id__get: {
parameters: {
query?: never;
header?: never;
path: {
run_id: 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"];
};
};
};
};
update_workflow_run_v1_workflows_runs__run_id__patch: {
parameters: {
query?: never;
header?: never;
path: {
run_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowRunUpdateRequest"];
};
};
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_workflow_events_v1_workflows_runs__run_id__events_get: {
parameters: {
query?: {
limit?: number;
};
header?: never;
path: {
run_id: 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"];
};
};
};
};
append_workflow_event_v1_workflows_runs__run_id__events_post: {
parameters: {
query?: never;
header?: never;
path: {
run_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowEventCreateRequest"];
};
};
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_workflow_messages_v1_workflows_runs__run_id__messages_get: {
parameters: {
query?: {
limit?: number;
};
header?: never;
path: {
run_id: 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"];
};
};
};
};
append_workflow_message_v1_workflows_runs__run_id__messages_post: {
parameters: {
query?: never;
header?: never;
path: {
run_id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["WorkflowMessageCreateRequest"];
};
};
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;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
get_interaction_v1beta_interactions__interaction_id__get: {
parameters: {
query?: never;
header?: never;
path: {
interaction_id: 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_interaction_v1beta_interactions__interaction_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
interaction_id: 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"];
};
};
};
};
cancel_interaction_v1beta_interactions__interaction_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
interaction_id: 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"];
};
};
};
};
google_count_tokens_v1beta_models__model_name__countTokens_post: {
parameters: {
query?: never;
header?: never;
path: {
model_name: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TokenCountDetailsResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
google_generate_content_v1beta_models__model_name__generateContent_post: {
parameters: {
query?: never;
header?: never;
path: {
model_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"];
};
};
};
};
google_stream_generate_content_v1beta_models__model_name__streamGenerateContent_post: {
parameters: {
query?: never;
header?: never;
path: {
model_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_guardrails_v2_v2_guardrails_list_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"]["ListGuardrailsResponse"];
};
};
};
};
info_key_fn_v2_v2_key_info_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"application/json": components["schemas"]["KeyRequest"] | null;
};
};
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"];
};
};
};
};
login_v2_v2_login_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;
};
};
};
};
model_info_v2_v2_model_info_get: {
parameters: {
query?: {
/** @description Specify the model name (optional) */
model?: string | null;
/** @description Only return models added by this user */
user_models_only?: boolean | null;
/** @description Return all models across all teams user is in. */
include_team_models?: boolean | null;
debug?: boolean | null;
/** @description Page number */
page?: number;
/** @description Page size */
size?: number;
/** @description Search model names (case-insensitive partial match) */
search?: string | null;
/** @description Search for a specific model by its unique ID */
modelId?: string | null;
/** @description Filter models by team ID. Returns models with direct_access=True or teamId in access_via_team_ids */
teamId?: string | null;
/** @description Field to sort by. Options: model_name, created_at, updated_at, costs, status */
sortBy?: string | null;
/** @description Sort order. Options: asc, desc */
sortOrder?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
rerank_v2_rerank_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;
};
};
};
};
list_team_v2_v2_team_list_get: {
parameters: {
query?: {
/** @description Only return teams which this 'user_id' belongs to */
user_id?: string | null;
/** @description Only return teams which this 'organization_id' belongs to */
organization_id?: string | null;
/** @description Only return teams which this 'team_id' belongs to */
team_id?: string | null;
/** @description Only return teams which this 'team_alias' belongs to. Supports partial matching. */
team_alias?: string | null;
/** @description Combined search: matches teams whose 'team_id' equals the value OR whose 'team_alias' contains it (case-insensitive). */
search?: string | null;
/** @description Page number for pagination */
page?: number;
/** @description Number of teams per page */
page_size?: number;
/** @description Column to sort by (e.g. 'team_id', 'team_alias', 'created_at') */
sort_by?: string | null;
/** @description Sort order ('asc' or 'desc') */
sort_order?: string;
/** @description Filter by status (e.g. 'deleted') */
status?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TeamListResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
user_info_v2_v2_user_info_get: {
parameters: {
query?: {
/** @description User ID in the request parameters */
user_id?: string | null;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["UserInfoV2Response"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
login_v3_v3_login_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;
};
};
};
};
login_v3_exchange_v3_login_exchange_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;
};
};
};
};
delete_vantage_settings_vantage_delete_delete: {
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"]["VantageInitResponse"];
};
};
};
};
vantage_dry_run_export_vantage_dry_run_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["VantageDryRunRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["VantageExportResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
vantage_export_vantage_export_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["VantageExportRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["VantageExportResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
init_vantage_settings_vantage_init_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["VantageInitRequest"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["VantageInitResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
get_vantage_settings_vantage_settings_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"]["VantageSettingsView"];
};
};
};
};
update_vantage_settings_vantage_settings_put: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["VantageSettingsUpdate"];
};
};
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["VantageInitResponse"];
};
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
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?: {
after?: string | null;
before?: string | null;
limit?: number | null;
order?: string | null;
};
header?: never;
path?: never;
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"];
};
};
};
};
vector_store_create_vector_stores_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;
};
};
};
};
vector_store_retrieve_vector_stores__vector_store_id__get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_update_vector_stores__vector_store_id__post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_delete_vector_stores__vector_store_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_file_list_vector_stores__vector_store_id__files_get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_file_create_vector_stores__vector_store_id__files_post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vector_store_file_retrieve_vector_stores__vector_store_id__files__file_id__get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_file_update_vector_stores__vector_store_id__files__file_id__post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_file_delete_vector_stores__vector_store_id__files__file_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_file_content_vector_stores__vector_store_id__files__file_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: string;
file_id: 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"];
};
};
};
};
vector_store_search_vector_stores__vector_store_id__search_post: {
parameters: {
query?: never;
header?: never;
path: {
vector_store_id: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__get_2: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__put_2: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__post_2: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__delete_2: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__patch_2: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_discovery_proxy_route_vertex_ai_discovery__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
websocket_vertex_ai_live_passthrough_endpoint: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description WebSocket Protocol Switched */
101: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
vertex_proxy_route_vertex_ai__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vertex_proxy_route_vertex_ai__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
video_list_videos_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;
};
};
};
};
video_generation_videos_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: {
content: {
"multipart/form-data": components["schemas"]["Body_video_generation_videos_post"];
};
};
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"];
};
};
};
};
video_create_character_videos_characters_post: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_video_create_character_videos_characters_post"];
};
};
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"];
};
};
};
};
video_get_character_videos_characters__character_id__get: {
parameters: {
query?: never;
header?: never;
path: {
character_id: 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"];
};
};
};
};
video_edit_videos_edits_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;
};
};
};
};
video_extension_videos_extensions_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;
};
};
};
};
video_status_videos__video_id__get: {
parameters: {
query?: never;
header?: never;
path: {
video_id: 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"];
};
};
};
};
video_content_videos__video_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
video_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successful Response */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation Error */
422: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["HTTPValidationError"];
};
};
};
};
video_remix_videos__video_id__remix_post: {
parameters: {
query?: never;
header?: never;
path: {
video_id: 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"];
};
};
};
};
vllm_proxy_route_vllm__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vllm_proxy_route_vllm__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vllm_proxy_route_vllm__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vllm_proxy_route_vllm__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
vllm_proxy_route_vllm__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
watsonx_proxy_route_watsonx__endpoint__get: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
watsonx_proxy_route_watsonx__endpoint__put: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
watsonx_proxy_route_watsonx__endpoint__post: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
watsonx_proxy_route_watsonx__endpoint__delete: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
watsonx_proxy_route_watsonx__endpoint__patch: {
parameters: {
query?: never;
header?: never;
path: {
endpoint: 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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_get: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_put: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_post: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_delete: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_options: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_head: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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"];
};
};
};
};
dynamic_mcp_route__mcp_server_name__mcp_patch: {
parameters: {
query?: never;
header?: never;
path: {
mcp_server_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_batches__provider__v1_batches_get: {
parameters: {
query?: {
limit?: number | null;
after?: string | null;
target_model_names?: string | null;
};
header?: never;
path: {
provider: string | null;
};
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_batch__provider__v1_batches_post: {
parameters: {
query?: never;
header?: never;
path: {
provider: string | null;
};
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"];
};
};
};
};
retrieve_batch__provider__v1_batches__batch_id__get: {
parameters: {
query?: never;
header?: never;
path: {
provider: string | null;
/** @description The ID of the batch to retrieve */
batch_id: 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"];
};
};
};
};
cancel_batch__provider__v1_batches__batch_id__cancel_post: {
parameters: {
query?: never;
header?: never;
path: {
batch_id: string;
provider: string | null;
};
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_files__provider__v1_files_get: {
parameters: {
query?: {
target_model_names?: string | null;
purpose?: string | null;
};
header?: never;
path: {
provider: string | null;
};
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_file__provider__v1_files_post: {
parameters: {
query?: never;
header?: never;
path: {
provider: string | null;
};
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["Body_create_file__provider__v1_files_post"];
};
};
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_file__provider__v1_files__file_id__get: {
parameters: {
query?: never;
header?: never;
path: {
file_id: string;
provider: string | null;
};
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_file__provider__v1_files__file_id__delete: {
parameters: {
query?: never;
header?: never;
path: {
file_id: string;
provider: string | null;
};
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"];
};
};
};
};
get_file_content__provider__v1_files__file_id__content_get: {
parameters: {
query?: never;
header?: never;
path: {
file_id: string;
provider: string | null;
};
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"];
};
};
};
};
}