litellm_client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +741 -0
- data/Rakefile +10 -0
- data/docs/AddTeamCallback.md +22 -0
- data/docs/Annotations.md +15 -0
- data/docs/AnthropicPassThroughApi.md +367 -0
- data/docs/ApiBase.md +15 -0
- data/docs/ApiKey.md +15 -0
- data/docs/ApiVersion.md +15 -0
- data/docs/ApplyGuardrailRequest.md +24 -0
- data/docs/ApplyGuardrailResponse.md +18 -0
- data/docs/AssemblyAIEUPassThroughApi.md +357 -0
- data/docs/AssemblyAIPassThroughApi.md +357 -0
- data/docs/AssistantsApi.md +1141 -0
- data/docs/AudioApi.md +289 -0
- data/docs/AuditLogResponse.md +34 -0
- data/docs/AuditLoggingApi.md +173 -0
- data/docs/AwsAccessKeyId.md +15 -0
- data/docs/AwsRegionName.md +15 -0
- data/docs/AwsSecretAccessKey.md +15 -0
- data/docs/AzurePassThroughApi.md +367 -0
- data/docs/BaseModel.md +15 -0
- data/docs/BatchApi.md +913 -0
- data/docs/BatchSize.md +15 -0
- data/docs/BedrockPassThroughApi.md +367 -0
- data/docs/BlockKeyRequest.md +18 -0
- data/docs/BlockTeamRequest.md +18 -0
- data/docs/BlockUsers.md +18 -0
- data/docs/BodyTestModelConnectionHealthTestConnectionPost.md +20 -0
- data/docs/BreakdownMetrics.md +24 -0
- data/docs/BudgetConfig.md +24 -0
- data/docs/BudgetDeleteRequest.md +18 -0
- data/docs/BudgetDuration.md +15 -0
- data/docs/BudgetManagementApi.md +436 -0
- data/docs/BudgetNewRequest.md +34 -0
- data/docs/BudgetRequest.md +18 -0
- data/docs/BudgetSpendTrackingApi.md +694 -0
- data/docs/Bytes.md +15 -0
- data/docs/CacheControl.md +18 -0
- data/docs/CachePingResponse.md +28 -0
- data/docs/CachingApi.md +421 -0
- data/docs/CallTypes.md +15 -0
- data/docs/ChatCompletionAnnotation.md +20 -0
- data/docs/ChatCompletionAnnotationURLCitation.md +24 -0
- data/docs/ChatCompletionAudioResponse.md +24 -0
- data/docs/ChatCompletionCachedContent.md +18 -0
- data/docs/ChatCompletionRedactedThinkingBlock.md +22 -0
- data/docs/ChatCompletionThinkingBlock.md +24 -0
- data/docs/ChatCompletionTokenLogprob.md +24 -0
- data/docs/ChatCompletionsApi.md +299 -0
- data/docs/ChoiceLogprobs.md +18 -0
- data/docs/Choices.md +26 -0
- data/docs/Choices1Inner.md +26 -0
- data/docs/CoherePassThroughApi.md +367 -0
- data/docs/CompletionsApi.md +299 -0
- data/docs/ConfigurableClientsideAuthParams.md +15 -0
- data/docs/ConfigurableClientsideAuthParamsAnyOfInner.md +18 -0
- data/docs/ConfigurableClientsideParamsCustomAuth.md +18 -0
- data/docs/Content.md +15 -0
- data/docs/Content1.md +15 -0
- data/docs/CreateCredentialItem.md +24 -0
- data/docs/CreateGuardrailRequest.md +18 -0
- data/docs/CreatedAt.md +15 -0
- data/docs/CreatedBy.md +15 -0
- data/docs/CredentialItem.md +22 -0
- data/docs/CredentialManagementApi.md +444 -0
- data/docs/CustomLlmProvider.md +15 -0
- data/docs/CustomLlmProvider1.md +15 -0
- data/docs/CustomerManagementApi.md +508 -0
- data/docs/DailySpendData.md +22 -0
- data/docs/DailySpendMetadata.md +40 -0
- data/docs/DefaultApi.md +811 -0
- data/docs/DefaultInternalUserParams.md +24 -0
- data/docs/DefaultTeamSSOParams.md +26 -0
- data/docs/DefaultTeamSettingsResponse.md +20 -0
- data/docs/DeleteCustomerRequest.md +18 -0
- data/docs/DeleteOrganizationRequest.md +18 -0
- data/docs/DeleteTeamRequest.md +18 -0
- data/docs/DeleteUserRequest.md +18 -0
- data/docs/Deployment.md +22 -0
- data/docs/Description.md +15 -0
- data/docs/Destructivehint.md +15 -0
- data/docs/EmailEvent.md +15 -0
- data/docs/EmailEventSettings.md +20 -0
- data/docs/EmailEventSettingsResponse.md +18 -0
- data/docs/EmailEventSettingsUpdateRequest.md +18 -0
- data/docs/EmailManagementApi.md +217 -0
- data/docs/EmbeddingsApi.md +299 -0
- data/docs/Endtime.md +15 -0
- data/docs/ErrorResponse.md +18 -0
- data/docs/Expires.md +15 -0
- data/docs/FilesApi.md +1165 -0
- data/docs/FineTuningApi.md +607 -0
- data/docs/FunctionCall.md +20 -0
- data/docs/GenerateKeyRequest.md +74 -0
- data/docs/GenerateKeyResponse.md +88 -0
- data/docs/GetTeamMemberPermissionsResponse.md +22 -0
- data/docs/GoogleAIStudioPassThroughApi.md +332 -0
- data/docs/Guardrail.md +28 -0
- data/docs/GuardrailInfoLiteLLMParamsResponse.md +24 -0
- data/docs/GuardrailInfoResponse.md +30 -0
- data/docs/GuardrailsApi.md +791 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/HealthApi.md +820 -0
- data/docs/Hyperparameters.md +22 -0
- data/docs/IPAddress.md +18 -0
- data/docs/Id.md +15 -0
- data/docs/Idempotenthint.md +15 -0
- data/docs/ImagesApi.md +455 -0
- data/docs/InputCostPerPixel.md +15 -0
- data/docs/InputCostPerSecond.md +15 -0
- data/docs/InputCostPerToken.md +15 -0
- data/docs/Integrations.md +15 -0
- data/docs/InternalUserManagementApi.md +475 -0
- data/docs/InternalUserSettingsResponse.md +20 -0
- data/docs/KeyHealthResponse.md +20 -0
- data/docs/KeyListResponseObject.md +24 -0
- data/docs/KeyListResponseObjectKeysInner.md +134 -0
- data/docs/KeyManagementApi.md +780 -0
- data/docs/KeyMetadata.md +20 -0
- data/docs/KeyMetricWithMetadata.md +20 -0
- data/docs/KeyRequest.md +20 -0
- data/docs/LakeraCategoryThresholds.md +20 -0
- data/docs/LangfusePassThroughApi.md +332 -0
- data/docs/LearningRateMultiplier.md +15 -0
- data/docs/ListGuardrailsResponse.md +18 -0
- data/docs/ListMCPToolsRestAPIResponseObject.md +26 -0
- data/docs/ListMCPToolsRestAPIResponseObjectAnnotations.md +26 -0
- data/docs/ListMCPToolsRestAPIResponseObjectMcpInfo.md +22 -0
- data/docs/LiteLLMBudgetTable.md +32 -0
- data/docs/LiteLLMEndUserTable.md +30 -0
- data/docs/LiteLLMFineTuningJobCreate.md +32 -0
- data/docs/LiteLLMFineTuningJobCreateHyperparameters.md +22 -0
- data/docs/LiteLLMMCPServerTable.md +38 -0
- data/docs/LiteLLMManagedVectorStore.md +32 -0
- data/docs/LiteLLMManagedVectorStoreListResponse.md +26 -0
- data/docs/LiteLLMModelTable.md +26 -0
- data/docs/LiteLLMObjectPermissionBase.md +20 -0
- data/docs/LiteLLMObjectPermissionTable.md +22 -0
- data/docs/LiteLLMOrganizationMembershipTable.md +34 -0
- data/docs/LiteLLMOrganizationTableUpdate.md +32 -0
- data/docs/LiteLLMOrganizationTableWithMembers.md +48 -0
- data/docs/LiteLLMParams.md +88 -0
- data/docs/LiteLLMSpendLogs.md +54 -0
- data/docs/LiteLLMTeamMembership.md +24 -0
- data/docs/LiteLLMTeamTable.md +62 -0
- data/docs/LiteLLMUserTable.md +56 -0
- data/docs/LiteLLMUserTableWithKeyCount.md +58 -0
- data/docs/LiteLLMVerificationToken.md +80 -0
- data/docs/LitellmCredentialName.md +15 -0
- data/docs/LitellmParams.md +92 -0
- data/docs/LitellmTraceId.md +15 -0
- data/docs/LitellmUserRoles.md +15 -0
- data/docs/LlmUtilsApi.md +219 -0
- data/docs/LoggingCallbackStatus.md +22 -0
- data/docs/Logprobs.md +18 -0
- data/docs/MCPInfo.md +22 -0
- data/docs/MaxBudget.md +15 -0
- data/docs/MaxFileSizeMb.md +15 -0
- data/docs/MaxRetries.md +15 -0
- data/docs/McpApi.md +519 -0
- data/docs/Member.md +22 -0
- data/docs/Member1.md +22 -0
- data/docs/Member2.md +22 -0
- data/docs/MergeReasoningContentInChoices.md +15 -0
- data/docs/Message.md +34 -0
- data/docs/MessageAudio.md +24 -0
- data/docs/MessageFunctionCall.md +20 -0
- data/docs/Messages.md +15 -0
- data/docs/MetricWithMetadata.md +20 -0
- data/docs/MistralPassThroughApi.md +367 -0
- data/docs/MockResponse.md +28 -0
- data/docs/Mode.md +15 -0
- data/docs/Mode1.md +15 -0
- data/docs/Model.md +15 -0
- data/docs/ModelAliases.md +15 -0
- data/docs/ModelInfo.md +15 -0
- data/docs/ModelInfoDelete.md +18 -0
- data/docs/ModelManagementApi.md +679 -0
- data/docs/ModelResponse.md +28 -0
- data/docs/ModerationsApi.md +145 -0
- data/docs/NEpochs.md +15 -0
- data/docs/Name.md +15 -0
- data/docs/NewCustomerRequest.md +46 -0
- data/docs/NewMCPServerRequest.md +30 -0
- data/docs/NewOrganizationRequest.md +42 -0
- data/docs/NewOrganizationResponse.md +44 -0
- data/docs/NewTeamRequest.md +52 -0
- data/docs/NewUserRequest.md +76 -0
- data/docs/NewUserResponse.md +96 -0
- data/docs/OpenAIPassThroughApi.md +367 -0
- data/docs/Openworldhint.md +15 -0
- data/docs/OrgMember.md +22 -0
- data/docs/Organization.md +15 -0
- data/docs/OrganizationAddMemberResponse.md +22 -0
- data/docs/OrganizationManagementApi.md +652 -0
- data/docs/OrganizationMemberAddRequest.md +22 -0
- data/docs/OrganizationMemberDeleteRequest.md +22 -0
- data/docs/OrganizationMemberUpdateRequest.md +26 -0
- data/docs/OrganizationRequest.md +18 -0
- data/docs/OutputCostPerPixel.md +15 -0
- data/docs/OutputCostPerSecond.md +15 -0
- data/docs/OutputCostPerToken.md +15 -0
- data/docs/PaginatedAuditLogResponse.md +26 -0
- data/docs/PassThroughApi.md +4562 -0
- data/docs/PassThroughEndpointResponse.md +18 -0
- data/docs/PassThroughGenericEndpoint.md +22 -0
- data/docs/PatchGuardrailLitellmParams.md +20 -0
- data/docs/PatchGuardrailRequest.md +22 -0
- data/docs/PiiAction.md +15 -0
- data/docs/PiiEntityType.md +15 -0
- data/docs/ProviderBudgetResponse.md +18 -0
- data/docs/ProviderBudgetResponseObject.md +24 -0
- data/docs/ProviderSpecificFields.md +15 -0
- data/docs/RawRequestTypedDict.md +24 -0
- data/docs/Readonlyhint.md +15 -0
- data/docs/ReasoningContent.md +15 -0
- data/docs/RegenerateKeyRequest.md +76 -0
- data/docs/RegionName.md +15 -0
- data/docs/RerankApi.md +208 -0
- data/docs/Resources.md +15 -0
- data/docs/Response.md +15 -0
- data/docs/ResponsesApi.md +577 -0
- data/docs/Rpm.md +15 -0
- data/docs/SCIMGroup.md +28 -0
- data/docs/SCIMListResponse.md +26 -0
- data/docs/SCIMMember.md +20 -0
- data/docs/SCIMPatchOp.md +20 -0
- data/docs/SCIMPatchOperation.md +22 -0
- data/docs/SCIMUser.md +36 -0
- data/docs/SCIMUserEmail.md +22 -0
- data/docs/SCIMUserGroup.md +22 -0
- data/docs/SCIMUserName.md +28 -0
- data/docs/SCIMV2Api.md +889 -0
- data/docs/SSOConfig.md +40 -0
- data/docs/SSOSettingsApi.md +430 -0
- data/docs/SSOSettingsResponse.md +20 -0
- data/docs/Seed.md +15 -0
- data/docs/Service.md +15 -0
- data/docs/SpendAnalyticsPaginatedResponse.md +20 -0
- data/docs/SpendCalculateRequest.md +22 -0
- data/docs/SpendMetrics.md +34 -0
- data/docs/Starttime.md +15 -0
- data/docs/StreamTimeout.md +15 -0
- data/docs/Suffix.md +15 -0
- data/docs/SystemFingerprint.md +15 -0
- data/docs/TagConfig.md +30 -0
- data/docs/TagDeleteRequest.md +18 -0
- data/docs/TagInfoRequest.md +18 -0
- data/docs/TagManagementApi.md +450 -0
- data/docs/TagNewRequest.md +24 -0
- data/docs/TagUpdateRequest.md +24 -0
- data/docs/TeamAddMemberResponse.md +66 -0
- data/docs/TeamId.md +15 -0
- data/docs/TeamListResponse.md +26 -0
- data/docs/TeamManagementApi.md +1433 -0
- data/docs/TeamMemberAddRequest.md +22 -0
- data/docs/TeamMemberDeleteRequest.md +22 -0
- data/docs/TeamMemberUpdateRequest.md +26 -0
- data/docs/TeamMemberUpdateResponse.md +24 -0
- data/docs/TeamModelAddRequest.md +20 -0
- data/docs/TeamModelDeleteRequest.md +20 -0
- data/docs/TeamPublicModelName.md +15 -0
- data/docs/ThinkingBlocks.md +15 -0
- data/docs/ThinkingBlocksAnyOfInner.md +26 -0
- data/docs/Tier.md +15 -0
- data/docs/Timeout.md +15 -0
- data/docs/Title.md +15 -0
- data/docs/TokenCountRequest.md +22 -0
- data/docs/TokenCountResponse.md +24 -0
- data/docs/ToolAnnotations.md +26 -0
- data/docs/ToolCalls.md +15 -0
- data/docs/TopLogprob.md +22 -0
- data/docs/Tpm.md +15 -0
- data/docs/TransformRequestBody.md +20 -0
- data/docs/UiDiscoveryEndpoints.md +20 -0
- data/docs/UpdateCustomerRequest.md +30 -0
- data/docs/UpdateDeployment.md +22 -0
- data/docs/UpdateGuardrailRequest.md +18 -0
- data/docs/UpdateKeyRequest.md +74 -0
- data/docs/UpdateLiteLLMParams.md +88 -0
- data/docs/UpdateMCPServerRequest.md +30 -0
- data/docs/UpdateTeamMemberPermissionsRequest.md +20 -0
- data/docs/UpdateTeamRequest.md +44 -0
- data/docs/UpdateUserRequest.md +66 -0
- data/docs/UpdatedAt.md +15 -0
- data/docs/UpdatedBy.md +15 -0
- data/docs/UseInPassThrough.md +15 -0
- data/docs/UseLitellmProxy.md +15 -0
- data/docs/UserAPIKeyAuth.md +134 -0
- data/docs/UserListResponse.md +26 -0
- data/docs/VLLMPassThroughApi.md +367 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorLocInner.md +15 -0
- data/docs/ValidationFile.md +15 -0
- data/docs/VectorStoreDeleteRequest.md +18 -0
- data/docs/VectorStoreManagementApi.md +227 -0
- data/docs/VectorStoreMetadata.md +15 -0
- data/docs/VertexAIPassThroughApi.md +692 -0
- data/docs/VertexCredentials.md +15 -0
- data/docs/VertexLocation.md +15 -0
- data/docs/VertexProject.md +15 -0
- data/docs/WatsonxRegionName.md +15 -0
- data/git_push.sh +57 -0
- data/lib/litellm_client/api/anthropic_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/assembly_ai_pass_through_api.rb +327 -0
- data/lib/litellm_client/api/assembly_aieu_pass_through_api.rb +327 -0
- data/lib/litellm_client/api/assistants_api.rb +994 -0
- data/lib/litellm_client/api/audio_api.rb +274 -0
- data/lib/litellm_client/api/audit_logging_api.rb +187 -0
- data/lib/litellm_client/api/azure_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/batch_api.rb +792 -0
- data/lib/litellm_client/api/bedrock_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/budget_management_api.rb +415 -0
- data/lib/litellm_client/api/budget_spend_tracking_api.rb +649 -0
- data/lib/litellm_client/api/caching_api.rb +364 -0
- data/lib/litellm_client/api/chat_completions_api.rb +260 -0
- data/lib/litellm_client/api/cohere_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/completions_api.rb +260 -0
- data/lib/litellm_client/api/credential_management_api.rb +415 -0
- data/lib/litellm_client/api/customer_management_api.rb +483 -0
- data/lib/litellm_client/api/default_api.rb +728 -0
- data/lib/litellm_client/api/email_management_api.rb +204 -0
- data/lib/litellm_client/api/embeddings_api.rb +260 -0
- data/lib/litellm_client/api/files_api.rb +1064 -0
- data/lib/litellm_client/api/fine_tuning_api.rb +570 -0
- data/lib/litellm_client/api/google_ai_studio_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/guardrails_api.rb +723 -0
- data/lib/litellm_client/api/health_api.rb +723 -0
- data/lib/litellm_client/api/images_api.rb +419 -0
- data/lib/litellm_client/api/internal_user_management_api.rb +472 -0
- data/lib/litellm_client/api/key_management_api.rb +735 -0
- data/lib/litellm_client/api/langfuse_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/llm_utils_api.rb +218 -0
- data/lib/litellm_client/api/mcp_api.rb +467 -0
- data/lib/litellm_client/api/mistral_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/model_management_api.rb +618 -0
- data/lib/litellm_client/api/moderations_api.rb +136 -0
- data/lib/litellm_client/api/open_ai_pass_through_api.rb +337 -0
- data/lib/litellm_client/api/organization_management_api.rb +619 -0
- data/lib/litellm_client/api/pass_through_api.rb +4097 -0
- data/lib/litellm_client/api/rerank_api.rb +187 -0
- data/lib/litellm_client/api/responses_api.rb +514 -0
- data/lib/litellm_client/api/scimv2_api.rb +862 -0
- data/lib/litellm_client/api/sso_settings_api.rb +397 -0
- data/lib/litellm_client/api/tag_management_api.rb +429 -0
- data/lib/litellm_client/api/team_management_api.rb +1339 -0
- data/lib/litellm_client/api/vector_store_management_api.rb +221 -0
- data/lib/litellm_client/api/vertex_ai_pass_through_api.rb +652 -0
- data/lib/litellm_client/api/vllm_pass_through_api.rb +337 -0
- data/lib/litellm_client/api_client.rb +393 -0
- data/lib/litellm_client/api_error.rb +58 -0
- data/lib/litellm_client/configuration.rb +308 -0
- data/lib/litellm_client/models/add_team_callback.rb +309 -0
- data/lib/litellm_client/models/annotations.rb +104 -0
- data/lib/litellm_client/models/api_base.rb +104 -0
- data/lib/litellm_client/models/api_key.rb +104 -0
- data/lib/litellm_client/models/api_version.rb +104 -0
- data/lib/litellm_client/models/apply_guardrail_request.rb +285 -0
- data/lib/litellm_client/models/apply_guardrail_response.rb +237 -0
- data/lib/litellm_client/models/audit_log_response.rb +418 -0
- data/lib/litellm_client/models/aws_access_key_id.rb +104 -0
- data/lib/litellm_client/models/aws_region_name.rb +104 -0
- data/lib/litellm_client/models/aws_secret_access_key.rb +104 -0
- data/lib/litellm_client/models/base_model.rb +104 -0
- data/lib/litellm_client/models/batch_size.rb +104 -0
- data/lib/litellm_client/models/block_key_request.rb +237 -0
- data/lib/litellm_client/models/block_team_request.rb +237 -0
- data/lib/litellm_client/models/block_users.rb +239 -0
- data/lib/litellm_client/models/body_test_model_connection_health_test_connection_post.rb +267 -0
- data/lib/litellm_client/models/breakdown_metrics.rb +256 -0
- data/lib/litellm_client/models/budget_config.rb +251 -0
- data/lib/litellm_client/models/budget_delete_request.rb +237 -0
- data/lib/litellm_client/models/budget_duration.rb +104 -0
- data/lib/litellm_client/models/budget_new_request.rb +303 -0
- data/lib/litellm_client/models/budget_request.rb +239 -0
- data/lib/litellm_client/models/bytes.rb +104 -0
- data/lib/litellm_client/models/cache_control.rb +104 -0
- data/lib/litellm_client/models/cache_ping_response.rb +305 -0
- data/lib/litellm_client/models/call_types.rb +102 -0
- data/lib/litellm_client/models/chat_completion_annotation.rb +263 -0
- data/lib/litellm_client/models/chat_completion_annotation_url_citation.rb +247 -0
- data/lib/litellm_client/models/chat_completion_audio_response.rb +315 -0
- data/lib/litellm_client/models/chat_completion_cached_content.rb +261 -0
- data/lib/litellm_client/models/chat_completion_redacted_thinking_block.rb +280 -0
- data/lib/litellm_client/models/chat_completion_thinking_block.rb +289 -0
- data/lib/litellm_client/models/chat_completion_token_logprob.rb +300 -0
- data/lib/litellm_client/models/choice_logprobs.rb +220 -0
- data/lib/litellm_client/models/choices.rb +307 -0
- data/lib/litellm_client/models/choices1_inner.rb +104 -0
- data/lib/litellm_client/models/configurable_clientside_auth_params.rb +104 -0
- data/lib/litellm_client/models/configurable_clientside_auth_params_any_of_inner.rb +104 -0
- data/lib/litellm_client/models/configurable_clientside_params_custom_auth.rb +237 -0
- data/lib/litellm_client/models/content.rb +104 -0
- data/lib/litellm_client/models/content1.rb +104 -0
- data/lib/litellm_client/models/create_credential_item.rb +287 -0
- data/lib/litellm_client/models/create_guardrail_request.rb +237 -0
- data/lib/litellm_client/models/created_at.rb +104 -0
- data/lib/litellm_client/models/created_by.rb +104 -0
- data/lib/litellm_client/models/credential_item.rb +293 -0
- data/lib/litellm_client/models/custom_llm_provider.rb +104 -0
- data/lib/litellm_client/models/custom_llm_provider1.rb +104 -0
- data/lib/litellm_client/models/daily_spend_data.rb +272 -0
- data/lib/litellm_client/models/daily_spend_metadata.rb +343 -0
- data/lib/litellm_client/models/default_internal_user_params.rb +288 -0
- data/lib/litellm_client/models/default_team_settings_response.rb +268 -0
- data/lib/litellm_client/models/default_team_sso_params.rb +264 -0
- data/lib/litellm_client/models/delete_customer_request.rb +240 -0
- data/lib/litellm_client/models/delete_organization_request.rb +239 -0
- data/lib/litellm_client/models/delete_team_request.rb +239 -0
- data/lib/litellm_client/models/delete_user_request.rb +239 -0
- data/lib/litellm_client/models/deployment.rb +289 -0
- data/lib/litellm_client/models/description.rb +104 -0
- data/lib/litellm_client/models/destructivehint.rb +104 -0
- data/lib/litellm_client/models/email_event.rb +40 -0
- data/lib/litellm_client/models/email_event_settings.rb +285 -0
- data/lib/litellm_client/models/email_event_settings_response.rb +239 -0
- data/lib/litellm_client/models/email_event_settings_update_request.rb +239 -0
- data/lib/litellm_client/models/endtime.rb +104 -0
- data/lib/litellm_client/models/error_response.rb +239 -0
- data/lib/litellm_client/models/expires.rb +104 -0
- data/lib/litellm_client/models/function_call.rb +246 -0
- data/lib/litellm_client/models/generate_key_request.rb +527 -0
- data/lib/litellm_client/models/generate_key_response.rb +613 -0
- data/lib/litellm_client/models/get_team_member_permissions_response.rb +278 -0
- data/lib/litellm_client/models/guardrail.rb +271 -0
- data/lib/litellm_client/models/guardrail_info_lite_llm_params_response.rb +286 -0
- data/lib/litellm_client/models/guardrail_info_response.rb +334 -0
- data/lib/litellm_client/models/http_validation_error.rb +222 -0
- data/lib/litellm_client/models/hyperparameters.rb +241 -0
- data/lib/litellm_client/models/id.rb +104 -0
- data/lib/litellm_client/models/idempotenthint.rb +104 -0
- data/lib/litellm_client/models/input_cost_per_pixel.rb +104 -0
- data/lib/litellm_client/models/input_cost_per_second.rb +104 -0
- data/lib/litellm_client/models/input_cost_per_token.rb +104 -0
- data/lib/litellm_client/models/integrations.rb +104 -0
- data/lib/litellm_client/models/internal_user_settings_response.rb +268 -0
- data/lib/litellm_client/models/ip_address.rb +237 -0
- data/lib/litellm_client/models/key_health_response.rb +264 -0
- data/lib/litellm_client/models/key_list_response_object.rb +252 -0
- data/lib/litellm_client/models/key_list_response_object_keys_inner.rb +104 -0
- data/lib/litellm_client/models/key_metadata.rb +232 -0
- data/lib/litellm_client/models/key_metric_with_metadata.rb +247 -0
- data/lib/litellm_client/models/key_request.rb +235 -0
- data/lib/litellm_client/models/lakera_category_thresholds.rb +229 -0
- data/lib/litellm_client/models/learning_rate_multiplier.rb +104 -0
- data/lib/litellm_client/models/list_guardrails_response.rb +239 -0
- data/lib/litellm_client/models/list_mcp_tools_rest_api_response_object.rb +293 -0
- data/lib/litellm_client/models/list_mcp_tools_rest_api_response_object_annotations.rb +104 -0
- data/lib/litellm_client/models/list_mcp_tools_rest_api_response_object_mcp_info.rb +104 -0
- data/lib/litellm_client/models/lite_llm_budget_table.rb +294 -0
- data/lib/litellm_client/models/lite_llm_end_user_table.rb +348 -0
- data/lib/litellm_client/models/lite_llm_fine_tuning_job_create.rb +317 -0
- data/lib/litellm_client/models/lite_llm_fine_tuning_job_create_hyperparameters.rb +104 -0
- data/lib/litellm_client/models/lite_llm_managed_vector_store.rb +290 -0
- data/lib/litellm_client/models/lite_llm_managed_vector_store_list_response.rb +296 -0
- data/lib/litellm_client/models/lite_llm_model_table.rb +293 -0
- data/lib/litellm_client/models/lite_llm_object_permission_base.rb +235 -0
- data/lib/litellm_client/models/lite_llm_object_permission_table.rb +262 -0
- data/lib/litellm_client/models/lite_llm_organization_membership_table.rb +367 -0
- data/lib/litellm_client/models/lite_llm_organization_table_update.rb +296 -0
- data/lib/litellm_client/models/lite_llm_organization_table_with_members.rb +477 -0
- data/lib/litellm_client/models/lite_llm_params.rb +553 -0
- data/lib/litellm_client/models/lite_llm_spend_logs.rb +457 -0
- data/lib/litellm_client/models/lite_llm_team_membership.rb +285 -0
- data/lib/litellm_client/models/lite_llm_team_table.rb +466 -0
- data/lib/litellm_client/models/lite_llm_user_table.rb +438 -0
- data/lib/litellm_client/models/lite_llm_user_table_with_key_count.rb +449 -0
- data/lib/litellm_client/models/lite_llm_verification_token.rb +546 -0
- data/lib/litellm_client/models/lite_llmmcp_server_table.rb +424 -0
- data/lib/litellm_client/models/litellm_credential_name.rb +104 -0
- data/lib/litellm_client/models/litellm_params.rb +632 -0
- data/lib/litellm_client/models/litellm_trace_id.rb +104 -0
- data/lib/litellm_client/models/litellm_user_roles.rb +45 -0
- data/lib/litellm_client/models/logging_callback_status.rb +275 -0
- data/lib/litellm_client/models/logprobs.rb +105 -0
- data/lib/litellm_client/models/max_budget.rb +104 -0
- data/lib/litellm_client/models/max_file_size_mb.rb +104 -0
- data/lib/litellm_client/models/max_retries.rb +104 -0
- data/lib/litellm_client/models/mcp_info.rb +240 -0
- data/lib/litellm_client/models/member.rb +281 -0
- data/lib/litellm_client/models/member1.rb +104 -0
- data/lib/litellm_client/models/member2.rb +104 -0
- data/lib/litellm_client/models/merge_reasoning_content_in_choices.rb +104 -0
- data/lib/litellm_client/models/message.rb +384 -0
- data/lib/litellm_client/models/message_audio.rb +104 -0
- data/lib/litellm_client/models/message_function_call.rb +104 -0
- data/lib/litellm_client/models/messages.rb +105 -0
- data/lib/litellm_client/models/metric_with_metadata.rb +248 -0
- data/lib/litellm_client/models/mock_response.rb +106 -0
- data/lib/litellm_client/models/mode.rb +104 -0
- data/lib/litellm_client/models/mode1.rb +105 -0
- data/lib/litellm_client/models/model.rb +104 -0
- data/lib/litellm_client/models/model_aliases.rb +104 -0
- data/lib/litellm_client/models/model_info.rb +104 -0
- data/lib/litellm_client/models/model_info_delete.rb +237 -0
- data/lib/litellm_client/models/model_response.rb +335 -0
- data/lib/litellm_client/models/n_epochs.rb +104 -0
- data/lib/litellm_client/models/name.rb +104 -0
- data/lib/litellm_client/models/new_customer_request.rb +415 -0
- data/lib/litellm_client/models/new_mcp_server_request.rb +357 -0
- data/lib/litellm_client/models/new_organization_request.rb +362 -0
- data/lib/litellm_client/models/new_organization_response.rb +470 -0
- data/lib/litellm_client/models/new_team_request.rb +406 -0
- data/lib/litellm_client/models/new_user_request.rb +570 -0
- data/lib/litellm_client/models/new_user_response.rb +689 -0
- data/lib/litellm_client/models/openworldhint.rb +104 -0
- data/lib/litellm_client/models/org_member.rb +281 -0
- data/lib/litellm_client/models/organization.rb +104 -0
- data/lib/litellm_client/models/organization_add_member_response.rb +293 -0
- data/lib/litellm_client/models/organization_member_add_request.rb +273 -0
- data/lib/litellm_client/models/organization_member_delete_request.rb +257 -0
- data/lib/litellm_client/models/organization_member_update_request.rb +299 -0
- data/lib/litellm_client/models/organization_request.rb +239 -0
- data/lib/litellm_client/models/output_cost_per_pixel.rb +104 -0
- data/lib/litellm_client/models/output_cost_per_second.rb +104 -0
- data/lib/litellm_client/models/output_cost_per_token.rb +104 -0
- data/lib/litellm_client/models/paginated_audit_log_response.rb +348 -0
- data/lib/litellm_client/models/pass_through_endpoint_response.rb +239 -0
- data/lib/litellm_client/models/pass_through_generic_endpoint.rb +294 -0
- data/lib/litellm_client/models/patch_guardrail_litellm_params.rb +233 -0
- data/lib/litellm_client/models/patch_guardrail_request.rb +243 -0
- data/lib/litellm_client/models/pii_action.rb +40 -0
- data/lib/litellm_client/models/pii_entity_type.rb +77 -0
- data/lib/litellm_client/models/provider_budget_response.rb +223 -0
- data/lib/litellm_client/models/provider_budget_response_object.rb +256 -0
- data/lib/litellm_client/models/provider_specific_fields.rb +104 -0
- data/lib/litellm_client/models/raw_request_typed_dict.rb +255 -0
- data/lib/litellm_client/models/readonlyhint.rb +104 -0
- data/lib/litellm_client/models/reasoning_content.rb +104 -0
- data/lib/litellm_client/models/regenerate_key_request.rb +537 -0
- data/lib/litellm_client/models/region_name.rb +104 -0
- data/lib/litellm_client/models/resources.rb +104 -0
- data/lib/litellm_client/models/response.rb +105 -0
- data/lib/litellm_client/models/rpm.rb +104 -0
- data/lib/litellm_client/models/scim_group.rb +309 -0
- data/lib/litellm_client/models/scim_list_response.rb +294 -0
- data/lib/litellm_client/models/scim_member.rb +247 -0
- data/lib/litellm_client/models/scim_patch_op.rb +250 -0
- data/lib/litellm_client/models/scim_patch_operation.rb +257 -0
- data/lib/litellm_client/models/scim_user.rb +368 -0
- data/lib/litellm_client/models/scim_user_email.rb +257 -0
- data/lib/litellm_client/models/scim_user_group.rb +257 -0
- data/lib/litellm_client/models/scim_user_name.rb +303 -0
- data/lib/litellm_client/models/seed.rb +104 -0
- data/lib/litellm_client/models/service.rb +104 -0
- data/lib/litellm_client/models/spend_analytics_paginated_response.rb +248 -0
- data/lib/litellm_client/models/spend_calculate_request.rb +245 -0
- data/lib/litellm_client/models/spend_metrics.rb +310 -0
- data/lib/litellm_client/models/sso_config.rb +332 -0
- data/lib/litellm_client/models/sso_settings_response.rb +268 -0
- data/lib/litellm_client/models/starttime.rb +104 -0
- data/lib/litellm_client/models/stream_timeout.rb +105 -0
- data/lib/litellm_client/models/suffix.rb +104 -0
- data/lib/litellm_client/models/system_fingerprint.rb +104 -0
- data/lib/litellm_client/models/tag_config.rb +333 -0
- data/lib/litellm_client/models/tag_delete_request.rb +237 -0
- data/lib/litellm_client/models/tag_info_request.rb +239 -0
- data/lib/litellm_client/models/tag_new_request.rb +271 -0
- data/lib/litellm_client/models/tag_update_request.rb +271 -0
- data/lib/litellm_client/models/team_add_member_response.rb +522 -0
- data/lib/litellm_client/models/team_id.rb +104 -0
- data/lib/litellm_client/models/team_list_response.rb +344 -0
- data/lib/litellm_client/models/team_member_add_request.rb +273 -0
- data/lib/litellm_client/models/team_member_delete_request.rb +257 -0
- data/lib/litellm_client/models/team_member_update_request.rb +311 -0
- data/lib/litellm_client/models/team_member_update_response.rb +283 -0
- data/lib/litellm_client/models/team_model_add_request.rb +266 -0
- data/lib/litellm_client/models/team_model_delete_request.rb +266 -0
- data/lib/litellm_client/models/team_public_model_name.rb +104 -0
- data/lib/litellm_client/models/thinking_blocks.rb +104 -0
- data/lib/litellm_client/models/thinking_blocks_any_of_inner.rb +104 -0
- data/lib/litellm_client/models/tier.rb +104 -0
- data/lib/litellm_client/models/timeout.rb +105 -0
- data/lib/litellm_client/models/title.rb +104 -0
- data/lib/litellm_client/models/token_count_request.rb +259 -0
- data/lib/litellm_client/models/token_count_response.rb +315 -0
- data/lib/litellm_client/models/tool_annotations.rb +257 -0
- data/lib/litellm_client/models/tool_calls.rb +104 -0
- data/lib/litellm_client/models/top_logprob.rb +272 -0
- data/lib/litellm_client/models/tpm.rb +104 -0
- data/lib/litellm_client/models/transform_request_body.rb +287 -0
- data/lib/litellm_client/models/ui_discovery_endpoints.rb +249 -0
- data/lib/litellm_client/models/update_customer_request.rb +333 -0
- data/lib/litellm_client/models/update_deployment.rb +241 -0
- data/lib/litellm_client/models/update_guardrail_request.rb +237 -0
- data/lib/litellm_client/models/update_key_request.rb +543 -0
- data/lib/litellm_client/models/update_lite_llm_params.rb +535 -0
- data/lib/litellm_client/models/update_mcp_server_request.rb +373 -0
- data/lib/litellm_client/models/update_team_member_permissions_request.rb +266 -0
- data/lib/litellm_client/models/update_team_request.rb +378 -0
- data/lib/litellm_client/models/update_user_request.rb +515 -0
- data/lib/litellm_client/models/updated_at.rb +104 -0
- data/lib/litellm_client/models/updated_by.rb +104 -0
- data/lib/litellm_client/models/use_in_pass_through.rb +104 -0
- data/lib/litellm_client/models/use_litellm_proxy.rb +104 -0
- data/lib/litellm_client/models/user_api_key_auth.rb +861 -0
- data/lib/litellm_client/models/user_list_response.rb +344 -0
- data/lib/litellm_client/models/validation_error.rb +291 -0
- data/lib/litellm_client/models/validation_error_loc_inner.rb +104 -0
- data/lib/litellm_client/models/validation_file.rb +104 -0
- data/lib/litellm_client/models/vector_store_delete_request.rb +237 -0
- data/lib/litellm_client/models/vector_store_metadata.rb +104 -0
- data/lib/litellm_client/models/vertex_credentials.rb +105 -0
- data/lib/litellm_client/models/vertex_location.rb +104 -0
- data/lib/litellm_client/models/vertex_project.rb +104 -0
- data/lib/litellm_client/models/watsonx_region_name.rb +104 -0
- data/lib/litellm_client/version.rb +15 -0
- data/lib/litellm_client.rb +339 -0
- data/litellm_client.gemspec +39 -0
- data/spec/api/anthropic_pass_through_api_spec.rb +95 -0
- data/spec/api/assembly_ai_pass_through_api_spec.rb +90 -0
- data/spec/api/assembly_aieu_pass_through_api_spec.rb +90 -0
- data/spec/api/assistants_api_spec.rb +221 -0
- data/spec/api/audio_api_spec.rb +81 -0
- data/spec/api/audit_logging_api_spec.rb +69 -0
- data/spec/api/azure_pass_through_api_spec.rb +95 -0
- data/spec/api/batch_api_spec.rb +191 -0
- data/spec/api/bedrock_pass_through_api_spec.rb +95 -0
- data/spec/api/budget_management_api_spec.rb +106 -0
- data/spec/api/budget_spend_tracking_api_spec.rb +158 -0
- data/spec/api/caching_api_spec.rb +101 -0
- data/spec/api/chat_completions_api_spec.rb +83 -0
- data/spec/api/cohere_pass_through_api_spec.rb +95 -0
- data/spec/api/completions_api_spec.rb +83 -0
- data/spec/api/credential_management_api_spec.rb +109 -0
- data/spec/api/customer_management_api_spec.rb +118 -0
- data/spec/api/default_api_spec.rb +168 -0
- data/spec/api/email_management_api_spec.rb +69 -0
- data/spec/api/embeddings_api_spec.rb +83 -0
- data/spec/api/files_api_spec.rb +242 -0
- data/spec/api/fine_tuning_api_spec.rb +139 -0
- data/spec/api/google_ai_studio_pass_through_api_spec.rb +95 -0
- data/spec/api/guardrails_api_spec.rb +165 -0
- data/spec/api/health_api_spec.rb +170 -0
- data/spec/api/images_api_spec.rb +110 -0
- data/spec/api/internal_user_management_api_spec.rb +121 -0
- data/spec/api/key_management_api_spec.rb +173 -0
- data/spec/api/langfuse_pass_through_api_spec.rb +95 -0
- data/spec/api/llm_utils_api_spec.rb +69 -0
- data/spec/api/mcp_api_spec.rb +120 -0
- data/spec/api/mistral_pass_through_api_spec.rb +95 -0
- data/spec/api/model_management_api_spec.rb +150 -0
- data/spec/api/moderations_api_spec.rb +57 -0
- data/spec/api/open_ai_pass_through_api_spec.rb +95 -0
- data/spec/api/organization_management_api_spec.rb +142 -0
- data/spec/api/pass_through_api_spec.rb +805 -0
- data/spec/api/rerank_api_spec.rb +65 -0
- data/spec/api/responses_api_spec.rb +129 -0
- data/spec/api/scimv2_api_spec.rb +187 -0
- data/spec/api/sso_settings_api_spec.rb +104 -0
- data/spec/api/tag_management_api_spec.rb +112 -0
- data/spec/api/team_management_api_spec.rb +283 -0
- data/spec/api/vector_store_management_api_spec.rb +72 -0
- data/spec/api/vertex_ai_pass_through_api_spec.rb +155 -0
- data/spec/api/vllm_pass_through_api_spec.rb +95 -0
- data/spec/models/add_team_callback_spec.rb +52 -0
- data/spec/models/annotations_spec.rb +21 -0
- data/spec/models/api_base_spec.rb +21 -0
- data/spec/models/api_key_spec.rb +21 -0
- data/spec/models/api_version_spec.rb +21 -0
- data/spec/models/apply_guardrail_request_spec.rb +54 -0
- data/spec/models/apply_guardrail_response_spec.rb +36 -0
- data/spec/models/audit_log_response_spec.rb +84 -0
- data/spec/models/aws_access_key_id_spec.rb +21 -0
- data/spec/models/aws_region_name_spec.rb +21 -0
- data/spec/models/aws_secret_access_key_spec.rb +21 -0
- data/spec/models/base_model_spec.rb +21 -0
- data/spec/models/batch_size_spec.rb +21 -0
- data/spec/models/block_key_request_spec.rb +36 -0
- data/spec/models/block_team_request_spec.rb +36 -0
- data/spec/models/block_users_spec.rb +36 -0
- data/spec/models/body_test_model_connection_health_test_connection_post_spec.rb +46 -0
- data/spec/models/breakdown_metrics_spec.rb +54 -0
- data/spec/models/budget_config_spec.rb +54 -0
- data/spec/models/budget_delete_request_spec.rb +36 -0
- data/spec/models/budget_duration_spec.rb +21 -0
- data/spec/models/budget_new_request_spec.rb +84 -0
- data/spec/models/budget_request_spec.rb +36 -0
- data/spec/models/bytes_spec.rb +21 -0
- data/spec/models/cache_control_spec.rb +21 -0
- data/spec/models/cache_ping_response_spec.rb +66 -0
- data/spec/models/call_types_spec.rb +30 -0
- data/spec/models/chat_completion_annotation_spec.rb +46 -0
- data/spec/models/chat_completion_annotation_url_citation_spec.rb +54 -0
- data/spec/models/chat_completion_audio_response_spec.rb +54 -0
- data/spec/models/chat_completion_cached_content_spec.rb +40 -0
- data/spec/models/chat_completion_redacted_thinking_block_spec.rb +52 -0
- data/spec/models/chat_completion_thinking_block_spec.rb +58 -0
- data/spec/models/chat_completion_token_logprob_spec.rb +54 -0
- data/spec/models/choice_logprobs_spec.rb +36 -0
- data/spec/models/choices1_inner_spec.rb +21 -0
- data/spec/models/choices_spec.rb +60 -0
- data/spec/models/configurable_clientside_auth_params_any_of_inner_spec.rb +21 -0
- data/spec/models/configurable_clientside_auth_params_spec.rb +21 -0
- data/spec/models/configurable_clientside_params_custom_auth_spec.rb +36 -0
- data/spec/models/content1_spec.rb +21 -0
- data/spec/models/content_spec.rb +21 -0
- data/spec/models/create_credential_item_spec.rb +54 -0
- data/spec/models/create_guardrail_request_spec.rb +36 -0
- data/spec/models/created_at_spec.rb +21 -0
- data/spec/models/created_by_spec.rb +21 -0
- data/spec/models/credential_item_spec.rb +48 -0
- data/spec/models/custom_llm_provider1_spec.rb +21 -0
- data/spec/models/custom_llm_provider_spec.rb +21 -0
- data/spec/models/daily_spend_data_spec.rb +48 -0
- data/spec/models/daily_spend_metadata_spec.rb +102 -0
- data/spec/models/default_internal_user_params_spec.rb +58 -0
- data/spec/models/default_team_settings_response_spec.rb +42 -0
- data/spec/models/default_team_sso_params_spec.rb +60 -0
- data/spec/models/delete_customer_request_spec.rb +36 -0
- data/spec/models/delete_organization_request_spec.rb +36 -0
- data/spec/models/delete_team_request_spec.rb +36 -0
- data/spec/models/delete_user_request_spec.rb +36 -0
- data/spec/models/deployment_spec.rb +48 -0
- data/spec/models/description_spec.rb +21 -0
- data/spec/models/destructivehint_spec.rb +21 -0
- data/spec/models/email_event_settings_response_spec.rb +36 -0
- data/spec/models/email_event_settings_spec.rb +42 -0
- data/spec/models/email_event_settings_update_request_spec.rb +36 -0
- data/spec/models/email_event_spec.rb +30 -0
- data/spec/models/endtime_spec.rb +21 -0
- data/spec/models/error_response_spec.rb +36 -0
- data/spec/models/expires_spec.rb +21 -0
- data/spec/models/function_call_spec.rb +42 -0
- data/spec/models/generate_key_request_spec.rb +204 -0
- data/spec/models/generate_key_response_spec.rb +246 -0
- data/spec/models/get_team_member_permissions_response_spec.rb +48 -0
- data/spec/models/guardrail_info_lite_llm_params_response_spec.rb +54 -0
- data/spec/models/guardrail_info_response_spec.rb +76 -0
- data/spec/models/guardrail_spec.rb +66 -0
- data/spec/models/http_validation_error_spec.rb +36 -0
- data/spec/models/hyperparameters_spec.rb +48 -0
- data/spec/models/id_spec.rb +21 -0
- data/spec/models/idempotenthint_spec.rb +21 -0
- data/spec/models/input_cost_per_pixel_spec.rb +21 -0
- data/spec/models/input_cost_per_second_spec.rb +21 -0
- data/spec/models/input_cost_per_token_spec.rb +21 -0
- data/spec/models/integrations_spec.rb +21 -0
- data/spec/models/internal_user_settings_response_spec.rb +42 -0
- data/spec/models/ip_address_spec.rb +36 -0
- data/spec/models/key_health_response_spec.rb +46 -0
- data/spec/models/key_list_response_object_keys_inner_spec.rb +21 -0
- data/spec/models/key_list_response_object_spec.rb +54 -0
- data/spec/models/key_metadata_spec.rb +42 -0
- data/spec/models/key_metric_with_metadata_spec.rb +42 -0
- data/spec/models/key_request_spec.rb +42 -0
- data/spec/models/lakera_category_thresholds_spec.rb +42 -0
- data/spec/models/learning_rate_multiplier_spec.rb +21 -0
- data/spec/models/list_guardrails_response_spec.rb +36 -0
- data/spec/models/list_mcp_tools_rest_api_response_object_annotations_spec.rb +21 -0
- data/spec/models/list_mcp_tools_rest_api_response_object_mcp_info_spec.rb +21 -0
- data/spec/models/list_mcp_tools_rest_api_response_object_spec.rb +60 -0
- data/spec/models/lite_llm_budget_table_spec.rb +78 -0
- data/spec/models/lite_llm_end_user_table_spec.rb +76 -0
- data/spec/models/lite_llm_fine_tuning_job_create_hyperparameters_spec.rb +21 -0
- data/spec/models/lite_llm_fine_tuning_job_create_spec.rb +78 -0
- data/spec/models/lite_llm_managed_vector_store_list_response_spec.rb +64 -0
- data/spec/models/lite_llm_managed_vector_store_spec.rb +78 -0
- data/spec/models/lite_llm_model_table_spec.rb +60 -0
- data/spec/models/lite_llm_object_permission_base_spec.rb +42 -0
- data/spec/models/lite_llm_object_permission_table_spec.rb +48 -0
- data/spec/models/lite_llm_organization_membership_table_spec.rb +84 -0
- data/spec/models/lite_llm_organization_table_update_spec.rb +78 -0
- data/spec/models/lite_llm_organization_table_with_members_spec.rb +126 -0
- data/spec/models/lite_llm_params_spec.rb +246 -0
- data/spec/models/lite_llm_spend_logs_spec.rb +144 -0
- data/spec/models/lite_llm_team_membership_spec.rb +54 -0
- data/spec/models/lite_llm_team_table_spec.rb +168 -0
- data/spec/models/lite_llm_user_table_spec.rb +150 -0
- data/spec/models/lite_llm_user_table_with_key_count_spec.rb +156 -0
- data/spec/models/lite_llm_verification_token_spec.rb +222 -0
- data/spec/models/lite_llmmcp_server_table_spec.rb +108 -0
- data/spec/models/litellm_credential_name_spec.rb +21 -0
- data/spec/models/litellm_params_spec.rb +258 -0
- data/spec/models/litellm_trace_id_spec.rb +21 -0
- data/spec/models/litellm_user_roles_spec.rb +30 -0
- data/spec/models/logging_callback_status_spec.rb +52 -0
- data/spec/models/logprobs_spec.rb +21 -0
- data/spec/models/max_budget_spec.rb +21 -0
- data/spec/models/max_file_size_mb_spec.rb +21 -0
- data/spec/models/max_retries_spec.rb +21 -0
- data/spec/models/mcp_info_spec.rb +48 -0
- data/spec/models/member1_spec.rb +21 -0
- data/spec/models/member2_spec.rb +21 -0
- data/spec/models/member_spec.rb +52 -0
- data/spec/models/merge_reasoning_content_in_choices_spec.rb +21 -0
- data/spec/models/message_audio_spec.rb +21 -0
- data/spec/models/message_function_call_spec.rb +21 -0
- data/spec/models/message_spec.rb +88 -0
- data/spec/models/messages_spec.rb +21 -0
- data/spec/models/metric_with_metadata_spec.rb +42 -0
- data/spec/models/mock_response_spec.rb +21 -0
- data/spec/models/mode1_spec.rb +21 -0
- data/spec/models/mode_spec.rb +21 -0
- data/spec/models/model_aliases_spec.rb +21 -0
- data/spec/models/model_info_delete_spec.rb +36 -0
- data/spec/models/model_info_spec.rb +21 -0
- data/spec/models/model_response_spec.rb +66 -0
- data/spec/models/model_spec.rb +21 -0
- data/spec/models/n_epochs_spec.rb +21 -0
- data/spec/models/name_spec.rb +21 -0
- data/spec/models/new_customer_request_spec.rb +124 -0
- data/spec/models/new_mcp_server_request_spec.rb +84 -0
- data/spec/models/new_organization_request_spec.rb +108 -0
- data/spec/models/new_organization_response_spec.rb +114 -0
- data/spec/models/new_team_request_spec.rb +138 -0
- data/spec/models/new_user_request_spec.rb +214 -0
- data/spec/models/new_user_response_spec.rb +274 -0
- data/spec/models/openworldhint_spec.rb +21 -0
- data/spec/models/org_member_spec.rb +52 -0
- data/spec/models/organization_add_member_response_spec.rb +48 -0
- data/spec/models/organization_member_add_request_spec.rb +48 -0
- data/spec/models/organization_member_delete_request_spec.rb +48 -0
- data/spec/models/organization_member_update_request_spec.rb +60 -0
- data/spec/models/organization_request_spec.rb +36 -0
- data/spec/models/organization_spec.rb +21 -0
- data/spec/models/output_cost_per_pixel_spec.rb +21 -0
- data/spec/models/output_cost_per_second_spec.rb +21 -0
- data/spec/models/output_cost_per_token_spec.rb +21 -0
- data/spec/models/paginated_audit_log_response_spec.rb +60 -0
- data/spec/models/pass_through_endpoint_response_spec.rb +36 -0
- data/spec/models/pass_through_generic_endpoint_spec.rb +48 -0
- data/spec/models/patch_guardrail_litellm_params_spec.rb +42 -0
- data/spec/models/patch_guardrail_request_spec.rb +48 -0
- data/spec/models/pii_action_spec.rb +30 -0
- data/spec/models/pii_entity_type_spec.rb +30 -0
- data/spec/models/provider_budget_response_object_spec.rb +54 -0
- data/spec/models/provider_budget_response_spec.rb +36 -0
- data/spec/models/provider_specific_fields_spec.rb +21 -0
- data/spec/models/raw_request_typed_dict_spec.rb +54 -0
- data/spec/models/readonlyhint_spec.rb +21 -0
- data/spec/models/reasoning_content_spec.rb +21 -0
- data/spec/models/regenerate_key_request_spec.rb +210 -0
- data/spec/models/region_name_spec.rb +21 -0
- data/spec/models/resources_spec.rb +21 -0
- data/spec/models/response_spec.rb +21 -0
- data/spec/models/rpm_spec.rb +21 -0
- data/spec/models/scim_group_spec.rb +66 -0
- data/spec/models/scim_list_response_spec.rb +60 -0
- data/spec/models/scim_member_spec.rb +42 -0
- data/spec/models/scim_patch_op_spec.rb +42 -0
- data/spec/models/scim_patch_operation_spec.rb +48 -0
- data/spec/models/scim_user_email_spec.rb +48 -0
- data/spec/models/scim_user_group_spec.rb +48 -0
- data/spec/models/scim_user_name_spec.rb +66 -0
- data/spec/models/scim_user_spec.rb +90 -0
- data/spec/models/seed_spec.rb +21 -0
- data/spec/models/service_spec.rb +21 -0
- data/spec/models/spend_analytics_paginated_response_spec.rb +42 -0
- data/spec/models/spend_calculate_request_spec.rb +48 -0
- data/spec/models/spend_metrics_spec.rb +84 -0
- data/spec/models/sso_config_spec.rb +102 -0
- data/spec/models/sso_settings_response_spec.rb +42 -0
- data/spec/models/starttime_spec.rb +21 -0
- data/spec/models/stream_timeout_spec.rb +21 -0
- data/spec/models/suffix_spec.rb +21 -0
- data/spec/models/system_fingerprint_spec.rb +21 -0
- data/spec/models/tag_config_spec.rb +72 -0
- data/spec/models/tag_delete_request_spec.rb +36 -0
- data/spec/models/tag_info_request_spec.rb +36 -0
- data/spec/models/tag_new_request_spec.rb +54 -0
- data/spec/models/tag_update_request_spec.rb +54 -0
- data/spec/models/team_add_member_response_spec.rb +180 -0
- data/spec/models/team_id_spec.rb +21 -0
- data/spec/models/team_list_response_spec.rb +60 -0
- data/spec/models/team_member_add_request_spec.rb +48 -0
- data/spec/models/team_member_delete_request_spec.rb +48 -0
- data/spec/models/team_member_update_request_spec.rb +64 -0
- data/spec/models/team_member_update_response_spec.rb +54 -0
- data/spec/models/team_model_add_request_spec.rb +42 -0
- data/spec/models/team_model_delete_request_spec.rb +42 -0
- data/spec/models/team_public_model_name_spec.rb +21 -0
- data/spec/models/thinking_blocks_any_of_inner_spec.rb +21 -0
- data/spec/models/thinking_blocks_spec.rb +21 -0
- data/spec/models/tier_spec.rb +21 -0
- data/spec/models/timeout_spec.rb +21 -0
- data/spec/models/title_spec.rb +21 -0
- data/spec/models/token_count_request_spec.rb +48 -0
- data/spec/models/token_count_response_spec.rb +54 -0
- data/spec/models/tool_annotations_spec.rb +60 -0
- data/spec/models/tool_calls_spec.rb +21 -0
- data/spec/models/top_logprob_spec.rb +48 -0
- data/spec/models/tpm_spec.rb +21 -0
- data/spec/models/transform_request_body_spec.rb +42 -0
- data/spec/models/ui_discovery_endpoints_spec.rb +42 -0
- data/spec/models/update_customer_request_spec.rb +76 -0
- data/spec/models/update_deployment_spec.rb +48 -0
- data/spec/models/update_guardrail_request_spec.rb +36 -0
- data/spec/models/update_key_request_spec.rb +204 -0
- data/spec/models/update_lite_llm_params_spec.rb +246 -0
- data/spec/models/update_mcp_server_request_spec.rb +84 -0
- data/spec/models/update_team_member_permissions_request_spec.rb +42 -0
- data/spec/models/update_team_request_spec.rb +114 -0
- data/spec/models/update_user_request_spec.rb +184 -0
- data/spec/models/updated_at_spec.rb +21 -0
- data/spec/models/updated_by_spec.rb +21 -0
- data/spec/models/use_in_pass_through_spec.rb +21 -0
- data/spec/models/use_litellm_proxy_spec.rb +21 -0
- data/spec/models/user_api_key_auth_spec.rb +388 -0
- data/spec/models/user_list_response_spec.rb +60 -0
- data/spec/models/validation_error_loc_inner_spec.rb +21 -0
- data/spec/models/validation_error_spec.rb +48 -0
- data/spec/models/validation_file_spec.rb +21 -0
- data/spec/models/vector_store_delete_request_spec.rb +36 -0
- data/spec/models/vector_store_metadata_spec.rb +21 -0
- data/spec/models/vertex_credentials_spec.rb +21 -0
- data/spec/models/vertex_location_spec.rb +21 -0
- data/spec/models/vertex_project_spec.rb +21 -0
- data/spec/models/watsonx_region_name_spec.rb +21 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1298 -0
|
@@ -0,0 +1,780 @@
|
|
|
1
|
+
# LiteLLMClient::KeyManagementApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**block_key_key_block_post**](KeyManagementApi.md#block_key_key_block_post) | **POST** /key/block | Block Key |
|
|
8
|
+
| [**delete_key_fn_key_delete_post**](KeyManagementApi.md#delete_key_fn_key_delete_post) | **POST** /key/delete | Delete Key Fn |
|
|
9
|
+
| [**generate_key_fn_key_generate_post**](KeyManagementApi.md#generate_key_fn_key_generate_post) | **POST** /key/generate | Generate Key Fn |
|
|
10
|
+
| [**info_key_fn_key_info_get**](KeyManagementApi.md#info_key_fn_key_info_get) | **GET** /key/info | Info Key Fn |
|
|
11
|
+
| [**key_health_key_health_post**](KeyManagementApi.md#key_health_key_health_post) | **POST** /key/health | Key Health |
|
|
12
|
+
| [**list_keys_key_list_get**](KeyManagementApi.md#list_keys_key_list_get) | **GET** /key/list | List Keys |
|
|
13
|
+
| [**regenerate_key_fn_key_key_regenerate_post**](KeyManagementApi.md#regenerate_key_fn_key_key_regenerate_post) | **POST** /key/{key}/regenerate | Regenerate Key Fn |
|
|
14
|
+
| [**regenerate_key_fn_key_regenerate_post**](KeyManagementApi.md#regenerate_key_fn_key_regenerate_post) | **POST** /key/regenerate | Regenerate Key Fn |
|
|
15
|
+
| [**unblock_key_key_unblock_post**](KeyManagementApi.md#unblock_key_key_unblock_post) | **POST** /key/unblock | Unblock Key |
|
|
16
|
+
| [**update_key_fn_key_update_post**](KeyManagementApi.md#update_key_fn_key_update_post) | **POST** /key/update | Update Key Fn |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## block_key_key_block_post
|
|
20
|
+
|
|
21
|
+
> <LiteLLMVerificationToken> block_key_key_block_post(block_key_request, opts)
|
|
22
|
+
|
|
23
|
+
Block Key
|
|
24
|
+
|
|
25
|
+
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 can block keys.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'time'
|
|
31
|
+
require 'litellm_client'
|
|
32
|
+
# setup authorization
|
|
33
|
+
LiteLLMClient.configure do |config|
|
|
34
|
+
# Configure API key authorization: APIKeyHeader
|
|
35
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
37
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
41
|
+
block_key_request = LiteLLMClient::BlockKeyRequest.new({key: 'key_example'}) # BlockKeyRequest |
|
|
42
|
+
opts = {
|
|
43
|
+
litellm_changed_by: 'litellm_changed_by_example' # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
# Block Key
|
|
48
|
+
result = api_instance.block_key_key_block_post(block_key_request, opts)
|
|
49
|
+
p result
|
|
50
|
+
rescue LiteLLMClient::ApiError => e
|
|
51
|
+
puts "Error when calling KeyManagementApi->block_key_key_block_post: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
#### Using the block_key_key_block_post_with_http_info variant
|
|
56
|
+
|
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
|
58
|
+
|
|
59
|
+
> <Array(<LiteLLMVerificationToken>, Integer, Hash)> block_key_key_block_post_with_http_info(block_key_request, opts)
|
|
60
|
+
|
|
61
|
+
```ruby
|
|
62
|
+
begin
|
|
63
|
+
# Block Key
|
|
64
|
+
data, status_code, headers = api_instance.block_key_key_block_post_with_http_info(block_key_request, opts)
|
|
65
|
+
p status_code # => 2xx
|
|
66
|
+
p headers # => { ... }
|
|
67
|
+
p data # => <LiteLLMVerificationToken>
|
|
68
|
+
rescue LiteLLMClient::ApiError => e
|
|
69
|
+
puts "Error when calling KeyManagementApi->block_key_key_block_post_with_http_info: #{e}"
|
|
70
|
+
end
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
| Name | Type | Description | Notes |
|
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
|
77
|
+
| **block_key_request** | [**BlockKeyRequest**](BlockKeyRequest.md) | | |
|
|
78
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
[**LiteLLMVerificationToken**](LiteLLMVerificationToken.md)
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: application/json
|
|
91
|
+
- **Accept**: application/json
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
## delete_key_fn_key_delete_post
|
|
95
|
+
|
|
96
|
+
> Object delete_key_fn_key_delete_post(key_request, opts)
|
|
97
|
+
|
|
98
|
+
Delete Key Fn
|
|
99
|
+
|
|
100
|
+
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.
|
|
101
|
+
|
|
102
|
+
### Examples
|
|
103
|
+
|
|
104
|
+
```ruby
|
|
105
|
+
require 'time'
|
|
106
|
+
require 'litellm_client'
|
|
107
|
+
# setup authorization
|
|
108
|
+
LiteLLMClient.configure do |config|
|
|
109
|
+
# Configure API key authorization: APIKeyHeader
|
|
110
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
111
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
112
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
116
|
+
key_request = LiteLLMClient::KeyRequest.new # KeyRequest |
|
|
117
|
+
opts = {
|
|
118
|
+
litellm_changed_by: 'litellm_changed_by_example' # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
# Delete Key Fn
|
|
123
|
+
result = api_instance.delete_key_fn_key_delete_post(key_request, opts)
|
|
124
|
+
p result
|
|
125
|
+
rescue LiteLLMClient::ApiError => e
|
|
126
|
+
puts "Error when calling KeyManagementApi->delete_key_fn_key_delete_post: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
#### Using the delete_key_fn_key_delete_post_with_http_info variant
|
|
131
|
+
|
|
132
|
+
This returns an Array which contains the response data, status code and headers.
|
|
133
|
+
|
|
134
|
+
> <Array(Object, Integer, Hash)> delete_key_fn_key_delete_post_with_http_info(key_request, opts)
|
|
135
|
+
|
|
136
|
+
```ruby
|
|
137
|
+
begin
|
|
138
|
+
# Delete Key Fn
|
|
139
|
+
data, status_code, headers = api_instance.delete_key_fn_key_delete_post_with_http_info(key_request, opts)
|
|
140
|
+
p status_code # => 2xx
|
|
141
|
+
p headers # => { ... }
|
|
142
|
+
p data # => Object
|
|
143
|
+
rescue LiteLLMClient::ApiError => e
|
|
144
|
+
puts "Error when calling KeyManagementApi->delete_key_fn_key_delete_post_with_http_info: #{e}"
|
|
145
|
+
end
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
| Name | Type | Description | Notes |
|
|
151
|
+
| ---- | ---- | ----------- | ----- |
|
|
152
|
+
| **key_request** | [**KeyRequest**](KeyRequest.md) | | |
|
|
153
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
**Object**
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: application/json
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
## generate_key_fn_key_generate_post
|
|
170
|
+
|
|
171
|
+
> <GenerateKeyResponse> generate_key_fn_key_generate_post(generate_key_request, opts)
|
|
172
|
+
|
|
173
|
+
Generate Key Fn
|
|
174
|
+
|
|
175
|
+
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 - 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. - 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\"]}. IF null or {} then no object permission. 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.
|
|
176
|
+
|
|
177
|
+
### Examples
|
|
178
|
+
|
|
179
|
+
```ruby
|
|
180
|
+
require 'time'
|
|
181
|
+
require 'litellm_client'
|
|
182
|
+
# setup authorization
|
|
183
|
+
LiteLLMClient.configure do |config|
|
|
184
|
+
# Configure API key authorization: APIKeyHeader
|
|
185
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
186
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
187
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
191
|
+
generate_key_request = LiteLLMClient::GenerateKeyRequest.new # GenerateKeyRequest |
|
|
192
|
+
opts = {
|
|
193
|
+
litellm_changed_by: 'litellm_changed_by_example' # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
begin
|
|
197
|
+
# Generate Key Fn
|
|
198
|
+
result = api_instance.generate_key_fn_key_generate_post(generate_key_request, opts)
|
|
199
|
+
p result
|
|
200
|
+
rescue LiteLLMClient::ApiError => e
|
|
201
|
+
puts "Error when calling KeyManagementApi->generate_key_fn_key_generate_post: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
#### Using the generate_key_fn_key_generate_post_with_http_info variant
|
|
206
|
+
|
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
|
208
|
+
|
|
209
|
+
> <Array(<GenerateKeyResponse>, Integer, Hash)> generate_key_fn_key_generate_post_with_http_info(generate_key_request, opts)
|
|
210
|
+
|
|
211
|
+
```ruby
|
|
212
|
+
begin
|
|
213
|
+
# Generate Key Fn
|
|
214
|
+
data, status_code, headers = api_instance.generate_key_fn_key_generate_post_with_http_info(generate_key_request, opts)
|
|
215
|
+
p status_code # => 2xx
|
|
216
|
+
p headers # => { ... }
|
|
217
|
+
p data # => <GenerateKeyResponse>
|
|
218
|
+
rescue LiteLLMClient::ApiError => e
|
|
219
|
+
puts "Error when calling KeyManagementApi->generate_key_fn_key_generate_post_with_http_info: #{e}"
|
|
220
|
+
end
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
| Name | Type | Description | Notes |
|
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
|
227
|
+
| **generate_key_request** | [**GenerateKeyRequest**](GenerateKeyRequest.md) | | |
|
|
228
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
229
|
+
|
|
230
|
+
### Return type
|
|
231
|
+
|
|
232
|
+
[**GenerateKeyResponse**](GenerateKeyResponse.md)
|
|
233
|
+
|
|
234
|
+
### Authorization
|
|
235
|
+
|
|
236
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
237
|
+
|
|
238
|
+
### HTTP request headers
|
|
239
|
+
|
|
240
|
+
- **Content-Type**: application/json
|
|
241
|
+
- **Accept**: application/json
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
## info_key_fn_key_info_get
|
|
245
|
+
|
|
246
|
+
> Object info_key_fn_key_info_get(opts)
|
|
247
|
+
|
|
248
|
+
Info Key Fn
|
|
249
|
+
|
|
250
|
+
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-02Wr4IAlN3NvPXvL5JVvDA\" -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-02Wr4IAlN3NvPXvL5JVvDA\" ```
|
|
251
|
+
|
|
252
|
+
### Examples
|
|
253
|
+
|
|
254
|
+
```ruby
|
|
255
|
+
require 'time'
|
|
256
|
+
require 'litellm_client'
|
|
257
|
+
# setup authorization
|
|
258
|
+
LiteLLMClient.configure do |config|
|
|
259
|
+
# Configure API key authorization: APIKeyHeader
|
|
260
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
261
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
262
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
266
|
+
opts = {
|
|
267
|
+
key: 'key_example' # String | Key in the request parameters
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# Info Key Fn
|
|
272
|
+
result = api_instance.info_key_fn_key_info_get(opts)
|
|
273
|
+
p result
|
|
274
|
+
rescue LiteLLMClient::ApiError => e
|
|
275
|
+
puts "Error when calling KeyManagementApi->info_key_fn_key_info_get: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the info_key_fn_key_info_get_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(Object, Integer, Hash)> info_key_fn_key_info_get_with_http_info(opts)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# Info Key Fn
|
|
288
|
+
data, status_code, headers = api_instance.info_key_fn_key_info_get_with_http_info(opts)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => Object
|
|
292
|
+
rescue LiteLLMClient::ApiError => e
|
|
293
|
+
puts "Error when calling KeyManagementApi->info_key_fn_key_info_get_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **key** | **String** | Key in the request parameters | [optional] |
|
|
302
|
+
|
|
303
|
+
### Return type
|
|
304
|
+
|
|
305
|
+
**Object**
|
|
306
|
+
|
|
307
|
+
### Authorization
|
|
308
|
+
|
|
309
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
310
|
+
|
|
311
|
+
### HTTP request headers
|
|
312
|
+
|
|
313
|
+
- **Content-Type**: Not defined
|
|
314
|
+
- **Accept**: application/json
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
## key_health_key_health_post
|
|
318
|
+
|
|
319
|
+
> <KeyHealthResponse> key_health_key_health_post
|
|
320
|
+
|
|
321
|
+
Key Health
|
|
322
|
+
|
|
323
|
+
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.\" } } ```
|
|
324
|
+
|
|
325
|
+
### Examples
|
|
326
|
+
|
|
327
|
+
```ruby
|
|
328
|
+
require 'time'
|
|
329
|
+
require 'litellm_client'
|
|
330
|
+
# setup authorization
|
|
331
|
+
LiteLLMClient.configure do |config|
|
|
332
|
+
# Configure API key authorization: APIKeyHeader
|
|
333
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
334
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
335
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
336
|
+
end
|
|
337
|
+
|
|
338
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
339
|
+
|
|
340
|
+
begin
|
|
341
|
+
# Key Health
|
|
342
|
+
result = api_instance.key_health_key_health_post
|
|
343
|
+
p result
|
|
344
|
+
rescue LiteLLMClient::ApiError => e
|
|
345
|
+
puts "Error when calling KeyManagementApi->key_health_key_health_post: #{e}"
|
|
346
|
+
end
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
#### Using the key_health_key_health_post_with_http_info variant
|
|
350
|
+
|
|
351
|
+
This returns an Array which contains the response data, status code and headers.
|
|
352
|
+
|
|
353
|
+
> <Array(<KeyHealthResponse>, Integer, Hash)> key_health_key_health_post_with_http_info
|
|
354
|
+
|
|
355
|
+
```ruby
|
|
356
|
+
begin
|
|
357
|
+
# Key Health
|
|
358
|
+
data, status_code, headers = api_instance.key_health_key_health_post_with_http_info
|
|
359
|
+
p status_code # => 2xx
|
|
360
|
+
p headers # => { ... }
|
|
361
|
+
p data # => <KeyHealthResponse>
|
|
362
|
+
rescue LiteLLMClient::ApiError => e
|
|
363
|
+
puts "Error when calling KeyManagementApi->key_health_key_health_post_with_http_info: #{e}"
|
|
364
|
+
end
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Parameters
|
|
368
|
+
|
|
369
|
+
This endpoint does not need any parameter.
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
[**KeyHealthResponse**](KeyHealthResponse.md)
|
|
374
|
+
|
|
375
|
+
### Authorization
|
|
376
|
+
|
|
377
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
378
|
+
|
|
379
|
+
### HTTP request headers
|
|
380
|
+
|
|
381
|
+
- **Content-Type**: Not defined
|
|
382
|
+
- **Accept**: application/json
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
## list_keys_key_list_get
|
|
386
|
+
|
|
387
|
+
> <KeyListResponseObject> list_keys_key_list_get(opts)
|
|
388
|
+
|
|
389
|
+
List Keys
|
|
390
|
+
|
|
391
|
+
List all keys for a given user / team / organization. Returns: { \"keys\": List[str] or List[UserAPIKeyAuth], \"total_count\": int, \"current_page\": int, \"total_pages\": int, }
|
|
392
|
+
|
|
393
|
+
### Examples
|
|
394
|
+
|
|
395
|
+
```ruby
|
|
396
|
+
require 'time'
|
|
397
|
+
require 'litellm_client'
|
|
398
|
+
# setup authorization
|
|
399
|
+
LiteLLMClient.configure do |config|
|
|
400
|
+
# Configure API key authorization: APIKeyHeader
|
|
401
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
402
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
403
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
407
|
+
opts = {
|
|
408
|
+
page: 56, # Integer | Page number
|
|
409
|
+
size: 56, # Integer | Page size
|
|
410
|
+
user_id: 'user_id_example', # String | Filter keys by user ID
|
|
411
|
+
team_id: 'team_id_example', # String | Filter keys by team ID
|
|
412
|
+
organization_id: 'organization_id_example', # String | Filter keys by organization ID
|
|
413
|
+
key_hash: 'key_hash_example', # String | Filter keys by key hash
|
|
414
|
+
key_alias: 'key_alias_example', # String | Filter keys by key alias
|
|
415
|
+
return_full_object: true, # Boolean | Return full key object
|
|
416
|
+
include_team_keys: true, # Boolean | Include all keys for teams that user is an admin of.
|
|
417
|
+
sort_by: 'sort_by_example', # String | Column to sort by (e.g. 'user_id', 'created_at', 'spend')
|
|
418
|
+
sort_order: 'sort_order_example' # String | Sort order ('asc' or 'desc')
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
begin
|
|
422
|
+
# List Keys
|
|
423
|
+
result = api_instance.list_keys_key_list_get(opts)
|
|
424
|
+
p result
|
|
425
|
+
rescue LiteLLMClient::ApiError => e
|
|
426
|
+
puts "Error when calling KeyManagementApi->list_keys_key_list_get: #{e}"
|
|
427
|
+
end
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
#### Using the list_keys_key_list_get_with_http_info variant
|
|
431
|
+
|
|
432
|
+
This returns an Array which contains the response data, status code and headers.
|
|
433
|
+
|
|
434
|
+
> <Array(<KeyListResponseObject>, Integer, Hash)> list_keys_key_list_get_with_http_info(opts)
|
|
435
|
+
|
|
436
|
+
```ruby
|
|
437
|
+
begin
|
|
438
|
+
# List Keys
|
|
439
|
+
data, status_code, headers = api_instance.list_keys_key_list_get_with_http_info(opts)
|
|
440
|
+
p status_code # => 2xx
|
|
441
|
+
p headers # => { ... }
|
|
442
|
+
p data # => <KeyListResponseObject>
|
|
443
|
+
rescue LiteLLMClient::ApiError => e
|
|
444
|
+
puts "Error when calling KeyManagementApi->list_keys_key_list_get_with_http_info: #{e}"
|
|
445
|
+
end
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### Parameters
|
|
449
|
+
|
|
450
|
+
| Name | Type | Description | Notes |
|
|
451
|
+
| ---- | ---- | ----------- | ----- |
|
|
452
|
+
| **page** | **Integer** | Page number | [optional][default to 1] |
|
|
453
|
+
| **size** | **Integer** | Page size | [optional][default to 10] |
|
|
454
|
+
| **user_id** | **String** | Filter keys by user ID | [optional] |
|
|
455
|
+
| **team_id** | **String** | Filter keys by team ID | [optional] |
|
|
456
|
+
| **organization_id** | **String** | Filter keys by organization ID | [optional] |
|
|
457
|
+
| **key_hash** | **String** | Filter keys by key hash | [optional] |
|
|
458
|
+
| **key_alias** | **String** | Filter keys by key alias | [optional] |
|
|
459
|
+
| **return_full_object** | **Boolean** | Return full key object | [optional][default to false] |
|
|
460
|
+
| **include_team_keys** | **Boolean** | Include all keys for teams that user is an admin of. | [optional][default to false] |
|
|
461
|
+
| **sort_by** | **String** | Column to sort by (e.g. 'user_id', 'created_at', 'spend') | [optional] |
|
|
462
|
+
| **sort_order** | **String** | Sort order ('asc' or 'desc') | [optional][default to 'desc'] |
|
|
463
|
+
|
|
464
|
+
### Return type
|
|
465
|
+
|
|
466
|
+
[**KeyListResponseObject**](KeyListResponseObject.md)
|
|
467
|
+
|
|
468
|
+
### Authorization
|
|
469
|
+
|
|
470
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
471
|
+
|
|
472
|
+
### HTTP request headers
|
|
473
|
+
|
|
474
|
+
- **Content-Type**: Not defined
|
|
475
|
+
- **Accept**: application/json
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
## regenerate_key_fn_key_key_regenerate_post
|
|
479
|
+
|
|
480
|
+
> <GenerateKeyResponse> regenerate_key_fn_key_key_regenerate_post(key, opts)
|
|
481
|
+
|
|
482
|
+
Regenerate Key Fn
|
|
483
|
+
|
|
484
|
+
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_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 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.
|
|
485
|
+
|
|
486
|
+
### Examples
|
|
487
|
+
|
|
488
|
+
```ruby
|
|
489
|
+
require 'time'
|
|
490
|
+
require 'litellm_client'
|
|
491
|
+
# setup authorization
|
|
492
|
+
LiteLLMClient.configure do |config|
|
|
493
|
+
# Configure API key authorization: APIKeyHeader
|
|
494
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
495
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
496
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
497
|
+
end
|
|
498
|
+
|
|
499
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
500
|
+
key = 'key_example' # String |
|
|
501
|
+
opts = {
|
|
502
|
+
litellm_changed_by: 'litellm_changed_by_example', # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
503
|
+
regenerate_key_request: LiteLLMClient::RegenerateKeyRequest.new # RegenerateKeyRequest |
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
begin
|
|
507
|
+
# Regenerate Key Fn
|
|
508
|
+
result = api_instance.regenerate_key_fn_key_key_regenerate_post(key, opts)
|
|
509
|
+
p result
|
|
510
|
+
rescue LiteLLMClient::ApiError => e
|
|
511
|
+
puts "Error when calling KeyManagementApi->regenerate_key_fn_key_key_regenerate_post: #{e}"
|
|
512
|
+
end
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
#### Using the regenerate_key_fn_key_key_regenerate_post_with_http_info variant
|
|
516
|
+
|
|
517
|
+
This returns an Array which contains the response data, status code and headers.
|
|
518
|
+
|
|
519
|
+
> <Array(<GenerateKeyResponse>, Integer, Hash)> regenerate_key_fn_key_key_regenerate_post_with_http_info(key, opts)
|
|
520
|
+
|
|
521
|
+
```ruby
|
|
522
|
+
begin
|
|
523
|
+
# Regenerate Key Fn
|
|
524
|
+
data, status_code, headers = api_instance.regenerate_key_fn_key_key_regenerate_post_with_http_info(key, opts)
|
|
525
|
+
p status_code # => 2xx
|
|
526
|
+
p headers # => { ... }
|
|
527
|
+
p data # => <GenerateKeyResponse>
|
|
528
|
+
rescue LiteLLMClient::ApiError => e
|
|
529
|
+
puts "Error when calling KeyManagementApi->regenerate_key_fn_key_key_regenerate_post_with_http_info: #{e}"
|
|
530
|
+
end
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### Parameters
|
|
534
|
+
|
|
535
|
+
| Name | Type | Description | Notes |
|
|
536
|
+
| ---- | ---- | ----------- | ----- |
|
|
537
|
+
| **key** | **String** | | |
|
|
538
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
539
|
+
| **regenerate_key_request** | [**RegenerateKeyRequest**](RegenerateKeyRequest.md) | | [optional] |
|
|
540
|
+
|
|
541
|
+
### Return type
|
|
542
|
+
|
|
543
|
+
[**GenerateKeyResponse**](GenerateKeyResponse.md)
|
|
544
|
+
|
|
545
|
+
### Authorization
|
|
546
|
+
|
|
547
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
548
|
+
|
|
549
|
+
### HTTP request headers
|
|
550
|
+
|
|
551
|
+
- **Content-Type**: application/json
|
|
552
|
+
- **Accept**: application/json
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
## regenerate_key_fn_key_regenerate_post
|
|
556
|
+
|
|
557
|
+
> <GenerateKeyResponse> regenerate_key_fn_key_regenerate_post(opts)
|
|
558
|
+
|
|
559
|
+
Regenerate Key Fn
|
|
560
|
+
|
|
561
|
+
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_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 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.
|
|
562
|
+
|
|
563
|
+
### Examples
|
|
564
|
+
|
|
565
|
+
```ruby
|
|
566
|
+
require 'time'
|
|
567
|
+
require 'litellm_client'
|
|
568
|
+
# setup authorization
|
|
569
|
+
LiteLLMClient.configure do |config|
|
|
570
|
+
# Configure API key authorization: APIKeyHeader
|
|
571
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
572
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
573
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
574
|
+
end
|
|
575
|
+
|
|
576
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
577
|
+
opts = {
|
|
578
|
+
key: 'key_example', # String |
|
|
579
|
+
litellm_changed_by: 'litellm_changed_by_example', # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
580
|
+
regenerate_key_request: LiteLLMClient::RegenerateKeyRequest.new # RegenerateKeyRequest |
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
begin
|
|
584
|
+
# Regenerate Key Fn
|
|
585
|
+
result = api_instance.regenerate_key_fn_key_regenerate_post(opts)
|
|
586
|
+
p result
|
|
587
|
+
rescue LiteLLMClient::ApiError => e
|
|
588
|
+
puts "Error when calling KeyManagementApi->regenerate_key_fn_key_regenerate_post: #{e}"
|
|
589
|
+
end
|
|
590
|
+
```
|
|
591
|
+
|
|
592
|
+
#### Using the regenerate_key_fn_key_regenerate_post_with_http_info variant
|
|
593
|
+
|
|
594
|
+
This returns an Array which contains the response data, status code and headers.
|
|
595
|
+
|
|
596
|
+
> <Array(<GenerateKeyResponse>, Integer, Hash)> regenerate_key_fn_key_regenerate_post_with_http_info(opts)
|
|
597
|
+
|
|
598
|
+
```ruby
|
|
599
|
+
begin
|
|
600
|
+
# Regenerate Key Fn
|
|
601
|
+
data, status_code, headers = api_instance.regenerate_key_fn_key_regenerate_post_with_http_info(opts)
|
|
602
|
+
p status_code # => 2xx
|
|
603
|
+
p headers # => { ... }
|
|
604
|
+
p data # => <GenerateKeyResponse>
|
|
605
|
+
rescue LiteLLMClient::ApiError => e
|
|
606
|
+
puts "Error when calling KeyManagementApi->regenerate_key_fn_key_regenerate_post_with_http_info: #{e}"
|
|
607
|
+
end
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
### Parameters
|
|
611
|
+
|
|
612
|
+
| Name | Type | Description | Notes |
|
|
613
|
+
| ---- | ---- | ----------- | ----- |
|
|
614
|
+
| **key** | **String** | | [optional] |
|
|
615
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
616
|
+
| **regenerate_key_request** | [**RegenerateKeyRequest**](RegenerateKeyRequest.md) | | [optional] |
|
|
617
|
+
|
|
618
|
+
### Return type
|
|
619
|
+
|
|
620
|
+
[**GenerateKeyResponse**](GenerateKeyResponse.md)
|
|
621
|
+
|
|
622
|
+
### Authorization
|
|
623
|
+
|
|
624
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
625
|
+
|
|
626
|
+
### HTTP request headers
|
|
627
|
+
|
|
628
|
+
- **Content-Type**: application/json
|
|
629
|
+
- **Accept**: application/json
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
## unblock_key_key_unblock_post
|
|
633
|
+
|
|
634
|
+
> Object unblock_key_key_unblock_post(block_key_request, opts)
|
|
635
|
+
|
|
636
|
+
Unblock Key
|
|
637
|
+
|
|
638
|
+
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 can unblock keys.
|
|
639
|
+
|
|
640
|
+
### Examples
|
|
641
|
+
|
|
642
|
+
```ruby
|
|
643
|
+
require 'time'
|
|
644
|
+
require 'litellm_client'
|
|
645
|
+
# setup authorization
|
|
646
|
+
LiteLLMClient.configure do |config|
|
|
647
|
+
# Configure API key authorization: APIKeyHeader
|
|
648
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
649
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
650
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
651
|
+
end
|
|
652
|
+
|
|
653
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
654
|
+
block_key_request = LiteLLMClient::BlockKeyRequest.new({key: 'key_example'}) # BlockKeyRequest |
|
|
655
|
+
opts = {
|
|
656
|
+
litellm_changed_by: 'litellm_changed_by_example' # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
657
|
+
}
|
|
658
|
+
|
|
659
|
+
begin
|
|
660
|
+
# Unblock Key
|
|
661
|
+
result = api_instance.unblock_key_key_unblock_post(block_key_request, opts)
|
|
662
|
+
p result
|
|
663
|
+
rescue LiteLLMClient::ApiError => e
|
|
664
|
+
puts "Error when calling KeyManagementApi->unblock_key_key_unblock_post: #{e}"
|
|
665
|
+
end
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
#### Using the unblock_key_key_unblock_post_with_http_info variant
|
|
669
|
+
|
|
670
|
+
This returns an Array which contains the response data, status code and headers.
|
|
671
|
+
|
|
672
|
+
> <Array(Object, Integer, Hash)> unblock_key_key_unblock_post_with_http_info(block_key_request, opts)
|
|
673
|
+
|
|
674
|
+
```ruby
|
|
675
|
+
begin
|
|
676
|
+
# Unblock Key
|
|
677
|
+
data, status_code, headers = api_instance.unblock_key_key_unblock_post_with_http_info(block_key_request, opts)
|
|
678
|
+
p status_code # => 2xx
|
|
679
|
+
p headers # => { ... }
|
|
680
|
+
p data # => Object
|
|
681
|
+
rescue LiteLLMClient::ApiError => e
|
|
682
|
+
puts "Error when calling KeyManagementApi->unblock_key_key_unblock_post_with_http_info: #{e}"
|
|
683
|
+
end
|
|
684
|
+
```
|
|
685
|
+
|
|
686
|
+
### Parameters
|
|
687
|
+
|
|
688
|
+
| Name | Type | Description | Notes |
|
|
689
|
+
| ---- | ---- | ----------- | ----- |
|
|
690
|
+
| **block_key_request** | [**BlockKeyRequest**](BlockKeyRequest.md) | | |
|
|
691
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
692
|
+
|
|
693
|
+
### Return type
|
|
694
|
+
|
|
695
|
+
**Object**
|
|
696
|
+
|
|
697
|
+
### Authorization
|
|
698
|
+
|
|
699
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
700
|
+
|
|
701
|
+
### HTTP request headers
|
|
702
|
+
|
|
703
|
+
- **Content-Type**: application/json
|
|
704
|
+
- **Accept**: application/json
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
## update_key_fn_key_update_post
|
|
708
|
+
|
|
709
|
+
> Object update_key_fn_key_update_post(update_key_request, opts)
|
|
710
|
+
|
|
711
|
+
Update Key Fn
|
|
712
|
+
|
|
713
|
+
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 - 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) - 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} - 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 - send_invite_email: Optional[bool] - Send invite email to user_id - guardrails: Optional[List[str]] - List of active guardrails for the key - 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/*\"] - object_permission: Optional[LiteLLM_ObjectPermissionBase] - key-specific object permission. Example - {\"vector_stores\": [\"vector_store_1\", \"vector_store_2\"]}. IF null or {} then no object permission. 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\"}, }' ```
|
|
714
|
+
|
|
715
|
+
### Examples
|
|
716
|
+
|
|
717
|
+
```ruby
|
|
718
|
+
require 'time'
|
|
719
|
+
require 'litellm_client'
|
|
720
|
+
# setup authorization
|
|
721
|
+
LiteLLMClient.configure do |config|
|
|
722
|
+
# Configure API key authorization: APIKeyHeader
|
|
723
|
+
config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
|
|
724
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
725
|
+
# config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
|
|
726
|
+
end
|
|
727
|
+
|
|
728
|
+
api_instance = LiteLLMClient::KeyManagementApi.new
|
|
729
|
+
update_key_request = LiteLLMClient::UpdateKeyRequest.new({key: 'key_example'}) # UpdateKeyRequest |
|
|
730
|
+
opts = {
|
|
731
|
+
litellm_changed_by: 'litellm_changed_by_example' # String | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
|
|
732
|
+
}
|
|
733
|
+
|
|
734
|
+
begin
|
|
735
|
+
# Update Key Fn
|
|
736
|
+
result = api_instance.update_key_fn_key_update_post(update_key_request, opts)
|
|
737
|
+
p result
|
|
738
|
+
rescue LiteLLMClient::ApiError => e
|
|
739
|
+
puts "Error when calling KeyManagementApi->update_key_fn_key_update_post: #{e}"
|
|
740
|
+
end
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
#### Using the update_key_fn_key_update_post_with_http_info variant
|
|
744
|
+
|
|
745
|
+
This returns an Array which contains the response data, status code and headers.
|
|
746
|
+
|
|
747
|
+
> <Array(Object, Integer, Hash)> update_key_fn_key_update_post_with_http_info(update_key_request, opts)
|
|
748
|
+
|
|
749
|
+
```ruby
|
|
750
|
+
begin
|
|
751
|
+
# Update Key Fn
|
|
752
|
+
data, status_code, headers = api_instance.update_key_fn_key_update_post_with_http_info(update_key_request, opts)
|
|
753
|
+
p status_code # => 2xx
|
|
754
|
+
p headers # => { ... }
|
|
755
|
+
p data # => Object
|
|
756
|
+
rescue LiteLLMClient::ApiError => e
|
|
757
|
+
puts "Error when calling KeyManagementApi->update_key_fn_key_update_post_with_http_info: #{e}"
|
|
758
|
+
end
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
### Parameters
|
|
762
|
+
|
|
763
|
+
| Name | Type | Description | Notes |
|
|
764
|
+
| ---- | ---- | ----------- | ----- |
|
|
765
|
+
| **update_key_request** | [**UpdateKeyRequest**](UpdateKeyRequest.md) | | |
|
|
766
|
+
| **litellm_changed_by** | **String** | The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability | [optional] |
|
|
767
|
+
|
|
768
|
+
### Return type
|
|
769
|
+
|
|
770
|
+
**Object**
|
|
771
|
+
|
|
772
|
+
### Authorization
|
|
773
|
+
|
|
774
|
+
[APIKeyHeader](../README.md#APIKeyHeader)
|
|
775
|
+
|
|
776
|
+
### HTTP request headers
|
|
777
|
+
|
|
778
|
+
- **Content-Type**: application/json
|
|
779
|
+
- **Accept**: application/json
|
|
780
|
+
|