List ModelDeployments

GET

https://host.com/apis/models/v2/workspaces/:workspace/deployments

GET

/apis/models/v2/workspaces/:workspace/deployments

$ curl https://host.com/apis/models/v2/workspaces/workspace/deployments \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "name": "llama-3.1-8b",
5       "workspace": "research-team-alpha",
6       "created_at": "2024-01-15T09:30:00Z",
7       "updated_at": "2024-01-15T09:30:00Z",
8       "entity_version": 1,
9       "config": "llama-config-v1",
10       "config_version": 1,
11       "id": "d3f9a7b2-8c4e-4f1a-9b2d-3e7a1f5c9b8e",
12       "project": "urn:project:ml-models/llama",
13       "status": "READY",
14       "status_message": "Deployment is active and serving requests.",
15       "status_history": [
16         {
17           "timestamp": "2024-01-15T09:00:00Z",
18           "status": "PENDING",
19           "status_message": "Deployment is being initialized."
20         },
21         {
22           "timestamp": "2024-01-15T09:30:00Z",
23           "status": "READY",
24           "status_message": "Deployment is active and serving requests."
25         }
26       ],
27       "model_provider_id": "provider-workspace/llama-provider",
28       "auth_context": {
29         "principal_id": "user-12345",
30         "principal_email": "alice@example.com",
31         "principal_groups": [
32           "ml-engineers",
33           "research-team-alpha"
34         ],
35         "principal_on_behalf_of": "user-67890",
36         "principal_on_behalf_of_groups": [
37           "data-scientists"
38         ],
39         "principal_on_behalf_of_email": "bob@example.com"
40       }
41     }
42   ],
43   "pagination": {
44     "page": 1,
45     "page_size": 10,
46     "current_page_size": 1,
47     "total_pages": 1,
48     "total_results": 1
49   },
50   "sort": "created_at",
51   "filter": {}
52 }

List ModelDeployments for a specific workspace. By default, returns only the latest version of each deployment.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptionalDefaults to 1

Page number.

page_sizeintegerOptionalDefaults to 100

Page size.

sortstringOptionalDefaults to created_at

The field to sort by. To sort in decreasing order, use - in front of the field name.

all_versionsbooleanOptionalDefaults to false

If true, return all versions of each deployment. If false (default), return only the latest version.

filterobjectOptional

Filter deployments by workspace, project, status, config, model_provider_id, name, status_message, created_at, and updated_at.

Response

Return model deployments for a workspace

datalist of objects

paginationobject

Pagination information.

sortstring

The field on which the results are sorted.

filtermap from strings to any

Filtering information.

Errors

422

Unprocessable Entity Error