> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://www.comet.com/docs/opik/_mcp/server.

# Get experiment by id

GET http://localhost:5173/api/v1/private/experiments/{id}

Get experiment by id

Reference: https://www.comet.com/docs/opik/reference/rest-api/experiments/get-experiment-by-id

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

Experiment resource

- `dataset_name` (string, required, nullable)
- `id` (string, optional)
- `dataset_id` (string, optional)
- `project_id` (string, optional) — Project ID. Takes precedence over project_name when both are provided.
- `project_name` (string, optional) — Project name. Creates project if it doesn't exist. Ignored when project_id is provided.
- `name` (string, optional)
- `metadata` (map from string to any or list of object or string, optional)
- `tags` (list of string, optional)
- `type` (enum, optional)
  - Allowed values: `regular`, `trial`, `mini-batch`, `mutation`
- `evaluation_method` (enum, optional)
  - Allowed values: `dataset`, `evaluation_suite`
- `optimization_id` (string, optional)
- `feedback_scores` (list of object, optional)
  - `name` (string, required)
  - `value` (double, required)
- `comments` (list of object, optional)
  - `text` (string, required)
  - `id` (string, optional)
  - `source_queue_id` (string, optional)
  - `created_at` (datetime, optional)
  - `last_updated_at` (datetime, optional)
  - `created_by` (string, optional)
  - `last_updated_by` (string, optional)
- `trace_count` (long, optional)
- `dataset_item_count` (long, optional)
- `created_at` (datetime, optional)
- `duration` (object, optional)
  - `p50` (double, optional)
  - `p90` (double, optional)
  - `p99` (double, optional)
- `total_estimated_cost` (double, optional)
- `total_estimated_cost_avg` (double, optional)
- `usage` (map from string to double, optional)
- `last_updated_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_by` (string, optional)
- `status` (enum, optional)
  - Allowed values: `running`, `completed`, `cancelled`
- `experiment_scores` (list of object, optional)
  - `name` (string, required)
  - `value` (double, required)
- `prompt_version` (object, optional)
  - `prompt_version_id` (string, optional)
  - `commit` (string, optional)
  - `prompt_id` (string, optional)
  - `prompt_name` (string, optional)
- `prompt_versions` (list of object, optional)
  - `prompt_version_id` (string, optional)
  - `commit` (string, optional)
  - `prompt_id` (string, optional)
  - `prompt_name` (string, optional)
- `dataset_version_id` (string, optional) — 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_summary` (object, optional) — Summary of the latest dataset version
  - `id` (string, optional) — Unique identifier of the version
  - `version_hash` (string, optional) — Hash of the version content
  - `version_name` (string, optional) — Sequential version name formatted as 'v1', 'v2', etc.
  - `change_description` (string, optional) — Description of changes in this version
  - `tags` (list of string, optional) — Tags associated with this version
- `pass_rate` (double, optional) — Pass rate for test suite experiments (0.0-1.0). Null for regular experiments.
- `passed_count` (long, optional) — Number of items that passed for test suite experiments. Null for regular experiments.
- `total_count` (long, optional) — Total number of items for test suite experiments. Null for regular experiments.
- `assertion_scores` (list of object, optional) — Per-assertion average pass rates for test suite experiments. Null for regular experiments.
  - `name` (string, required)
  - `value` (double, required)

## Errors

### 404 Not Found Error

Not found

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Examples

**Response**

```json
{
  "dataset_name": "string",
  "id": "string",
  "dataset_id": "string",
  "project_id": "string",
  "project_name": "string",
  "name": "string",
  "metadata": {},
  "tags": [
    "string"
  ],
  "type": "regular",
  "evaluation_method": "dataset",
  "optimization_id": "string",
  "feedback_scores": [
    {
      "name": "string",
      "value": 1.1
    }
  ],
  "comments": [
    {
      "text": "string",
      "id": "string",
      "source_queue_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,
  "dataset_item_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": {
    "prompt_version_id": "string",
    "commit": "string",
    "prompt_id": "string",
    "prompt_name": "string"
  },
  "prompt_versions": [
    {
      "prompt_version_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"
    ]
  },
  "pass_rate": 1.1,
  "passed_count": 1,
  "total_count": 1,
  "assertion_scores": [
    {
      "name": "string",
      "value": 1.1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/experiments/id"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/experiments/id';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/experiments/id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/experiments/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:5173/api/v1/private/experiments/id")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/experiments/id');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/experiments/id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/experiments/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```