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

Find optimizations

GET
/v1/private/optimizations
GET
/api/v1/private/optimizations
$curl http://localhost:5173/api/v1/private/optimizations
1{
2  "page": 1,
3  "size": 1,
4  "total": 1,
5  "content": [
6    {
7      "dataset_name": "string",
8      "objective_name": "string",
9      "status": "running",
10      "id": "string",
11      "name": "string",
12      "project_id": "string",
13      "metadata": {},
14      "studio_config": {
15        "dataset_name": "string",
16        "prompt": {
17          "messages": [
18            {
19              "role": "string",
20              "content": "string"
21            }
22          ]
23        },
24        "llm_model": {
25          "model": "string",
26          "parameters": {}
27        },
28        "evaluation": {
29          "metrics": [
30            {
31              "type": "string",
32              "parameters": {}
33            }
34          ]
35        },
36        "optimizer": {
37          "type": "string",
38          "parameters": {}
39        }
40      },
41      "dataset_id": "string",
42      "num_trials": 1,
43      "feedback_scores": [
44        {
45          "name": "string",
46          "value": 1.1
47        }
48      ],
49      "experiment_scores": [
50        {
51          "name": "string",
52          "value": 1.1
53        }
54      ],
55      "created_at": "2024-01-15T09:30:00Z",
56      "created_by": "string",
57      "last_updated_at": "2024-01-15T09:30:00Z",
58      "last_updated_by": "string",
59      "baseline_objective_score": 1.1,
60      "best_objective_score": 1.1,
61      "baseline_duration": 1.1,
62      "best_duration": 1.1,
63      "baseline_cost": 1.1,
64      "best_cost": 1.1,
65      "total_optimization_cost": 1.1
66    }
67  ],
68  "sortableBy": [
69    "string"
70  ]
71}
Find optimizations
Was this page helpful?
Previous

Create optimization

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
dataset_idstringOptionalformat: "uuid"
namestringOptional
dataset_namestringOptional
dataset_deletedbooleanOptional
project_idstringOptionalformat: "uuid"
filtersstringOptional

Response

Optimizations resource
pageinteger
sizeinteger
totallong
contentlist of objects
sortableBylist of strings

Errors

400
Bad Request Error