Skip to main content
GET
/
api
/
v1
/
experiments
Get Experiment Details
curl --request GET \
  --url https://services.staging.app.dados.rio/eai-agent/api/v1/experiments \
  --header 'Authorization: Bearer <token>'
{
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "dataset_description": "<string>",
  "experiment_id": "<string>",
  "experiment_name": "<string>",
  "experiment_description": "<string>",
  "experiment_timestamp": "2023-11-07T05:31:56Z",
  "experiment_metadata": {},
  "execution_summary": {},
  "error_summary": {},
  "aggregate_metrics": [
    {}
  ],
  "runs": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dataset_id
string
required

The ID of the dataset.

experiment_id
string
required

The ID of the experiment to retrieve.

Response

Successful Response

dataset_id
string
required
dataset_name
string
required
dataset_description
string
required
experiment_id
string
required
experiment_name
string
required
experiment_description
string
required
experiment_timestamp
string<date-time>
required
experiment_metadata
object
required
execution_summary
object
required
error_summary
object
required
aggregate_metrics
Aggregate Metrics · object[]
required
runs
Runs · object[]
required