---
title: "Retrieve prompt version"
method: POST
path: "/v1/private/prompts/versions/retrieve"
tags: ["Prompts"]
---

# Retrieve prompt version

`POST /v1/private/prompts/versions/retrieve`

Retrieve prompt version

## Request body

- PromptVersionRetrieveDetail
  - `name` string, required
  - `commit` string
  - `environment` string — If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit and version_number
  - `version_number` string — If provided, resolves to the version with this sequential number (e.g. v3); mutually exclusive with commit and environment
  - `project_name` string — If provided, scopes the search to the specified project

## Response `200`

OK

- PromptVersionDetail
  - `id` string, uuid — version unique identifier, generated if absent
  - `prompt_id` string, uuid
  - `commit` string — version short unique identifier, generated if absent. it must be 8 characters long
  - `version_number` string — sequential version number in the format v<N>; null for masks
  - `template` string, required
  - `metadata` JsonNodeDetail
  - `type` 'mustache' | 'jinja2' | 'python'
  - `version_type` 'prompt_version' | 'mask' — version type discriminator; defaults to prompt_version
  - `environment` string — Deprecated: use 'environments' instead
  - `environments` string[]
  - `change_description` string
  - `tags` string[]
  - `variables` string[]
  - `template_structure` 'text' | 'chat'
  - `created_at` string, date-time
  - `created_by` string

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Unprocessable Content

---

[API](https://skmtc.net/comet-ml/apis/opik-rest-api.md) · [All operations](https://skmtc.net/comet-ml/apis/opik-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/comet-ml/opik-rest-api/revisions/bcd13aadaaf8/schema)