Prompts

Retrieve prompt versions by ids

Changed on

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

post/v1/private/prompts/versions/retrieve-by-ids

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids
  • Auth
    none declared

Request body

idsstring[] required

Response

OK

idstring uuid

version unique identifier, generated if absent

prompt_idstring uuid
commitstring

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

version_numberstring

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

templatestring required
metadataJsonNodeDetail
type'mustache' | 'jinja2' | 'python'
version_type'prompt_version' | 'mask'

version type discriminator; defaults to prompt_version

environmentstring

Deprecated: use 'environments' instead

environmentsstring[]
change_descriptionstring
tagsstring[]
variablesstring[]
template_structure'text' | 'chat'
created_atstring date-time
created_bystring

Changes

  • f59fc1819c0cRevision changes
    • info

      added the optional property / to the response with the status

  • 3953a50a6a0eRevision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status