✨ Get prompt version | API Reference

curl http://localhost:8000/api/prompts/1/versions/1 \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

{
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": {
    "avatar": "https://example.com/avatars/jdoe.png",
    "id": 42,
    "username": "jdoe",
    "email": "jdoe@example.com",
    "first_name": "John",
    "last_name": "Doe"
  },
  "id": 1,
  "model_display_name": "GPT-4 Turbo",
  "prompt": "Translate the following English text to French:",
  "provider_model_id": "gpt-4-turbo",
  "score": "0.95",
  "title": "English to French Translation Model",
  "updated_at": "2024-01-15T09:30:00Z",
  "max_few_shot_examples": 5,
  "model_provider_connection": 12,
  "organization": 7,
  "parent_model": 3,
  "provider": "OpenAI"
}

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

Retrieve a specific prompt of a model.

<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 prompt of a model.

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]”

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: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

prompt_idintegerRequired

version_idintegerRequired

Response

created_atdatetimeRead-only

created_byobject

User who created Dataset

idintegerRead-only

model_display_namestringRead-only

promptstring

Prompt to execute

provider_model_idstring<=255 characters

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

scorestringRead-only

titlestring<=500 characters

Model name

updated_atdatetimeRead-only

max_few_shot_examplesinteger or null0-2147483647

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

model_provider_connectioninteger or null

organizationinteger or null

parent_modelinteger

Parent model interface ID

providerenum

The model provider to use e.g. OpenAI

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