> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://www.comet.com/docs/opik/reference/rest-api/prompts/retrieve-prompt-versions-by-ids/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://www.comet.com/_mcp/server. # Retrieve prompt versions by ids POST http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids Content-Type: application/json Retrieve a batch of prompt versions by their ids. Typically used by the UI to resolve mask overlays. Reference: https://www.comet.com/docs/opik/reference/rest-api/prompts/retrieve-prompt-versions-by-ids ## Servers - `http://localhost:5173/api` (Local server, default) - `https://www.comet.com/opik/api` (Opik Cloud) ## Request ### Body (application/json) This endpoint expects a PromptVersionIdsRequest_Detail. - `ids` (list of string, required) ## Response ### 200 OK - `list of PromptVersion_Detail` ## Errors ### 400 Bad Request Error Bad Request - `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\; 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 **Request** ```json { "ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "7c9e6679-7425-40de-944b-e07fc1f90ae7" ] } ``` **Response** ```json [ { "template": "Hello {{user_name}}, welcome to our platform!", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "prompt_id": "1c6b147e-8f3a-4d2a-9f3b-2a1e4b5c6d7e", "commit": "a1b2c3d4", "version_number": "v3", "metadata": {}, "type": "mustache", "version_type": "prompt_version", "environments": [ "production", "staging" ], "change_description": "Updated greeting to include user name", "tags": [ "welcome", "user-greeting" ], "variables": [ "user_name" ], "template_structure": "text", "created_at": "2024-01-15T09:30:00Z", "created_by": "jane.doe@example.com", "environment": "production" }, { "template": "Please confirm your email address by clicking the link.", "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "prompt_id": "2d7f8e9a-3b4c-5d6e-7f8a-9b0c1d2e3f4a", "commit": "e5f6g7h8", "version_number": "v1", "metadata": {}, "type": "jinja2", "version_type": "prompt_version", "environments": [ "staging" ], "change_description": "Initial version of email confirmation prompt", "tags": [ "email", "confirmation" ], "variables": [ "confirmation_link" ], "template_structure": "text", "created_at": "2024-02-10T14:45:00Z", "created_by": "john.smith@example.com", "environment": "staging" } ] ``` **SDK Code** ```python import requests url = "http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids" payload = { "ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "7c9e6679-7425-40de-944b-e07fc1f90ae7"] } 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-by-ids'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6","7c9e6679-7425-40de-944b-e07fc1f90ae7"]}' }; 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-by-ids" payload := strings.NewReader("{\n \"ids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n ]\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-by-ids") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"ids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids") .header("Content-Type", "application/json") .body("{\n \"ids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n ]\n}") .asString(); ``` ```php request('POST', 'http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids', [ 'body' => '{ "ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "7c9e6679-7425-40de-944b-e07fc1f90ae7" ] }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("http://localhost:5173/api/v1/private/prompts/versions/retrieve-by-ids"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"ids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"7c9e6679-7425-40de-944b-e07fc1f90ae7\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Content-Type": "application/json"] let parameters = ["ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "7c9e6679-7425-40de-944b-e07fc1f90ae7"]] 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-by-ids")! 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() ``` > Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.