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.
Search experiments using complex nested queries on experiment metadata, parameters, series, and summary metrics. Supports AND/OR/NOT combinations and various predicates. Returns a maximum of 100 results per page.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-read.
objectunionoptionalOptional search filter for filtering experiments. If not provided, all experiments for the model are returned.
objectoptionalThe field to sort by. Default is to sort by relevance.
integeroptionalThe maximum number of results to return. Default 50, maximum of 100.
stringoptionalPageToken to identify the next page to retrieve. Leave empty for the first request.
objectResponse from searching experiments.
list<Experiment>optionalList of experiments matching the search criteria.
stringoptionalToken for retrieving the next page of results, if more results are available.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/search?preview=true" \
-d '{"orderBy":{"field":"EXPERIMENT_NAME","direction":"ASC"},"pageSize":100,"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'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
58
59
60
61
62
{
"data": [
{
"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
}
}
}
}
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}| Error Name | ||
|---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The search filter is invalid. This can occur when using an unsupported operator and value type combination in a parameter filter, filtering by an unsupported status, or providing a malformed filter. | |
| Parameters | reason | |
Search | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not search the Experiment. | |
| Parameters | modelRid | |
See Errors for a general overview of errors in the platform.