Model Provider Connection

✨ Put model provider connection

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Overwrite a specific model provider connection by ID.
put/api/model-provider-connections/{id}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/model-provider-connections/{id}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

A unique integer value identifying this model provider connection.

Request body

api_keystring nullable

Model provider API key

auth_tokenstring nullable

Model provider Auth token

budget_alert_thresholdnumber double nullable

Budget alert threshold for the given provider connection

cached_available_modelsstring nullable

List of available models from the provider

deployment_namestring nullable

Azure OpenAI deployment name

endpointstring nullable

Azure OpenAI endpoint

google_application_credentialsstring nullable

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_locationstring nullable

Google project location

google_project_idstring nullable

Google project ID

is_internalboolean nullable

Whether the model provider connection is internal, not visible to the user

provider'OpenAI' | 'AzureOpenAI' | 'AzureAIFoundry' | 'VertexAI' | 'Gemini' | 'Anthropic' | 'Custom'
  • OpenAI - OpenAI
  • AzureOpenAI - AzureOpenAI
  • AzureAIFoundry - AzureAIFoundry
  • VertexAI - VertexAI
  • Gemini - Gemini
  • Anthropic - Anthropic
  • Custom - Custom
scope'Organization' | 'User' | 'Model'
  • Organization - Organization
  • User - User
  • Model - Model

Response

budget_alert_thresholdnumber double nullable

Budget alert threshold for the given provider connection

budget_last_reset_datestring date-time nullable required

Date and time the budget was last reset

budget_limitnumber double nullable required

Budget limit for the model provider connection (null if unlimited)

budget_reset_period'Monthly' | 'Yearly' required
  • Monthly - Monthly
  • Yearly - Yearly
budget_total_spentnumber double nullable required

Tracked total budget spent for the given provider connection within the current budget period

cached_available_modelsstring nullable

List of available models from the provider

created_atstring date-time required
deployment_namestring nullable

Azure OpenAI deployment name

endpointstring nullable

Azure OpenAI endpoint

google_locationstring nullable

Google project location

google_project_idstring nullable

Google project ID

idinteger required
is_internalboolean nullable

Whether the model provider connection is internal, not visible to the user

model_paramsobject required

JSON schema for the model parameters available for the provider

organizationinteger nullable required
provider'OpenAI' | 'AzureOpenAI' | 'AzureAIFoundry' | 'VertexAI' | 'Gemini' | 'Anthropic' | 'Custom'
  • OpenAI - OpenAI
  • AzureOpenAI - AzureOpenAI
  • AzureAIFoundry - AzureAIFoundry
  • VertexAI - VertexAI
  • Gemini - Gemini
  • Anthropic - Anthropic
  • Custom - Custom
scope'Organization' | 'User' | 'Model'
  • Organization - Organization
  • User - User
  • Model - Model
updated_atstring date-time required

Changes

  • b5f055b9d45bRevision changes
    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response's property type changed from string to object for status

  • c2893748a8d3Revision changes
    • breaking

      for the path request parameter id, the type changed from string to integer