Find optimizations | Opik Documentation

GET/v1/private/optimizationsFind optimizations

Find optimizations

Parameters

pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 10 · minimum 1

dataset_idstring · uuidquery

namestringquery

Filter optimizations by name (partial match, case insensitive)

dataset_namestringquery

Filter optimizations by dataset name (partial match)

dataset_deletedbooleanquery

project_idstring · uuidquery

filtersstringquery

Responses

objectOptimizationPage_Public

contentarray of object

Show child attributes

Show array items

baseline_costnumber

baseline_durationnumber

baseline_objective_scorenumber

best_costnumber

best_durationnumber

best_objective_scorenumber

created_atstring · date-time

created_bystring

dataset_idstring · uuid

dataset_namestringrequired

minLength 1

error_infoobject

Show child attributes

exception_typestringrequired

minLength 1

messagestring

tracebackstringrequired

minLength 1

experiment_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

feedback_scoresarray of object

Show child attributes

Items: FeedbackScoreAverage_Public ↑

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

metadataobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

namestring

num_trialsinteger · int64

objective_namestringrequired

minLength 1

project_idstring · uuid

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

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

total_optimization_costnumber

pageinteger · int32

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "baseline_cost": 0,
      "baseline_duration": 0,
      "baseline_objective_score": 0,
      "best_cost": 0,
      "best_duration": 0,
      "best_objective_score": 0,
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "dataset_id": "00000000-0000-0000-0000-000000000000",
      "dataset_name": "string",
      "error_info": {
        "exception_type": "string",
        "message": "string",
        "traceback": "string"
      },
      "experiment_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "feedback_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "metadata": [
        {}
      ],
      "name": "string",
      "num_trials": 0,
      "objective_name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "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"
            }
          ]
        }
      },
      "total_optimization_cost": 0
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

objectErrorMessage_Public

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

pagequery parameter

sizequery parameter

dataset_idquery parameter

namequery parameter

dataset_namequery parameter

dataset_deletedquery parameter

project_idquery parameter

filtersquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10'

const response = await fetch('http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10", nil)
	if err != nil {
		panic(err)
	}
	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?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
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.Get, "http://localhost:5173/api/v1/private/optimizations?dataset_deleted=true&dataset_id=00000000-0000-0000-0000-000000000000&dataset_name=string&filters=string&name=string&page=1&project_id=00000000-0000-0000-0000-000000000000&size=10");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "baseline_cost": 0,
      "baseline_duration": 0,
      "baseline_objective_score": 0,
      "best_cost": 0,
      "best_duration": 0,
      "best_objective_score": 0,
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "dataset_id": "00000000-0000-0000-0000-000000000000",
      "dataset_name": "string",
      "error_info": {
        "exception_type": "string",
        "message": "string",
        "traceback": "string"
      },
      "experiment_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "feedback_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "metadata": [
        {}
      ],
      "name": "string",
      "num_trials": 0,
      "objective_name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "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"
            }
          ]
        }
      },
      "total_optimization_cost": 0
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}