Skip to navigation
API ReferencePromptsVersions

✨ Get prompt version

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: 

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

Path parameters

prompt_idintegerRequired
version_idintegerRequired

Response

created_atdatetimeRead-only
created_byobject
User who created Dataset
idintegerRead-only
model_display_namestringRead-only

Human-readable model name derived from provider_model_id.

organizationinteger or nullRead-only
promptstring
Prompt to execute
provider_model_idstring<=255 characters

The model ID to use within the given provider, e.g. gpt-3.5

scoredouble or nullRead-only
titlestring<=500 characters
Model name
updated_atdatetimeRead-only
max_few_shot_examplesinteger or nullOptional0-2147483647

Max number of few-shot examples to include in prompts. 0 = disabled.

model_provider_connectioninteger or nullOptional
parent_modelintegerOptional
Parent model interface ID
providerenumOptional

The model provider to use e.g. OpenAI

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