Prompts

✨ Update prompt version

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> Update a specific prompt version by ID.
patch/api/prompts/{prompt_id}/versions/{version_id}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/prompts/{prompt_id}/versions/{version_id}
  • Auth
    API key in header Authorization

Path parameters

prompt_idinteger required
version_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
parent_modelinteger

Parent model interface ID

promptstring

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

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

titlestring

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 required
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

  • b8379b6a8cdaRevision changes
    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • info

      the response optional property became read-only for the status

    • info

      the response property became required for the status

  • b5f055b9d45bRevision changes
    • breaking

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

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from string to number, and format from no format to double for status