/** * Platform * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { BodyTestModelConnectionHealthTestConnectionPost, Service } from '../models/index'; import * as runtime from '../runtime'; export interface LitellmHealthApiHealthEndpointHealthGetRequest { model?: string | null; } export interface LitellmHealthApiHealthServicesEndpointHealthServicesGetRequest { service: Service; } export interface LitellmHealthApiTestModelConnectionHealthTestConnectionPostRequest { bodyTestModelConnectionHealthTestConnectionPost?: BodyTestModelConnectionHealthTestConnectionPost; } /** * */ export declare class LitellmHealthApi extends runtime.BaseAPI { /** * 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, } ``` * Active Callbacks */ activeCallbacksActiveCallbacksGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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, } ``` * Active Callbacks */ activeCallbacksActiveCallbacksGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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, } ``` * Active Callbacks */ activeCallbacksSettingsGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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, } ``` * Active Callbacks */ activeCallbacksSettingsGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 🚨 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. * Health Endpoint */ healthEndpointHealthGetRaw(requestParameters: LitellmHealthApiHealthEndpointHealthGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 🚨 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. * Health Endpoint */ healthEndpointHealthGet(requestParameters?: LitellmHealthApiHealthEndpointHealthGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Unprotected endpoint for checking if worker is alive * Health Liveliness */ healthLivelinessHealthLivelinessGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Unprotected endpoint for checking if worker is alive * Health Liveliness */ healthLivelinessHealthLivelinessGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Unprotected endpoint for checking if worker is alive * Health Liveliness */ healthLivelinessHealthLivenessGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Unprotected endpoint for checking if worker is alive * Health Liveliness */ healthLivelinessHealthLivenessGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Options endpoint for health/liveliness check. * Health Liveliness Options */ healthLivelinessOptionsHealthLivelinessOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Options endpoint for health/liveliness check. * Health Liveliness Options */ healthLivelinessOptionsHealthLivelinessOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Options endpoint for health/liveliness check. * Health Liveliness Options */ healthLivelinessOptionsHealthLivenessOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Options endpoint for health/liveliness check. * Health Liveliness Options */ healthLivelinessOptionsHealthLivenessOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Unprotected endpoint for checking if worker can receive requests * Health Readiness */ healthReadinessHealthReadinessGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Unprotected endpoint for checking if worker can receive requests * Health Readiness */ healthReadinessHealthReadinessGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Options endpoint for health/readiness check. * Health Readiness Options */ healthReadinessOptionsHealthReadinessOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Options endpoint for health/readiness check. * Health Readiness Options */ healthReadinessOptionsHealthReadinessOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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\' ``` * Health Services Endpoint */ healthServicesEndpointHealthServicesGetRaw(requestParameters: LitellmHealthApiHealthServicesEndpointHealthServicesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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\' ``` * Health Services Endpoint */ healthServicesEndpointHealthServicesGet(requestParameters: LitellmHealthApiHealthServicesEndpointHealthServicesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * [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. * Test Endpoint */ testEndpointTestGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * [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. * Test Endpoint */ testEndpointTestGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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 curl -X POST \'http://localhost:4000/health/test_connection\' \\ -H \'Authorization: Bearer sk-1234\' \\ -H \'Content-Type: application/json\' \\ -d \'{ \"litellm_params\": { \"model\": \"gpt-4\", \"custom_llm_provider\": \"azure_ai\", \"litellm_credential_name\": null, \"api_key\": \"6xxxxxxx\", \"api_base\": \"https://litellm8397336933.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-10-21\", }, \"mode\": \"chat\" }\' ``` Returns: dict: A dictionary containing the health check result with either success information or error details. * Test Model Connection */ testModelConnectionHealthTestConnectionPostRaw(requestParameters: LitellmHealthApiTestModelConnectionHealthTestConnectionPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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 curl -X POST \'http://localhost:4000/health/test_connection\' \\ -H \'Authorization: Bearer sk-1234\' \\ -H \'Content-Type: application/json\' \\ -d \'{ \"litellm_params\": { \"model\": \"gpt-4\", \"custom_llm_provider\": \"azure_ai\", \"litellm_credential_name\": null, \"api_key\": \"6xxxxxxx\", \"api_base\": \"https://litellm8397336933.openai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-10-21\", }, \"mode\": \"chat\" }\' ``` Returns: dict: A dictionary containing the health check result with either success information or error details. * Test Model Connection */ testModelConnectionHealthTestConnectionPost(requestParameters?: LitellmHealthApiTestModelConnectionHealthTestConnectionPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }