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

Find experiments

GET
/v1/private/experiments
GET
/api/v1/private/experiments
$curl http://localhost:5173/api/v1/private/experiments
1{
2  "page": 1,
3  "size": 1,
4  "total": 1,
5  "content": [
6    {
7      "dataset_name": "string",
8      "id": "string",
9      "dataset_id": "string",
10      "project_id": "string",
11      "project_name": "string",
12      "name": "string",
13      "metadata": {},
14      "tags": [
15        "string"
16      ],
17      "type": "regular",
18      "evaluation_method": "dataset",
19      "optimization_id": "string",
20      "feedback_scores": [
21        {
22          "name": "string",
23          "value": 1.1
24        }
25      ],
26      "comments": [
27        {
28          "text": "string",
29          "id": "string",
30          "created_at": "2024-01-15T09:30:00Z",
31          "last_updated_at": "2024-01-15T09:30:00Z",
32          "created_by": "string",
33          "last_updated_by": "string"
34        }
35      ],
36      "trace_count": 1,
37      "dataset_item_count": 1,
38      "created_at": "2024-01-15T09:30:00Z",
39      "duration": {
40        "p50": 1.1,
41        "p90": 1.1,
42        "p99": 1.1
43      },
44      "total_estimated_cost": 1.1,
45      "total_estimated_cost_avg": 1.1,
46      "usage": {},
47      "last_updated_at": "2024-01-15T09:30:00Z",
48      "created_by": "string",
49      "last_updated_by": "string",
50      "status": "running",
51      "experiment_scores": [
52        {
53          "name": "string",
54          "value": 1.1
55        }
56      ],
57      "prompt_version": {
58        "prompt_version_id": "string",
59        "commit": "string",
60        "prompt_id": "string",
61        "prompt_name": "string"
62      },
63      "prompt_versions": [
64        {
65          "prompt_version_id": "string",
66          "commit": "string",
67          "prompt_id": "string",
68          "prompt_name": "string"
69        }
70      ],
71      "dataset_version_id": "string",
72      "dataset_version_summary": {
73        "id": "string",
74        "version_hash": "string",
75        "version_name": "string",
76        "change_description": "string",
77        "tags": [
78          "string"
79        ]
80      },
81      "pass_rate": 1.1,
82      "passed_count": 1,
83      "total_count": 1,
84      "assertion_scores": [
85        {
86          "name": "string",
87          "value": 1.1
88        }
89      ]
90    }
91  ],
92  "sortableBy": [
93    "string"
94  ]
95}
Find experiments
Was this page helpful?
Previous

Create experiment

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
datasetIdstringOptionalformat: "uuid"
optimization_idstringOptionalformat: "uuid"
typesstringOptional
namestringOptional
dataset_deletedbooleanOptional
prompt_idstringOptionalformat: "uuid"
project_idstringOptionalformat: "uuid"
project_deletedbooleanOptional
sortingstringOptional
filtersstringOptional
experiment_idsstringOptional
force_sortingbooleanOptionalDefaults to false

Response

Experiments resource
pageinteger
sizeinteger
totallong
contentlist of objects
sortableBylist of strings

Errors

400
Bad Request Error