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

Update prompt

PUT
/v1/private/prompts/:id
PUT
/api/v1/private/prompts/:id
$curl -X PUT http://localhost:5173/api/v1/private/prompts/id \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "string"
>}'
Update prompt
Was this page helpful?
Previous

Delete prompt

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestringRequired>=1 character
descriptionstringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters
tagslist of stringsOptional

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error