Get VirtualModel

GET

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

GET

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

$ curl /apis/inference-gateway/v2/workspaces/workspace/virtual-models/name

1 {
2   "workspace": "string",
3   "id": "string",
4   "created_at": "2024-01-15T09:30:00Z",
5   "created_by": "string",
6   "updated_at": "2024-01-15T09:30:00Z",
7   "updated_by": "string",
8   "entity_id": "string",
9   "parent": "string",
10   "db_version": 1,
11   "name": "",
12   "project": "string",
13   "default_model_entity": "string",
14   "autoprovisioned": false,
15   "models": [
16     {
17       "model": "string",
18       "backend_format": "OPENAI_CHAT"
19     }
20   ],
21   "request_middleware": [
22     {
23       "name": "string",
24       "config_type": "string",
25       "config": {},
26       "config_id": "string"
27     }
28   ],
29   "response_middleware": [
30     {
31       "name": "string",
32       "config_type": "string",
33       "config": {},
34       "config_id": "string"
35     }
36   ],
37   "post_response_middleware": [
38     {
39       "name": "string",
40       "config_type": "string",
41       "config": {},
42       "config_id": "string"
43     }
44   ],
45   "override_proxy": "string",
46   "guardrail_config_ids": [
47     "string"
48   ]
49 }

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

guardrail_config_idslist of stringsOptional

System-managed. Guardrail configs applied by this VirtualModel’s middleware, as “workspace/name” references. Derived from the middleware pipelines on every write and ignored if supplied on a create or update body. Filter on it with filter[guardrail_config].

Errors

404

Not Found Error

422

Unprocessable Entity Error