List VirtualModels

GET

https://host.com/apis/inference-gateway/v2/workspaces/:workspace/virtual-models

GET

/apis/inference-gateway/v2/workspaces/:workspace/virtual-models

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

1 {
2   "data": [
3     {
4       "workspace": "team-alpha",
5       "id": "vm-123e4567-e89b-12d3-a456-426614174000",
6       "created_at": "2024-01-15T09:30:00Z",
7       "created_by": "alice@example.com",
8       "updated_at": "2024-04-10T14:45:00Z",
9       "updated_by": "bob@example.com",
10       "entity_id": "vm-123e4567-e89b-12d3-a456-426614174000",
11       "parent": "",
12       "name": "customer-support-chatbot",
13       "project": "urn:project:alpha-chatbot",
14       "default_model_entity": "team-alpha/gpt-4-chat",
15       "autoprovisioned": false,
16       "models": [
17         {
18           "model": "team-alpha/gpt-4-chat",
19           "backend_format": "OPENAI_CHAT"
20         }
21       ],
22       "request_middleware": [
23         {
24           "name": "auth-middleware",
25           "config_type": "auth_config",
26           "config": {
27             "token_header": "Authorization",
28             "token_prefix": "Bearer"
29           },
30           "config_id": ""
31         }
32       ],
33       "response_middleware": [
34         {
35           "name": "response-logger",
36           "config_type": "logging_config",
37           "config": {
38             "log_level": "INFO",
39             "destination": "cloud-logs"
40           },
41           "config_id": ""
42         }
43       ],
44       "post_response_middleware": [
45         {
46           "name": "metrics-collector",
47           "config_type": "metrics_config",
48           "config": {
49             "enabled": true,
50             "metrics_endpoint": "https://metrics.example.com/collect"
51           },
52           "config_id": ""
53         }
54       ],
55       "override_proxy": "proxy.team-alpha.internal:8080"
56     }
57   ],
58   "pagination": {
59     "page": 1,
60     "page_size": 20,
61     "current_page_size": 1,
62     "total_pages": 1,
63     "total_results": 1
64   },
65   "sort": "-created_at",
66   "filter": {}
67 }

List VirtualModels for the given workspace.

Use workspace=- to list across all workspaces accessible to the caller.

Path parameters

workspacestringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number (1-indexed).

page_sizeintegerOptional1-200Defaults to 20

Number of results per page.

sortstringOptionalDefaults to -created_at

Sort field. Prefix with - for descending order.

exclude_autoprovisionedbooleanOptionalDefaults to false

When true, controller-managed (autoprovisioned) passthrough VirtualModels are excluded from the results.

filterobjectOptional

Filter virtual models by workspace, project, name, default_model_entity, created_at, and updated_at.

Response

Paginated list of virtual models

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