查询模型配置列表

查询工作区内的智能体模型配置。

GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/model-configs

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:要查询的工作区 ID,通过 X-Workspace-ID Header 传递,同时作为路径中的 workspace_id

路径参数

参数

类型

是否必填

说明

workspace_id

string

当前工作区 ID,必须与 X-Workspace-ID 一致。

查询参数

参数

类型

是否必填

说明

status

string

按配置状态筛选。

source_kind

string

按模型来源类型筛选。

model_category

string

按模型类别筛选。

provider_ref

string

按提供商引用筛选。

query

string

按名称或相关文本查询。

limit

integer

返回数量上限。

offset

integer

返回偏移量。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/model-configs?model_category=chat&limit=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200data.items 为模型配置,data.totaldata.limitdata.offset 描述列表范围。

{
  "code": 0,
  "data": {
    "items": [
      {
        "id": "mc_01",
        "name": "销售分析模型",
        "status": "active",
        "source_kind": "workspace",
        "model_category": "chat",
        "model_name": "<MODEL_NAME>",
        "version": 1
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

响应字段如下。

本文中,字段路径中的 [] 表示数组中的每一项。例如,items[].name 表示 items 数组中每一项的 name 字段。

字段

类型

说明

code

integer

成功时为 0

data.items[]

array

模型配置列表。

data.items[].id

string

模型配置 ID。

data.items[].name

string

配置名称。

data.items[].status

string

配置状态。

data.items[].source_kind

string

模型来源类型。

data.items[].model_category

string

模型类别。

data.items[].model_name

string

模型名称。

data.items[].version

integer

配置版本。

data.total

integer

筛选结果总数、当前返回上限和偏移量。

data.limit

integer

筛选结果总数、当前返回上限和偏移量。

data.offset

integer

筛选结果总数、当前返回上限和偏移量。

错误响应

{
  "code": 2,
  "message": "模型配置参数无效"
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

2INVALID_ARGUMENT

工作区或筛选参数无效。

检查路径和查询参数。

401

6UNAUTHENTICATED

凭据缺失或无效。

检查 API Key。

403

5PERMISSION_DENIED

当前身份没有读取工作区配置的权限。

使用有权限的凭据,或联系管理员授权。

503

15UNAVAILABLE

模型配置服务不可用。

稍后重试。

后续操作

使用配置 ID 查询模型配置详情

最后更新于