Get prompt by id | Opik Documentation

GET/v1/private/prompts/{id}Get prompt by 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.

Parameters

idstring · uuidpathrequired

mask_idstring · uuidquery

Optional mask version id; when set, requestedVersion is the mask row for that id

environmentstringquery

Optional environment name; when set, requestedVersion is the version mapped to that environment for the prompt

maxLength 150 · minLength 0 · pattern ^[A-Za-z0-9_-]+$

Responses

objectPrompt_Detail

created_atstring · date-time

created_bystring

descriptionstring

maxLength 255 · minLength 0 · pattern (?s)^\s*(\S.*\S|\S)\s*$

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

latest_versionobject

Show child attributes

change_descriptionstring

commitstring

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

pattern ^[a-zA-Z0-9]{8}$

created_atstring · date-time

created_bystring

environmentstring

Deprecated: use 'environments' instead

maxLength 150 · minLength 0 · pattern ^[A-Za-z0-9_-]+$

environmentsarray of string

maxItems 100 · minItems 0 · uniqueItems true

Show child attributes

maxItems 100 · minItems 0 · uniqueItems true

idstring · uuid

version unique identifier, generated if absent

metadataobject

prompt_idstring · uuid

tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

templatestringrequired

minLength 1

template_structurestring

one of "text", "chat"

typestring

one of "mustache", "jinja2", "python"

variablesarray of string

uniqueItems true

Show child attributes

uniqueItems true

version_numberstring

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

version_typestring

version type discriminator; defaults to prompt_version

one of "prompt_version", "mask"

namestringrequired

minLength 1

project_idstring · uuid

Project ID. Takes precedence over project_name when both are provided.

requested_versionobjectPromptVersion_Detail ↑

tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

template_structurestring

Template structure type: 'text' or 'chat'. Immutable after creation.

one of "text", "chat" · default "text"

version_countinteger · int64

Example response

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "description": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "latest_version": {
    "change_description": "string",
    "commit": "string",
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "environment": "string",
    "environments": [
      "string"
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "prompt_id": "00000000-0000-0000-0000-000000000000",
    "tags": [
      "string"
    ],
    "template": "string",
    "template_structure": "chat",
    "type": "jinja2",
    "variables": [
      "string"
    ],
    "version_number": "string",
    "version_type": "mask"
  },
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "requested_version": {
    "change_description": "string",
    "commit": "string",
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "environment": "string",
    "environments": [
      "string"
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "prompt_id": "00000000-0000-0000-0000-000000000000",
    "tags": [
      "string"
    ],
    "template": "string",
    "template_structure": "chat",
    "type": "jinja2",
    "variables": [
      "string"
    ],
    "version_number": "string",
    "version_type": "mask"
  },
  "tags": [
    "string"
  ],
  "template_structure": "text",
  "version_count": 0
}

objectErrorMessage_Detail

errorsarray of string

Show child attributes

Example response

{
  "errors": [
    "string"
  ]
}

objectErrorMessage_Detail

errorsarray of string

Show child attributes

Example response

{
  "errors": [
    "string"
  ]
}

Examples

idrequiredpath parameter

mask_idquery parameter

environmentquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000'

const response = await fetch('http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/prompts/00000000-0000-0000-0000-000000000000?environment=string&mask_id=00000000-0000-0000-0000-000000000000");
using var response = await client.SendAsync(request);

{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "description": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "latest_version": {
    "change_description": "string",
    "commit": "string",
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "environment": "string",
    "environments": [
      "string"
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "prompt_id": "00000000-0000-0000-0000-000000000000",
    "tags": [
      "string"
    ],
    "template": "string",
    "template_structure": "chat",
    "type": "jinja2",
    "variables": [
      "string"
    ],
    "version_number": "string",
    "version_type": "mask"
  },
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "requested_version": {
    "change_description": "string",
    "commit": "string",
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "environment": "string",
    "environments": [
      "string"
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "prompt_id": "00000000-0000-0000-0000-000000000000",
    "tags": [
      "string"
    ],
    "template": "string",
    "template_structure": "chat",
    "type": "jinja2",
    "variables": [
      "string"
    ],
    "version_number": "string",
    "version_type": "mask"
  },
  "tags": [
    "string"
  ],
  "template_structure": "text",
  "version_count": 0
}

{
  "errors": [
    "string"
  ]
}

{
  "errors": [
    "string"
  ]
}