This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Retrieve a single experiment with all metadata, parameters, series metadata, and summary metrics.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-read.
stringThe Resource Identifier (RID) of a Model.
stringThe Resource Identifier (RID) of an Experiment.
objectstringThe Resource Identifier (RID) of an Experiment.
stringThe Resource Identifier (RID) of a Model.
stringThe time at which the resource was created.
stringThe Foundry user who created this resource
unionThe source from which the experiment was created.
string (enum)The current status of an experiment.
Enum values: RUNNING, SUCCEEDED, FAILED
stringoptionalstringThe name of a Branch.
list<Parameter>optionallist<SeriesAggregations>optionallist<SummaryMetric>optionalmap<ExperimentArtifactName, ExperimentArtifactMetadata>optionallist<ExperimentTagText>optionalstringoptionalThe Resource Identifier (RID) of a Model Version.
stringoptionalThe RID of a Job.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{
"source": {
"type": "codeWorkspace",
"containerRid": "ri.foundry-container-service.main.container.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"deploymentRid": "ri.foundry-container-service.main.deployment.b2c3d4e5-f6a7-8901-bcde-f12345678901"
},
"rid": "ri.models.main.experiment.abc123",
"branch": "master",
"summaryMetrics": [
{
"seriesName": "loss",
"aggregation": "LAST",
"value": 0.07
}
],
"tags": [
"production"
],
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"series": [
{
"name": "loss",
"length": 100,
"value": {
"type": "double",
"min": 0.05,
"max": 1.5,
"last": 0.07
}
}
],
"linkedModelVersion": "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee",
"createdTime": "2003-05-06T12:34:56.789Z",
"jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448",
"parameters": [
{
"name": "learning_rate",
"value": {
"type": "double",
"value": 0.001
}
}
],
"modelRid": "ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9",
"status": "RUNNING",
"artifacts": {
"predictions_table": {
"name": "predictions_table",
"description": "Test set predictions",
"sizeBytes": 4096,
"details": {
"type": "table",
"rowCount": 100
}
}
}
}| Error Name | ||
|---|---|---|
Model | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested experiment was not found or the user lacks permission to access it. | |
| Parameters | modelRid, experimentRid | |
Experiment | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Experiment could not be found. | |
| Parameters | experimentRid, modelRid | |
See Errors for a general overview of errors in the platform.