Get VirtualModel

GET

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

GET

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

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

1 {
2   "workspace": "nemo-team-alpha",
3   "id": "a3f1c9e2-7b4d-4f8a-9d3e-2b7f5c6a1d9e",
4   "created_at": "2024-01-15T09:30:00Z",
5   "created_by": "jane.doe@nemo.ai",
6   "updated_at": "2024-04-10T14:45:00Z",
7   "updated_by": "john.smith@nemo.ai",
8   "entity_id": "a3f1c9e2-7b4d-4f8a-9d3e-2b7f5c6a1d9e",
9   "parent": "nemo-team-alpha",
10   "db_version": 3,
11   "name": "customer-support-bot",
12   "project": "customer-engagement",
13   "default_model_entity": "nemo-team-alpha/gpt4-customer-support",
14   "autoprovisioned": false,
15   "models": [
16     {
17       "model": "nemo-team-alpha/gpt4-customer-support",
18       "backend_format": "OPENAI_CHAT"
19     }
20   ],
21   "request_middleware": [
22     {
23       "name": "nemo-authenticator",
24       "config_type": "auth_config",
25       "config": {
26         "token_header": "Authorization",
27         "required": true
28       },
29       "config_id": ""
30     }
31   ],
32   "response_middleware": [
33     {
34       "name": "nemo-logger",
35       "config_type": "logging_config",
36       "config": {
37         "log_level": "info",
38         "destination": "cloud-logs"
39       },
40       "config_id": ""
41     }
42   ],
43   "post_response_middleware": [
44     {
45       "name": "nemo-metrics",
46       "config_type": "metrics_config",
47       "config": {
48         "enabled": true,
49         "metrics_endpoint": "https://metrics.nemo.ai"
50       },
51       "config_id": ""
52     }
53   ],
54   "override_proxy": "https://proxy.nemo.ai/v1"
55 }

Get a VirtualModel by workspace and name.

Path parameters

workspacestringRequired

namestringRequired

Response

VirtualModel details

workspacestringformat: "^[\w\-\+.@:]+$"

Workspace identifier

idstringRead-only

created_atdatetimeRead-only

created_bystring or nullRead-only

updated_atdatetimeRead-only

updated_bystring or nullRead-only

entity_idstringRead-only

Alias for id for backwards compatibility.

parentstringRead-only

Parent entity ID for nested entities.

db_versionintegerRead-only

Database version of the entity for optimistic locking.

namestringOptionalDefaults to

Entity name within the workspace

projectstringOptional

The name of the project associated with this entity.

default_model_entitystringOptional

autoprovisionedbooleanOptionalDefaults to false

Marks this VirtualModel as controller-managed. The Models controller will delete it once no ModelProvider serves the matching entity. Setting this manually opts the VirtualModel into that cleanup behavior.

modelslist of objectsOptional

request_middlewarelist of objectsOptionalDefaults to []

response_middlewarelist of objectsOptionalDefaults to []

post_response_middlewarelist of objectsOptionalDefaults to []

override_proxystringOptional

Errors

404

Not Found Error

422

Unprocessable Entity Error