Agent Configs13

Agent Insights4

Agent Insights Jobs4

Alerts7

Annotation Queues10

Assertion Results1

Attachments6

Automation rule evaluators6

Chat Completions1

Check2

Dashboards6

Datasets36

Environments5

Experiments17

Feedback-definitions6

Guardrails1

Insights Views6

LLM Models1

LlmProviderKey6

Manual Evaluation3

MCP OAuth8

Ollama2

Ollie State3

OpenTelemetry Ingestion1

Optimizations7

Pairing2

Projects19

Prompts17

Redirect4

Report Failures2

Reports5

Retention Rules4

Runners18

Service Toggles1

Spans18

System analytics queries1

System usage7

Traces35

Welcome Wizard2

Workspace permissions1

Workspaces9

Prompts

Retrieve prompt version

Retrieve prompt version. When project_name is supplied the lookup is scoped to that project: a prompt belonging to a different project is never matched, and an unknown project name returns 404. Legacy prompts with no project are still resolved as a deprecated fallback, signalled by the X-Opik-Deprecation response header.

post/v1/private/prompts/versions/retrieve

Request body

namestring required

commitstring

environmentstring

If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit and version_number

version_numberstring

If provided, resolves to the version with this sequential number (e.g. v3); mutually exclusive with commit and environment

project_namestring

If provided, scopes the search to the specified project; prompts belonging to other projects are never matched, and an unknown project name returns 404. Legacy prompts that are not scoped to any project are still matched as a deprecated fallback, signalled by the X-Opik-Deprecation response header.

Response

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

Changed in 6 of the 59 revisions of this API.1919

May 28, 2026f59fc1819c0c1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 27, 20263953a50a6a0e11See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 20, 2026a98bd55ddc1e2See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 19, 2026415a5d0ad31f2See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 19, 2026f93aac27fb6e94See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 4, 2026d606e84c75e499See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history