助手列表

查询指定的智能体助手列表信息，包括智能体助手的详细配置、工具和元数据。

POST /paas/v4/assistant/list

助手列表

cURL

curl --request POST \
  --url https://open.bigmodel.cn/api/paas/v4/assistant/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id_list": [
    "65940acff94777010aa6b796",
    "assistant_2"
  ]
}
'

200

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": [
    {
      "assistant_id": "65940acff94777010aa6b796",
      "name": "通用智能助手",
      "avatar": "https://example.com/avatar.png",
      "description": "一个通用的`AI`助手，可以回答各种问题",
      "tools": [
        "web_search",
        "code_interpreter"
      ],
      "tags": [
        {
          "key": "category",
          "label": "通用助手"
        }
      ],
      "status": "active",
      "starter_prompts": [
        {}
      ],
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

使用以下格式进行身份验证：Bearer

Body

application/json

assistant_id_list · string[] · required

智能体ID列表，如果为空则查询所有可用智能体

Example:

["65940acff94777010aa6b796", "assistant_2"]

Response

200

application/json

业务处理成功

success · boolean

Example:

true

code · integer

Example:

200

msg · string

Example:

"操作成功"

data · object[]

Hide child attributes

data. assistant_id · string · required

智能体ID

Example:

"65940acff94777010aa6b796"

data. name · string · required

智能体名称

Example:

"通用智能助手"

data. avatar · string

智能体头像URL

Example:

"https://example.com/avatar.png"

data. description · string

智能体描述

Example:

"一个通用的AI助手，可以回答各种问题"

data. tools · string[]

智能体支持的工具列表

Example:

["web_search", "code_interpreter"]

data. tags · object[]

智能体标签列表

Hide child attributes

data.tags. key · string

标签键

Example:

"category"

data.tags. label · string

标签值

Example:

"通用助手"

data. status · string

智能体状态

Example:

"active"

data. starter_prompts · object[]

智能体的起始提示语

data. created_at · string

创建时间

Example:

"2024-01-01T00:00:00Z"

data. updated_at · string

更新时间

Example:

"2024-01-01T00:00:00Z"