Get prompt version by sequential number

curl http://localhost:5173/api/v1/private/prompts/promptId/versions/by-number/versionNumber \
     -H "Content-Type: application/json"

{
  "template": "Hello {{user_name}}, welcome to our service! How can I assist you today?",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "prompt_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "commit": "a1b2c3d4",
  "version_number": "v3",
  "metadata": {
    "language": "en",
    "category": "greeting"
  },
  "type": "mustache",
  "version_type": "prompt_version",
  "environment": "production",
  "change_description": "Updated greeting to include user name personalization",
  "tags": [
    "welcome",
    "personalization"
  ],
  "variables": [
    "user_name"
  ],
  "template_structure": "text",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "jane.doe@example.com"
}

Get a prompt version by its sequential v<N> number for the given prompt.

Path parameters

promptIdstringRequiredformat: "uuid"

versionNumberstringRequiredformat: "v\d+"0-10 characters

Response

Prompt version resource

templatestring>=1 character

idstringformat: "uuid"

version unique identifier, generated if absent

prompt_idstringRead-onlyformat: "uuid"

commitstringformat: "^[a-zA-Z0-9]{8}$"

version short unique identifier, generated if absent. it must be 8 characters long

version_numberstringRead-only

sequential version number in the format v<N>; null for masks

metadataobject

typeenum

Allowed values:

version_typeenum

version type discriminator; defaults to prompt_version

Allowed values:

environmentstringformat: "^[A-Za-z0-9_-]+$"0-150 characters

change_descriptionstring

tagslist of strings

variableslist of stringsRead-only

template_structureenumRead-only

Allowed values:

created_atdatetimeRead-only

created_bystringRead-only

Errors

400

Bad Request Error

404

Not Found Error