> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Retrieve prompt version

POST http://localhost:5173/api/v1/private/prompts/versions/retrieve
Content-Type: application/json

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.

Reference: https://www.comet.com/docs/opik/reference/rest-api/prompts/retrieve-prompt-version

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Body (application/json)

This endpoint expects a PromptVersionRetrieve_Detail.

- `name` (string, required)
- `commit` (string, optional)
- `environment` (string, optional) — If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit and version_number
- `version_number` (string, optional) — If provided, resolves to the version with this sequential number (e.g. v3); mutually exclusive with commit and environment
- `project_name` (string, optional) — 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

### 200

OK

- `template` (string, required)
- `id` (string, optional) — version unique identifier, generated if absent
- `prompt_id` (string, optional)
- `commit` (string, optional) — version short unique identifier, generated if absent. it must be 8 characters long
- `version_number` (string, optional) — sequential version number in the format v\<N>; null for masks
- `metadata` (JsonNode_Detail, optional)
- `type` (enum, optional)
  - Allowed values: `mustache`, `jinja2`, `python`
- `version_type` (enum, optional) — version type discriminator; defaults to prompt_version
  - Allowed values: `prompt_version`, `mask`
- `environments` (list of string, optional)
- `change_description` (string, optional)
- `tags` (list of string, optional)
- `variables` (list of string, optional)
- `template_structure` (enum, optional)
  - Allowed values: `text`, `chat`
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `environment` (string, optional, deprecated) — Deprecated: use 'environments' instead

## Errors

### 400 Bad Request Error

Bad Request

- `errors` (list of string, optional)

### 404 Not Found Error

Not Found

- `errors` (list of string, optional)

### 422 Unprocessable Entity Error

Unprocessable Content

- `errors` (list of string, optional)

## Types

### JsonNode_Detail

## Examples

**Request**

```json
{
  "name": "string"
}
```

**Response**

```json
{
  "template": "string",
  "id": "string",
  "prompt_id": "string",
  "commit": "string",
  "version_number": "string",
  "metadata": {},
  "type": "mustache",
  "version_type": "prompt_version",
  "environments": [
    "string"
  ],
  "change_description": "string",
  "tags": [
    "string"
  ],
  "variables": [
    "string"
  ],
  "template_structure": "text",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "environment": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/prompts/versions/retrieve"

payload = { "name": "string" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/prompts/versions/retrieve';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/prompts/versions/retrieve"

	payload := strings.NewReader("{\n  \"name\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/prompts/versions/retrieve")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:5173/api/v1/private/prompts/versions/retrieve")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/prompts/versions/retrieve', [
  'body' => '{
  "name": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/prompts/versions/retrieve");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["name": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/prompts/versions/retrieve")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```