Query model configuration details¶
Read model selection, capabilities and reference information for an agent model configuration.
GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/model-configs/{model_config_id}
Before you call¶
First query the model configuration list to obtain the configuration ID. Prepare a personal access token and target workspace ID that has access to the target workspace.
The example below uses:
$AI_STUDIO_API_KEY: The actual personal access token, passed through theX-API-KeyHeader.$WORKSPACE_ID: Target workspace ID, passed through theX-Workspace-IDHeader and also asworkspace_idin the path.$MODEL_CONFIG_ID: The model configuration ID to query asmodel_config_idin the path.
Request example¶
curl "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/model-configs/$MODEL_CONFIG_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
Path parameters¶
Parameters |
Type |
Is it required |
Description |
|---|---|---|---|
|
string |
Yes |
The current workspace ID. |
|
string |
Yes |
Model configuration ID. |
Successful response¶
Returns 200 on success.
{
"code": 0,
"data": {
"id": "mc_01",
"workspace_id": "ws_01",
"name": "销售分析模型",
"status": "active",
"source_kind": "workspace",
"model_category": "chat",
"model_name": "<MODEL_NAME>",
"parameters": {},
"capabilities": [
"tool_calling"
],
"version": 1,
"created_at": "2026-08-18T01:00:00Z",
"updated_at": "2026-08-18T01:00:00Z"
}
}
The response fields are as follows.
Field |
Type |
Description |
|---|---|---|
|
integer |
|
|
string |
Model configuration ID. |
|
string |
ID of the workspace to which it belongs. |
|
string |
Configuration name and description; description is only returned if there is a value. |
|
string |
Configuration name and description; description is only returned if there is a value. |
|
string |
Configuration status, source type, and model category. |
|
string |
Configuration status, source type, and model category. |
|
string |
Configuration status, source type, and model category. |
|
string |
Provider reference, model name, and display name. |
|
string |
Provider reference, model name, and display name. |
|
string |
Provider reference, model name, and display name. |
|
string |
Connection and credential reference; only returned if there is a value. |
|
string |
Connection and credential reference; only returned if there is a value. |
|
object |
Model parameters, parameter schema, and constraints; returned only if there is a value. |
|
object |
Model parameters, parameter schema, and constraints; returned only if there is a value. |
|
object |
Model parameters, parameter schema, and constraints; returned only if there is a value. |
|
string[] |
Model capabilities; only returned if there is a value. |
|
integer |
Configuration version. |
|
string |
Creation and update time. |
|
string |
Creation and update time. |
[] after a type denotes an array. [] in a field path denotes each item in an array.
Error response¶
{
"code": 3,
"message": "模型配置不存在"
}
Common HTTP errors¶
HTTP status code |
error code |
Common causes |
Recommended actions |
|---|---|---|---|
|
|
The path parameter is invalid. |
Check workspace and model configuration IDs. |
|
|
Credentials are missing or invalid. |
Check API Key. |
|
|
The current identity does not have read permission. |
Use valid credentials, or contact your administrator for authorization. |
|
|
The model configuration does not exist. |
First query the model configuration list. |
|
|
The model configuration service is unavailable. |
Try again later. |
Follow-up operations¶
Use Update model configuration to modify variable fields.