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
        • GETCancel Studio optimizations
        • GETFind optimizations
        • POSTCreate optimization
        • PUTUpsert optimization
        • POSTDelete optimizations by id
        • GETGet optimization by id
        • PUTUpdate optimization by id
        • GETGet Studio optimization logs
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceOptimizations

Upsert optimization

PUT
/v1/private/optimizations
PUT
/api/v1/private/optimizations
$curl -X PUT http://localhost:5173/api/v1/private/optimizations \
> -H "Content-Type: application/json" \
> -d '{
> "dataset_name": "string",
> "objective_name": "string",
> "status": "running"
>}'
201Created
1{}
Upsert optimization
Was this page helpful?
Previous

Delete optimizations by id

Next
Built with

Request

This endpoint expects an object.
dataset_namestringRequired>=1 character
objective_namestringRequired>=1 character
statusenumRequired
Allowed values:
idstringOptionalformat: "uuid"
namestringOptional
project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

Project name. Creates project if it doesn’t exist. Ignored when project_id is provided.

project_idstringOptionalformat: "uuid"

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

metadatamap from strings to any or list of objects or stringOptional
studio_configobjectOptional
last_updated_atdatetimeOptional

Response headers

Locationstring

Response

Created