Find experiments by project | Opik Documentation

curl http://localhost:5173/api/v1/private/projects/projectId/experiments \
     -H "Content-Type: application/json"

{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "dataset_name": "Customer Churn Dataset",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dataset_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "project_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
      "project_name": "Churn Prediction Project",
      "name": "Experiment Alpha",
      "metadata": {},
      "tags": [
        "baseline",
        "v1"
      ],
      "type": "regular",
      "evaluation_method": "dataset",
      "optimization_id": "9a7b3c2d-4f1e-4a2b-8f3d-2e5a7c9d8b1f",
      "feedback_scores": [
        {
          "name": "accuracy",
          "value": 0.87
        }
      ],
      "comments": [
        {
          "text": "Initial experiment with default parameters.",
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "created_at": "2024-01-15T09:30:00Z",
          "last_updated_at": "2024-01-15T09:30:00Z",
          "created_by": "alice@example.com",
          "last_updated_by": "alice@example.com"
        }
      ],
      "trace_count": 150,
      "dataset_item_count": 10000,
      "created_at": "2024-01-15T09:30:00Z",
      "duration": {
        "p50": 120.5,
        "p90": 180,
        "p99": 240
      },
      "total_estimated_cost": 35.75,
      "total_estimated_cost_avg": 0.24,
      "usage": {
        "cpu_hours": 12.5,
        "gpu_hours": 3.2
      },
      "last_updated_at": "2024-01-20T15:45:00Z",
      "created_by": "alice@example.com",
      "last_updated_by": "bob@example.com",
      "status": "running",
      "experiment_scores": [
        {
          "name": "f1_score",
          "value": 0.82
        }
      ],
      "prompt_version": {
        "prompt_version_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "commit": "a1b2c3d4",
        "prompt_id": "c9bf9e57-1685-4c89-bafb-ff5af830be8a",
        "prompt_name": "Initial Prompt"
      },
      "prompt_versions": [
        {
          "prompt_version_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "commit": "a1b2c3d4",
          "prompt_id": "c9bf9e57-1685-4c89-bafb-ff5af830be8a",
          "prompt_name": "Initial Prompt"
        }
      ],
      "dataset_version_id": "e4eaaaf2-d142-11e1-b3e4-080027620cdd",
      "dataset_version_summary": {
        "id": "e4eaaaf2-d142-11e1-b3e4-080027620cdd",
        "version_hash": "abc123def456",
        "version_name": "v3",
        "change_description": "Added new customer segments",
        "tags": [
          "release",
          "stable"
        ]
      },
      "pass_rate": 0.95,
      "passed_count": 95,
      "total_count": 100,
      "assertion_scores": [
        {
          "name": "assertion_1",
          "value": 0.98
        }
      ]
    }
  ],
  "sortableBy": [
    "created_at",
    "name",
    "status"
  ]
}

Find experiments scoped to a project

Path parameters

projectIdstringRequiredformat: "uuid"

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

datasetIdstringOptionalformat: "uuid"

optimization_idstringOptionalformat: "uuid"

typesstringOptional

namestringOptional

dataset_deletedbooleanOptional

sortingstringOptional

filtersstringOptional

experiment_idsstringOptional

force_sortingbooleanOptionalDefaults to false

Response

Experiments page

pageinteger or null

sizeinteger or null

totallong or null

contentlist of objects or null

sortableBylist of strings or null

Path parameters

Query parameters

Response

Errors