Query Agent List

POST

/api/v1/indices/rag/app/list

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/app/list" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_scene": "chat",
    "page_number": 1,
    "page_size": 20
}'

{
  "request_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
  "status_code": 200,
  "code": "Success",
  "message": "",
  "status": "SUCCESS",
  "success": true,
  "data": {
    "page_number": 1,
    "page_size": 20,
    "total_count": 2,
    "rows": [
      {
        "agent_id": "aid-8f3a1b2c4d5e6f70",
        "agent_name": "客服知识问答助手",
        "agent_scene": "chat",
        "agent_status": "deployed",
        "agent_version": "2",
        "create_time": "2026-07-10T14:30:00",
        "modify_time": "2026-07-15T09:15:00",
        "pipeline_list": [
          {
            "pipeline_id": "pipeline-xxxxxx",
            "pipeline_name": "产品文档知识库"
          }
        ]
      },
      {
        "agent_id": "aid-1a2b3c4d5e6f7a8b",
        "agent_name": "技术文档检索助手",
        "agent_scene": "chat",
        "agent_status": "draft",
        "agent_version": "beta",
        "create_time": "2026-07-12T10:00:00",
        "modify_time": "2026-07-12T10:00:00",
        "pipeline_list": [
          {
            "pipeline_id": "pipeline-yyyyyy",
            "pipeline_name": "技术文档知识库"
          },
          {
            "pipeline_id": "pipeline-zzzzzz",
            "pipeline_name": "FAQ 知识库"
          }
        ]
      }
    ]
  }
}

Paginated query of the Agent list under the current tenant, supporting filtering by scenario, status, name, and knowledge base ID.

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Body

application/json

enum<string>

required

Agent 场景：chat（知识问答）或 search（知识检索）。

Available options:chat,search

string

按状态过滤：draft / deployed（含 edited）/ deleted。

string

按名称模糊搜索。

string

精确匹配 Agent ID。

string

按关联知识库 Pipeline ID 过滤。

integer

default1

页码，默认 1。

integer

default10

每页条数，默认 10，上限 100。

Required range:x <= 100

Response

200-application/json

string

请求唯一标识，排查问题时请提供此 ID。

integer

HTTP 状态码。

string

响应码，成功时为 Success。

string

提示信息。

enum<string>

请求状态：SUCCESS 或 FAILED。

Available options:SUCCESS,FAILED

boolean

请求是否成功。

object

Show child attributes

integer

当前页码。

integer

每页条数。

integer

总记录数。

object[]

Agent 列表。

Show child attributes

string

Agent ID。

string

Agent 名称。

string

Agent 场景：chat 或 search。

string

Agent 状态：draft、deployed、edited、deleted。

string

Agent 当前版本号。

string

创建时间（ISO 8601 格式）。

string

修改时间（ISO 8601 格式）。

object[]

关联的知识库列表。

Show child attributes

string

知识库 Pipeline ID。

string

知识库名称。

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/app/list" \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "agent_scene": "chat", "page_number": 1, "page_size": 20 }'

{ "request_id": "e5f6a7b8-c9d0-1234-efab-345678901234", "status_code": 200, "code": "Success", "message": "", "status": "SUCCESS", "success": true, "data": { "page_number": 1, "page_size": 20, "total_count": 2, "rows": [ { "agent_id": "aid-8f3a1b2c4d5e6f70", "agent_name": "客服知识问答助手", "agent_scene": "chat", "agent_status": "deployed", "agent_version": "2", "create_time": "2026-07-10T14:30:00", "modify_time": "2026-07-15T09:15:00", "pipeline_list": [ { "pipeline_id": "pipeline-xxxxxx", "pipeline_name": "产品文档知识库" } ] }, { "agent_id": "aid-1a2b3c4d5e6f7a8b", "agent_name": "技术文档检索助手", "agent_scene": "chat", "agent_status": "draft", "agent_version": "beta", "create_time": "2026-07-12T10:00:00", "modify_time": "2026-07-12T10:00:00", "pipeline_list": [ { "pipeline_id": "pipeline-yyyyyy", "pipeline_name": "技术文档知识库" }, { "pipeline_id": "pipeline-zzzzzz", "pipeline_name": "FAQ 知识库" } ] } ] } }