Get prompts by commits | Opik Documentation

POST/v1/private/prompts/retrieve-by-commitsGet prompts by commits

Get prompts by prompt version commits

Request body

application/json

objectPromptVersionCommitsRequest_Public

commitsarray of stringrequired

maxItems 1000 · minItems 1

Show child attributes

maxItems 1000 · minItems 1

Example request

{
  "commits": [
    "string"
  ]
}

Responses

array of object

Show array items

commitstring

prompt_idstring · uuid

prompt_namestring

prompt_version_idstring · uuid

Example response

[
  {
    "commit": "string",
    "prompt_id": "00000000-0000-0000-0000-000000000000",
    "prompt_name": "string",
    "prompt_version_id": "00000000-0000-0000-0000-000000000000"
  }
]

Examples

curl -X POST 'http://localhost:5173/api/v1/private/prompts/retrieve-by-commits' \
  -H 'Content-Type: application/json' \
  -d '{"commits":["string"]}'

const response = await fetch('http://localhost:5173/api/v1/private/prompts/retrieve-by-commits', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"commits":["string"]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/prompts/retrieve-by-commits', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"commits\":[\"string\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/prompts/retrieve-by-commits",
    headers={"Content-Type": "application/json"},
    data='{"commits":["string"]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"commits":["string"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/prompts/retrieve-by-commits", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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/retrieve-by-commits");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"commits\":[\"string\"]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/prompts/retrieve-by-commits"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"commits\":[\"string\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/prompts/retrieve-by-commits")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"commits\":[\"string\"]}"
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.Post, "http://localhost:5173/api/v1/private/prompts/retrieve-by-commits");
request.Content = new StringContent("{\"commits\":[\"string\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

[
  {
    "commit": "string",
    "prompt_id": "00000000-0000-0000-0000-000000000000",
    "prompt_name": "string",
    "prompt_version_id": "00000000-0000-0000-0000-000000000000"
  }
]