Sign in
Prompts

✨ Create prompt version

<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> Create a new version of a prompt.
post/api/prompts/{prompt_id}/versions

Path parameters

prompt_idinteger required

Request body

max_few_shot_examplesinteger nullable

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

model_provider_connectioninteger nullable
organizationinteger nullable
parent_modelinteger

Parent model interface ID

promptstring required

Prompt to execute

provider'OpenAI' | 'AzureOpenAI' | 'AzureAIFoundry' | 'VertexAI' | 'Gemini' | 'Anthropic' | 'Custom'
  • OpenAI - OpenAI
  • AzureOpenAI - AzureOpenAI
  • AzureAIFoundry - AzureAIFoundry
  • VertexAI - VertexAI
  • Gemini - Gemini
  • Anthropic - Anthropic
  • Custom - Custom
provider_model_idstring required

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

titlestring required

Model name

Response

created_atstring date-time required
idinteger required
max_few_shot_examplesinteger nullable

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

model_display_namestring required

Human-readable model name derived from provider_model_id.

model_provider_connectioninteger nullable
organizationinteger nullable
parent_modelinteger

Parent model interface ID

promptstring required

Prompt to execute

provider'OpenAI' | 'AzureOpenAI' | 'AzureAIFoundry' | 'VertexAI' | 'Gemini' | 'Anthropic' | 'Custom'
  • OpenAI - OpenAI
  • AzureOpenAI - AzureOpenAI
  • AzureAIFoundry - AzureAIFoundry
  • VertexAI - VertexAI
  • Gemini - Gemini
  • Anthropic - Anthropic
  • Custom - Custom
provider_model_idstring required

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

scorenumber double nullable required
titlestring required

Model name

updated_atstring date-time required

Changes

Changed in 1 of the 98 revisions of this API.3

  • b5f055b9d45b3See the full diff
    • ▲

      the response property created_by/allOf[UserSimple]/avatar became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property score became nullable for the status 201

      response-property-became-nullable

    • ▲

      the score response's property type/format changed from string/ to number/double for status 201

      response-property-type-changed

Of the 98 revisions, 1 has no diff computed.