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 by commits

POST
/v1/private/prompts/retrieve-by-commits
POST
/api/v1/private/prompts/retrieve-by-commits
$curl -X POST http://localhost:5173/api/v1/private/prompts/retrieve-by-commits \
>     -H "Content-Type: application/json" \
>     -d '{
>  "commits": [
>    "string"
>  ]
>}'
200Successful
1[
2  {
3    "prompt_version_id": "string",
4    "commit": "string",
5    "prompt_id": "string",
6    "prompt_name": "string"
7  }
8]
Get prompts by prompt version commits
Was this page helpful?
Previous

Restore prompt version

Next
Built with

Request

This endpoint expects an object.
commitslist of stringsRequired

Response

OK
prompt_version_idstringformat: "uuid"
commitstring
prompt_idstringformat: "uuid"
prompt_namestring