Find experiments | Opik Documentation

import requests
url = "http://localhost:5173/api/v1/private/experiments"
response = requests.get(url)
print(response.json())

{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "dataset_name": "string",
      "id": "string",
      "dataset_id": "string",
      "project_id": "string",
      "project_name": "string",
      "name": "string",
      "metadata": {},
      "tags": [
        "string"
      ],
      "type": "regular",
      "optimization_id": "string",
      "feedback_scores": [
        {
          "name": "string",
          "value": 1.1
        }
      ],
      "comments": [
        {
          "text": "string",
          "id": "string",
          "created_at": "2024-01-15T09:30:00Z",
          "last_updated_at": "2024-01-15T09:30:00Z",
          "created_by": "string",
          "last_updated_by": "string"
        }
      ],
      "trace_count": 1,
      "created_at": "2024-01-15T09:30:00Z",
      "duration": {
        "p50": 1.1,
        "p90": 1.1,
        "p99": 1.1
      },
      "total_estimated_cost": 1.1,
      "total_estimated_cost_avg": 1.1,
      "usage": {},
      "last_updated_at": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "last_updated_by": "string",
      "status": "running",
      "experiment_scores": [
        {
          "name": "string",
          "value": 1.1
        }
      ],
      "prompt_version": {
        "id": "string",
        "commit": "string",
        "prompt_id": "string",
        "prompt_name": "string"
      },
      "prompt_versions": [
        {
          "id": "string",
          "commit": "string",
          "prompt_id": "string",
          "prompt_name": "string"
        }
      ],
      "dataset_version_id": "string",
      "dataset_version_summary": {
        "id": "string",
        "version_hash": "string",
        "version_name": "string",
        "change_description": "string",
        "tags": [
          "string"
        ]
      }
    }
  ],
  "sortableBy": [
    "string"
  ]
}

Find experiments

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 or null

sizeinteger or null

totallong or null

contentlist of objects or null

sortableBylist of strings or null

Query parameters

Response

Errors