Get Model by Workspace and Name

GET

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

GET

/apis/models/v2/workspaces/:workspace/models/:name

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

1 {
2   "id": "model-1234abcd",
3   "name": "llama-3.1-8b",
4   "workspace": "research-team",
5   "created_at": "2024-01-15T09:30:00Z",
6   "updated_at": "2024-04-10T12:00:00Z",
7   "project": "urn:project:ai-models",
8   "description": "LLaMA 3.1 8B parameter model fine-tuned for conversational AI tasks.",
9   "spec": {
10     "checkpoint_model_name": "llama-3.1-8b-v1",
11     "family": "llama",
12     "num_layers": 32,
13     "hidden_size": 5120,
14     "num_attention_heads": 40,
15     "num_kv_heads": 40,
16     "ffn_hidden_size": 13824,
17     "vocab_size": 32000,
18     "tied_embeddings": true,
19     "gated_mlp": true,
20     "base_num_parameters": 8000000000,
21     "precision": "float16",
22     "context_size": 4096,
23     "num_virtual_tokens": 20,
24     "is_chat": true,
25     "is_embedding_model": false,
26     "moe_config": {
27       "num_experts": 16,
28       "num_experts_per_tok": 2,
29       "num_expert_layers": 4,
30       "expert_ffn_size": 16384,
31       "num_shared_experts": 0
32     },
33     "mamba_config": {
34       "is_hybrid": true,
35       "num_mamba_layers": 6,
36       "num_attention_layers": 2,
37       "num_mlp_layers": 2,
38       "state_size": 16,
39       "conv_kernel": 4
40     },
41     "sliding_window_config": {
42       "window_size": 512
43     },
44     "linear_layers": [
45       {
46         "name": "model.layers.0.self_attn.q_proj",
47         "in_features": 5120,
48         "out_features": 5120
49       },
50       {
51         "name": "model.layers.0.mlp.fc1",
52         "in_features": 5120,
53         "out_features": 13824
54       }
55     ],
56     "chat_template": "You are a helpful assistant. {{icl_few_shot_examples}}",
57     "tool_call_config": {
58       "tool_call_parser": "openai",
59       "tool_call_plugin": "research-team/tool-call-plugin-v1",
60       "auto_tool_choice": true
61     },
62     "minimum_gpus_all_weights": 4,
63     "minimum_gpus_lora": 1
64   },
65   "finetuning_type": "lora_merged",
66   "fileset": "research-team/llama-3.1-8b-fileset",
67   "trust_remote_code": false,
68   "base_model": "research-team/llama-3.0-8b",
69   "api_endpoint": {
70     "url": "https://api.nemo-platform.com/v1/models/llama-3.1-8b/infer",
71     "model_id": "llama-3.1-8b",
72     "api_key": "api_key_abcdef123456",
73     "format": "openai"
74   },
75   "backend_format": "OPENAI_CHAT",
76   "adapters": [
77     {
78       "name": "lora-adapter-v1",
79       "workspace": "research-team",
80       "fileset": "research-team/lora-medical-adapter",
81       "finetuning_type": "lora_merged",
82       "description": "LoRA adapter for domain-specific fine-tuning on medical data.",
83       "enabled": true,
84       "lora_config": {
85         "rank": 8,
86         "alpha": 32
87       },
88       "model": "research-team/llama-3.1-8b",
89       "created_at": "2024-02-01T10:00:00Z",
90       "updated_at": "2024-03-01T10:00:00Z"
91     }
92   ],
93   "prompt": {
94     "system_prompt": "You are a helpful assistant specialized in technical support.",
95     "icl_few_shot_examples": "User: How do I reset my password?\nAssistant: To reset your password, go to the settings page and click 'Reset Password'.",
96     "inference_params": {
97       "model": "llama-3.1-8b",
98       "temperature": 0.7,
99       "max_tokens": 512,
100       "max_completion_tokens": 256,
101       "top_p": 0.9,
102       "stop": [
103         "\nUser:",
104         "\nAssistant:"
105       ]
106     },
107     "system_prompt_template": "System: {{system_prompt}}\nExamples:\n{{icl_few_shot_examples}}"
108   },
109   "custom_fields": {
110     "license": "Apache-2.0",
111     "tags": [
112       "conversational",
113       "llama",
114       "8b",
115       "fine-tuned"
116     ]
117   },
118   "ownership": {
119     "owner": "research-team",
120     "contact_email": "ai-team@research.example.com"
121   },
122   "model_providers": [
123     "providers/openai-gpt",
124     "providers/nvidia-t4"
125   ]
126 }

Get Model by Workspace and Name. Returns the details of a specific model entity identified by its workspace and name.

Path parameters

workspacestringRequired

namestringRequired

Query parameters

verbosebooleanOptionalDefaults to false

Whether to include full spec details

Response

Return model details

idstring

Autogenerated id

namestringformat: "^[\w\-.]+$"<=255 characters

Name of the entity. Name/workspace combo must be unique across all entities. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

workspacestringformat: "^[\w\-.]+$"<=255 characters

The workspace of the entity. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

created_atdatetime

The timestamp of model entity creation

updated_atdatetime

The timestamp of the last model entity update

projectstringOptional<=255 characters

The URN of the project associated with this model entity.

descriptionstringOptional<=1000 characters

Optional description of the model.

specobjectOptional

Detailed specification for the model

finetuning_typeenumOptional

Set for full weight finetuned models

filesetstringOptional

A set of checkpoint files, configs, and other auxiliary info associated with this model - expected format {workspace}/{fileset_name}

trust_remote_codebooleanOptionalDefaults to false

Whether to trust remote code to load this model checkpoint.

base_modelstringOptional

Link to another model which is used as a base for the current model

api_endpointobjectOptional

Data about the inference endpoint for this model

backend_formatenum or nullOptional

Inference API wire format expected by the backend. If unset, inference routing treats the model as OPENAI_CHAT.

adapterslist of objectsOptional

Adapters that have been created against this model

promptobjectOptional

Configuration for prompt engineering

custom_fieldsmap from strings to anyOptional

Custom fields for additional metadata

ownershipmap from strings to anyOptional

Ownership information for the model

model_providerslist of stringsOptional

List of ModelProvider workspace/name resource names that provide inference for this Model Entity

Errors

422

Unprocessable Entity Error