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
        • PATCHBatch update experiments
        • GETFind experiments
        • POSTCreate experiment
        • POSTCreate experiment items
        • POSTDelete experiment items
        • POSTDelete experiments by id
        • POSTCreate and execute experiment
        • PUTRecord experiment items in bulk
        • GETFind Feedback Score names
        • GETFind experiment groups
        • GETFind experiment groups with aggregations
        • POSTFinish experiments
        • GETGet experiment by id
        • PATCHUpdate experiment by id
        • GETGet experiment item by id
        • POSTStream experiment items
        • POSTStream experiments
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceExperiments

Update experiment by id

PATCH
/v1/private/experiments/:id
PATCH
/api/v1/private/experiments/:id
$curl -X PATCH http://localhost:5173/api/v1/private/experiments/id \
>     -H "Content-Type: application/json" \
>     -d '{}'
Update experiment by id
Was this page helpful?
Previous

Get experiment item by id

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"
metadataobjectOptional
tagslist of stringsOptional
Tags
tags_to_addlist of stringsOptional
Tags to add
tags_to_removelist of stringsOptional
Tags to remove
typeenumOptional
Allowed values:
statusenumOptional
The status of the experiment
Allowed values:
experiment_scoreslist of objectsOptional

Errors

400
Bad Request Error
404
Not Found Error