Get model provider connection | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Retrieve a specific model provider connection.

<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> Retrieve a specific model provider connection.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idstringRequired

Response

created_atdatetime

created_byobject

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

idinteger

model_paramsstring

JSON schema for the model parameters available for the provider

updated_atdatetime

budget_alert_thresholddouble or null

Budget alert threshold for the given provider connection

budget_last_reset_datedatetime or null

Date and time the budget was last reset

budget_limitdouble or null

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

budget_reset_periodenum or string or null

Budget reset period for the model provider connection (null if not reset)

Monthly - Monthly
Yearly - Yearly

Budget reset period for the model provider connection (null if not reset) * `Monthly` - Monthly * `Yearly` - Yearly

budget_total_spentdouble or null

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

cached_available_modelsstring or null<=4096 characters

List of available models from the provider

deployment_namestring or null<=512 characters

Azure OpenAI deployment name

endpointstring or null<=512 characters

Azure OpenAI endpoint

google_locationstring or null<=255 characters

Google project location

google_project_idstring or null<=255 characters

Google project ID

is_internalboolean or null

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

organizationinteger or null

providerenum or null

OpenAI - OpenAI
AzureOpenAI - AzureOpenAI
AzureAIFoundry - AzureAIFoundry
VertexAI - VertexAI
Gemini - Gemini
Anthropic - Anthropic
Custom - Custom

* `OpenAI` - OpenAI * `AzureOpenAI` - AzureOpenAI * `AzureAIFoundry` - AzureAIFoundry * `VertexAI` - VertexAI * `Gemini` - Gemini * `Anthropic` - Anthropic * `Custom` - Custom

scopeenum or null

Organization - Organization
User - User
Model - Model

Allowed values:

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.model_providers.get(
7	id="id",
8	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"created_by": {
4	"avatar": "avatar",
5	"id": 1,
6	"email": "email",
7	"first_name": "first_name",
8	"last_name": "last_name"
9	},
10	"id": 1,
11	"model_params": "model_params",
12	"updated_at": "2024-01-15T09:30:00Z",
13	"budget_alert_threshold": 1.1,
14	"budget_last_reset_date": "2024-01-15T09:30:00Z",
15	"budget_limit": 1.1,
16	"budget_reset_period": "Monthly",
17	"budget_total_spent": 1.1,
18	"cached_available_models": "cached_available_models",
19	"deployment_name": "deployment_name",
20	"endpoint": "endpoint",
21	"google_location": "google_location",
22	"google_project_id": "google_project_id",
23	"is_internal": true,
24	"organization": 1,
25	"provider": "OpenAI",
26	"scope": "Organization"
27	}