Get prompts by project | Opik Documentation

GET/v1/private/projects/{projectId}/promptsGet prompts by project

Get prompts scoped to a project

Parameters

projectIdstring · uuidpathrequired

pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 10 · minimum 1

namestringquery

Filter prompts by name (partial match, case insensitive)

sortingstringquery

filtersstringquery

Responses

objectPromptPage_Public

contentarray of object

Show child attributes

Show array items

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

namestringrequired

minLength 1

project_idstring · uuid

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

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

pageinteger · int32

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "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",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "tags": [
        "string"
      ],
      "template_structure": "text",
      "version_count": 0
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

Examples

projectIdrequiredpath parameter

pagequery parameter

sizequery parameter

namequery parameter

sortingquery parameter

filtersquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string'

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string")
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/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string", 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/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string");
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/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string"))
    .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/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string")
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/projects/00000000-0000-0000-0000-000000000000/prompts?filters=string&name=string&page=1&size=10&sorting=string");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "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",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "tags": [
        "string"
      ],
      "template_structure": "text",
      "version_count": 0
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}