For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • GETGet prompts
        • POSTCreate prompt
        • POSTCreate prompt version
        • PATCHUpdate prompt versions
        • GETGet prompt by id
        • PUTUpdate prompt
        • DELDelete prompt
        • POSTDelete prompts
        • GETGet prompt by commit
        • GETGet prompt version by id
        • GETGet prompt version by sequential number
        • GETGet prompt versions
        • POSTGet prompts by commits
        • POSTRestore prompt version
        • POSTRetrieve prompt version
        • POSTRetrieve prompt versions by ids
        • PATCHSet prompt version environment
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferencePrompts

Get prompts

GET
/v1/private/prompts
GET
/api/v1/private/prompts
$curl http://localhost:5173/api/v1/private/prompts
200Retrieved
1{
2  "page": 1,
3  "size": 1,
4  "total": 1,
5  "content": [
6    {
7      "name": "string",
8      "id": "string",
9      "project_id": "string",
10      "description": "string",
11      "template_structure": "text",
12      "tags": [
13        "string"
14      ],
15      "created_at": "2024-01-15T09:30:00Z",
16      "created_by": "string",
17      "last_updated_at": "2024-01-15T09:30:00Z",
18      "last_updated_by": "string",
19      "version_count": 1
20    }
21  ],
22  "sortableBy": [
23    "string"
24  ]
25}
Get prompts
Was this page helpful?
Previous

Create prompt

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
namestringOptional
project_idstringOptionalformat: "uuid"
sortingstringOptional
filtersstringOptional

Response

OK
pageinteger
sizeinteger
totallong
contentlist of objects
sortableBylist of strings