Retrieve prompt versions by ids | Opik Documentation

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

This endpoint expects an object.

idslist of stringsRequired

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:

environmentslist of strings

change_descriptionstring

tagslist of strings

variableslist of stringsRead-only

template_structureenumRead-only

Allowed values:

created_atdatetimeRead-only

created_bystringRead-only

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

Deprecated: use ‘environments’ instead

400

Bad Request Error

$	curl -X POST http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids \
>	-H "Content-Type: application/json" \
>	-d '{
>	"ids": [
>	"string"
>	]
>	}'

$	curl -X POST http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids \
>	-H "Content-Type: application/json" \
>	-d '{
>	"ids": [
>	"string"
>	]
>	}'