Get experiment by id | Opik Documentation

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);

{
  "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"
    ]
  }
}

Get experiment by id

Path parameters

idstringRequiredformat: "uuid"

Response

Experiment resource

dataset_namestring>=1 character

idstring or nullformat: "uuid"

dataset_idstring or nullRead-onlyformat: "uuid"

project_idstring or nullRead-onlyformat: "uuid"

project_namestring or nullRead-only

namestring or null

metadatamap from strings to any or list of objects or string or null

tagslist of strings or null

typeenum or null

Allowed values:

optimization_idstring or nullformat: "uuid"

feedback_scoreslist of objects or nullRead-only

commentslist of objects or nullRead-only

trace_countlong or nullRead-only

created_atstring or nullRead-onlyformat: "date-time"

durationobject or null

total_estimated_costdouble or nullRead-only

total_estimated_cost_avgdouble or nullRead-only

usagemap from strings to doubles or nullRead-only

last_updated_atstring or nullRead-onlyformat: "date-time"

created_bystring or nullRead-only

last_updated_bystring or nullRead-only

statusenum or null

Allowed values:

experiment_scoreslist of objects or null

prompt_versionobject or null

prompt_versionslist of objects or null

dataset_version_idstring or nullformat: "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 or nullRead-only

Summary of the latest dataset version

Path parameters

Response

Errors