> 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.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://www.comet.com/docs/opik/_mcp/server.

# Get prompt by id

GET http://localhost:5173/api/v1/private/prompts/{id}

Get prompt by id; when mask_id or environment is provided, requestedVersion is populated with the resolved version. mask_id and environment are mutually exclusive.

Reference: https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompt-by-id

## Servers

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

## Request

### Path parameters

- `id` (string, required)

### Query parameters

- `mask_id` (string, optional) — Optional mask version id; when set, requestedVersion is the mask row for that id
- `environment` (string, optional) — Optional environment name; when set, requestedVersion is the version mapped to that environment for the prompt

## Response

### 200

Prompt resource

- `name` (string, required)
- `id` (string, optional)
- `project_id` (string, optional) — Project ID. Takes precedence over project_name when both are provided.
- `description` (string, optional)
- `template_structure` (enum, optional, default: text) — Template structure type: 'text' or 'chat'. Immutable after creation.
  - Allowed values: `text`, `chat`
- `tags` (list of string, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)
- `version_count` (long, optional)
- `latest_version` (PromptVersion_Detail, optional)
- `requested_version` (PromptVersion_Detail, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `errors` (list of string, optional)

### 404 Not Found Error

Not Found

- `errors` (list of string, optional)

## Types

### PromptVersion_Detail

- `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

### JsonNode_Detail

## Examples

**Response**

```json
{
  "name": "string",
  "id": "string",
  "project_id": "string",
  "description": "string",
  "template_structure": "text",
  "tags": [
    "string"
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "version_count": 1,
  "latest_version": {
    "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"
  },
  "requested_version": {
    "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/id"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/prompts/id';
const options = {method: 'GET'};

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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	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/id")

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

request = Net::HTTP::Get.new(url)

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.get("http://localhost:5173/api/v1/private/prompts/id")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/prompts/id');

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/prompts/id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/prompts/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```