List ModelProviders By Workspace

GET

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

GET

/apis/models/v2/workspaces/:workspace/providers

$ curl https://host.com/apis/models/v2/workspaces/workspace/providers \
>      -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-04-10T14:45:00Z",
8       "host_url": "https://models.research-alpha.example.com/api/v1/inference",
9       "id": "provider-12345",
10       "project": "project-ml-2024",
11       "description": "LLaMA 3.1 8B parameter model provider for research experiments",
12       "api_key_secret_name": "secret-llama-api-key",
13       "served_models": [
14         {
15           "model_entity_id": "research-team-alpha/llama-3.1-8b",
16           "served_model_name": "llama-3.1-8b-v1"
17         }
18       ],
19       "enabled_models": [
20         "llama-3.1-8b-v1",
21         "llama-3.1-8b-v2"
22       ],
23       "status": "READY",
24       "status_message": "Model provider is operational and ready to serve requests.",
25       "default_extra_body": {
26         "temperature": 0.7,
27         "max_tokens": 1024
28       },
29       "default_extra_headers": {
30         "X-Custom-Header": "NemoPlatform"
31       },
32       "required_extra_body": {},
33       "required_extra_headers": {
34         "Authorization": "Bearer"
35       },
36       "model_deployment_id": "deployment-98765",
37       "auth_context": {
38         "principal_id": "user-7890",
39         "principal_email": "alice@example.com",
40         "principal_groups": [
41           "ml-researchers",
42           "data-science"
43         ],
44         "principal_on_behalf_of": "user-1234",
45         "principal_on_behalf_of_groups": [
46           "admin",
47           "devops"
48         ],
49         "principal_on_behalf_of_email": "admin@example.com"
50       },
51       "auth_header_format": "Authorization: Bearer {{ auth_secret }}"
52     }
53   ],
54   "pagination": {
55     "page": 1,
56     "page_size": 10,
57     "current_page_size": 1,
58     "total_pages": 1,
59     "total_results": 1
60   },
61   "sort": "created_at",
62   "filter": {}
63 }

List model providers for a specific workspace.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptionalDefaults to 1

Page number.

page_sizeintegerOptionalDefaults to 100

Page size.

sortenumOptionalDefaults to created_at

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

filterobjectOptional

Filter model providers by workspace, project, status, model_deployment_id, name, description, host_url, created_at, and updated_at.

Response

Return model providers 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