Create optimization | Opik Documentation

POST/v1/private/optimizationsCreate optimization

Create optimization

Request body

application/json

objectOptimization_Write

dataset_namestringrequired

minLength 1

error_infoobject

Show child attributes

exception_typestringrequired

minLength 1

messagestring

tracebackstringrequired

minLength 1

idstring · uuid

last_updated_atstring · date-time

metadataobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

namestring

objective_namestringrequired

minLength 1

project_idstring · uuid

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

project_namestring

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

pattern (?s)^\s*(\S.*\S|\S)\s*$

statusstringrequired

one of "running", "completed", "cancelled", "initialized", "error"

studio_configobject

Show child attributes

dataset_namestringrequired

minLength 1

evaluationobjectrequired

Show child attributes

metricsarray of objectrequired

minItems 1

Show child attributes

minItems 1

Show array items

parametersobject

typestringrequired

minLength 1

llm_modelobjectrequired

Show child attributes

modelstringrequired

minLength 1

parametersobject

optimizerobjectrequired

Show child attributes

parametersobject

typestringrequired

minLength 1

promptobjectrequired

Show child attributes

messagesarray of objectrequired

minItems 1

Show child attributes

minItems 1

Show array items

contentstringrequired

minLength 1

rolestringrequired

minLength 1

Example request

{
  "dataset_name": "string",
  "error_info": {
    "exception_type": "string",
    "message": "string",
    "traceback": "string"
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "metadata": {},
  "name": "string",
  "objective_name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "status": "cancelled",
  "studio_config": {
    "dataset_name": "string",
    "evaluation": {
      "metrics": [
        {
          "parameters": {},
          "type": "string"
        }
      ]
    },
    "llm_model": {
      "model": "string",
      "parameters": {}
    },
    "optimizer": {
      "parameters": {},
      "type": "string"
    },
    "prompt": {
      "messages": [
        {
          "content": "string",
          "role": "string"
        }
      ]
    }
  }
}

Responses

Headers

Location

Examples

curl -X POST 'http://localhost:5173/api/v1/private/optimizations' \
  -H 'Content-Type: application/json' \
  -d '{"dataset_name":"string","error_info":{"exception_type":"string","message":"string","traceback":"string"},"id":"00000000-0000-0000-0000-000000000000","last_updated_at":"2026-06-09T00:00:00Z","metadata":{},"name":"string","objective_name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","status":"cancelled","studio_config":{"dataset_name":"string","evaluation":{"metrics":[{"parameters":{},"type":"string"}]},"llm_model":{"model":"string","parameters":{}},"optimizer":{"parameters":{},"type":"string"},"prompt":{"messages":[{"content":"string","role":"string"}]}}}'

const response = await fetch('http://localhost:5173/api/v1/private/optimizations', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"dataset_name":"string","error_info":{"exception_type":"string","message":"string","traceback":"string"},"id":"00000000-0000-0000-0000-000000000000","last_updated_at":"2026-06-09T00:00:00Z","metadata":{},"name":"string","objective_name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","status":"cancelled","studio_config":{"dataset_name":"string","evaluation":{"metrics":[{"parameters":{},"type":"string"}]},"llm_model":{"model":"string","parameters":{}},"optimizer":{"parameters":{},"type":"string"},"prompt":{"messages":[{"content":"string","role":"string"}]}}}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/optimizations', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"dataset_name\":\"string\",\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"last_updated_at\":\"2026-06-09T00:00:00Z\",\"metadata\":{},\"name\":\"string\",\"objective_name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"status\":\"cancelled\",\"studio_config\":{\"dataset_name\":\"string\",\"evaluation\":{\"metrics\":[{\"parameters\":{},\"type\":\"string\"}]},\"llm_model\":{\"model\":\"string\",\"parameters\":{}},\"optimizer\":{\"parameters\":{},\"type\":\"string\"},\"prompt\":{\"messages\":[{\"content\":\"string\",\"role\":\"string\"}]}}}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/optimizations",
    headers={"Content-Type": "application/json"},
    data='{"dataset_name":"string","error_info":{"exception_type":"string","message":"string","traceback":"string"},"id":"00000000-0000-0000-0000-000000000000","last_updated_at":"2026-06-09T00:00:00Z","metadata":{},"name":"string","objective_name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","status":"cancelled","studio_config":{"dataset_name":"string","evaluation":{"metrics":[{"parameters":{},"type":"string"}]},"llm_model":{"model":"string","parameters":{}},"optimizer":{"parameters":{},"type":"string"},"prompt":{"messages":[{"content":"string","role":"string"}]}}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"dataset_name":"string","error_info":{"exception_type":"string","message":"string","traceback":"string"},"id":"00000000-0000-0000-0000-000000000000","last_updated_at":"2026-06-09T00:00:00Z","metadata":{},"name":"string","objective_name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","status":"cancelled","studio_config":{"dataset_name":"string","evaluation":{"metrics":[{"parameters":{},"type":"string"}]},"llm_model":{"model":"string","parameters":{}},"optimizer":{"parameters":{},"type":"string"},"prompt":{"messages":[{"content":"string","role":"string"}]}}}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/optimizations", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/optimizations");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"dataset_name\":\"string\",\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"last_updated_at\":\"2026-06-09T00:00:00Z\",\"metadata\":{},\"name\":\"string\",\"objective_name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"status\":\"cancelled\",\"studio_config\":{\"dataset_name\":\"string\",\"evaluation\":{\"metrics\":[{\"parameters\":{},\"type\":\"string\"}]},\"llm_model\":{\"model\":\"string\",\"parameters\":{}},\"optimizer\":{\"parameters\":{},\"type\":\"string\"},\"prompt\":{\"messages\":[{\"content\":\"string\",\"role\":\"string\"}]}}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/optimizations"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"dataset_name\":\"string\",\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"last_updated_at\":\"2026-06-09T00:00:00Z\",\"metadata\":{},\"name\":\"string\",\"objective_name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"status\":\"cancelled\",\"studio_config\":{\"dataset_name\":\"string\",\"evaluation\":{\"metrics\":[{\"parameters\":{},\"type\":\"string\"}]},\"llm_model\":{\"model\":\"string\",\"parameters\":{}},\"optimizer\":{\"parameters\":{},\"type\":\"string\"},\"prompt\":{\"messages\":[{\"content\":\"string\",\"role\":\"string\"}]}}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/optimizations")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"dataset_name\":\"string\",\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"last_updated_at\":\"2026-06-09T00:00:00Z\",\"metadata\":{},\"name\":\"string\",\"objective_name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"status\":\"cancelled\",\"studio_config\":{\"dataset_name\":\"string\",\"evaluation\":{\"metrics\":[{\"parameters\":{},\"type\":\"string\"}]},\"llm_model\":{\"model\":\"string\",\"parameters\":{}},\"optimizer\":{\"parameters\":{},\"type\":\"string\"},\"prompt\":{\"messages\":[{\"content\":\"string\",\"role\":\"string\"}]}}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/optimizations");
request.Content = new StringContent("{\"dataset_name\":\"string\",\"error_info\":{\"exception_type\":\"string\",\"message\":\"string\",\"traceback\":\"string\"},\"id\":\"00000000-0000-0000-0000-000000000000\",\"last_updated_at\":\"2026-06-09T00:00:00Z\",\"metadata\":{},\"name\":\"string\",\"objective_name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"status\":\"cancelled\",\"studio_config\":{\"dataset_name\":\"string\",\"evaluation\":{\"metrics\":[{\"parameters\":{},\"type\":\"string\"}]},\"llm_model\":{\"model\":\"string\",\"parameters\":{}},\"optimizer\":{\"parameters\":{},\"type\":\"string\"},\"prompt\":{\"messages\":[{\"content\":\"string\",\"role\":\"string\"}]}}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 201)