Find experiments | Opik Documentation

GET/v1/private/experimentsFind experiments

Find experiments

Parameters

pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 10 · minimum 1

datasetIdstring · uuidquery

optimization_idstring · uuidquery

typesstringquery

namestringquery

Filter experiments by name (partial match, case insensitive)

dataset_deletedbooleanquery

prompt_idstring · uuidquery

project_idstring · uuidquery

project_deletedbooleanquery

sortingstringquery

filtersstringquery

experiment_idsstringquery

Filter experiments by a list of experiment IDs

force_sortingbooleanquery

Force sorting even when exceeding the endpoint result set limit. May result in slower queries

default false

Responses

objectExperimentPage_Public

contentarray of object

Show child attributes

Show array items

assertion_scoresarray of object

Per-assertion average pass rates for test suite experiments. Null for regular experiments.

Show child attributes

Show array items

Per-assertion average pass rates for test suite experiments. Null for regular experiments.

namestringrequired

minLength 1

valuenumberrequired

commentsarray of object

Show child attributes

Show array items

created_atstring · date-time

created_bystring

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

source_queue_idstring · uuid

textstringrequired

minLength 1

created_atstring · date-time

created_bystring

dataset_idstring · uuid

dataset_item_countinteger · int64

dataset_namenull | stringrequired

minLength 1

dataset_version_idstring · uuid

ID of the dataset version this experiment is linked to. If not provided at creation, experiment will be automatically linked to the latest version.

dataset_version_summaryobject

Summary of the latest dataset version

Show child attributes

change_descriptionstring

Description of changes in this version

idstring · uuid

Unique identifier of the version

tagsarray of string

Tags associated with this version

uniqueItems true

Show child attributes

uniqueItems true

version_hashstring

Hash of the version content

version_namestring

Sequential version name formatted as 'v1', 'v2', etc.

durationobject

Show child attributes

p50number

p90number

p99number

evaluation_methodstring

one of "dataset", "evaluation_suite"

experiment_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

feedback_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

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

optimization_idstring · uuid

pass_ratenumber

Pass rate for test suite experiments (0.0-1.0). Null for regular experiments.

passed_countinteger · int64

Number of items that passed for test suite experiments. Null for regular experiments.

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*$

prompt_versionobject

Show child attributes

commitstring

prompt_idstring · uuid

prompt_namestring

prompt_version_idstring · uuid

prompt_versionsarray of object

Show child attributes

Items: PromptVersionLink_Public ↑

statusstring

one of "running", "completed", "cancelled"

tagsarray of string

maxItems 50 · minItems 0 · uniqueItems true

Show child attributes

maxItems 50 · minItems 0 · uniqueItems true

total_countinteger · int64

Total number of items for test suite experiments. Null for regular experiments.

total_estimated_costnumber

total_estimated_cost_avgnumber

trace_countinteger · int64

typestring

one of "regular", "trial", "mini-batch", "mutation"

usageobject

pageinteger · int32

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "assertion_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "comments": [
        {
          "created_at": "2026-06-09T00:00:00Z",
          "created_by": "string",
          "id": "00000000-0000-0000-0000-000000000000",
          "last_updated_at": "2026-06-09T00:00:00Z",
          "last_updated_by": "string",
          "source_queue_id": "00000000-0000-0000-0000-000000000000",
          "text": "string"
        }
      ],
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "dataset_id": "00000000-0000-0000-0000-000000000000",
      "dataset_item_count": 0,
      "dataset_name": "string",
      "dataset_version_id": "00000000-0000-0000-0000-000000000000",
      "dataset_version_summary": {
        "change_description": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "tags": [
          "string"
        ],
        "version_hash": "string",
        "version_name": "string"
      },
      "duration": {
        "p50": 0,
        "p90": 0,
        "p99": 0
      },
      "evaluation_method": "dataset",
      "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",
      "optimization_id": "00000000-0000-0000-0000-000000000000",
      "pass_rate": 0,
      "passed_count": 0,
      "project_id": "00000000-0000-0000-0000-000000000000",
      "project_name": "string",
      "prompt_version": {
        "commit": "string",
        "prompt_id": "00000000-0000-0000-0000-000000000000",
        "prompt_name": "string",
        "prompt_version_id": "00000000-0000-0000-0000-000000000000"
      },
      "prompt_versions": [
        {
          "commit": "string",
          "prompt_id": "00000000-0000-0000-0000-000000000000",
          "prompt_name": "string",
          "prompt_version_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "status": "cancelled",
      "tags": [
        "string"
      ],
      "total_count": 0,
      "total_estimated_cost": 0,
      "total_estimated_cost_avg": 0,
      "trace_count": 0,
      "type": "mini-batch",
      "usage": {
        "additionalProp1": 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

datasetIdquery parameter

optimization_idquery parameter

typesquery parameter

namequery parameter

dataset_deletedquery parameter

prompt_idquery parameter

project_idquery parameter

project_deletedquery parameter

sortingquery parameter

filtersquery parameter

experiment_idsquery parameter

force_sortingquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string'

const response = await fetch('http://localhost:5173/api/v1/private/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string")
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/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string", 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/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string");
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/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string"))
    .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/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string")
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/experiments?datasetId=00000000-0000-0000-0000-000000000000&dataset_deleted=true&experiment_ids=string&filters=string&force_sorting=false&name=string&optimization_id=00000000-0000-0000-0000-000000000000&page=1&project_deleted=true&project_id=00000000-0000-0000-0000-000000000000&prompt_id=00000000-0000-0000-0000-000000000000&size=10&sorting=string&types=string");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "assertion_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "comments": [
        {
          "created_at": "2026-06-09T00:00:00Z",
          "created_by": "string",
          "id": "00000000-0000-0000-0000-000000000000",
          "last_updated_at": "2026-06-09T00:00:00Z",
          "last_updated_by": "string",
          "source_queue_id": "00000000-0000-0000-0000-000000000000",
          "text": "string"
        }
      ],
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "dataset_id": "00000000-0000-0000-0000-000000000000",
      "dataset_item_count": 0,
      "dataset_name": "string",
      "dataset_version_id": "00000000-0000-0000-0000-000000000000",
      "dataset_version_summary": {
        "change_description": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "tags": [
          "string"
        ],
        "version_hash": "string",
        "version_name": "string"
      },
      "duration": {
        "p50": 0,
        "p90": 0,
        "p99": 0
      },
      "evaluation_method": "dataset",
      "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",
      "optimization_id": "00000000-0000-0000-0000-000000000000",
      "pass_rate": 0,
      "passed_count": 0,
      "project_id": "00000000-0000-0000-0000-000000000000",
      "project_name": "string",
      "prompt_version": {
        "commit": "string",
        "prompt_id": "00000000-0000-0000-0000-000000000000",
        "prompt_name": "string",
        "prompt_version_id": "00000000-0000-0000-0000-000000000000"
      },
      "prompt_versions": [
        {
          "commit": "string",
          "prompt_id": "00000000-0000-0000-0000-000000000000",
          "prompt_name": "string",
          "prompt_version_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "status": "cancelled",
      "tags": [
        "string"
      ],
      "total_count": 0,
      "total_estimated_cost": 0,
      "total_estimated_cost_avg": 0,
      "trace_count": 0,
      "type": "mini-batch",
      "usage": {
        "additionalProp1": 0
      }
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

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