Retrieve prompt versions by ids | Opik Documentation

curl -X POST http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids \
     -H "Content-Type: application/json" \
     -d '{
  "ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  ]
}'

[
  {
    "template": "Hello {{user}}, welcome to our platform!",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "prompt_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "commit": "a1b2c3d4",
    "version_number": "v3",
    "metadata": {},
    "type": "mustache",
    "version_type": "prompt_version",
    "environment": "production",
    "change_description": "Updated greeting message to include user name",
    "tags": [
      "welcome",
      "user-greeting"
    ],
    "variables": [
      "user"
    ],
    "template_structure": "text",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "jane.doe@example.com"
  },
  {
    "template": "Please confirm your email address by clicking the link.",
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "prompt_id": "9f8e7d6c-5b4a-3210-9f8e-7d6c5b4a3210",
    "commit": "d4c3b2a1",
    "version_number": "v1",
    "metadata": {},
    "type": "mustache",
    "version_type": "prompt_version",
    "environment": "staging",
    "change_description": "Initial version of email confirmation prompt",
    "tags": [
      "email",
      "confirmation"
    ],
    "variables": [],
    "template_structure": "text",
    "created_at": "2023-12-10T14:45:00Z",
    "created_by": "john.smith@example.com"
  }
]

Retrieve a batch of prompt versions by their ids. Typically used by the UI to resolve mask overlays.

Request

This endpoint expects an object.

idslist of stringsRequired

Response

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