List Agents

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": "Customer Service Q&A Assistant",
        "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": "Product Documentation Knowledge Base"
          }
        ]
      },
      {
        "agent_id": "aid-1a2b3c4d5e6f7a8b",
        "agent_name": "Technical Documentation Search Assistant",
        "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": "Technical Documentation Knowledge Base"
          },
          {
            "pipeline_id": "pipeline-zzzzzz",
            "pipeline_name": "FAQ Knowledge Base"
          }
        ]
      }
    ]
  }
}

Paginated query of Agents under the current tenant, supports filtering by scene, status, name, and Knowledge Base ID.

Authorizations

string

header

required

DashScope API Key, obtained from the API Key page in the console.

Body

application/json

enum<string>

required

Agent scene: chat (knowledge Q&A) or search (knowledge retrieval).

Available options:chat,search

string

Filter by status: draft / deployed (includes edited) / deleted.

string

Fuzzy search by name.

string

Exact match by Agent ID.

string

Filter by associated knowledge base Pipeline ID.

integer

default1

Page number, default 1.

integer

default10

Number of items per page, default 10, maximum 100.

Required range:x <= 100

Response

200-application/json

string

Unique request identifier. Provide this ID when troubleshooting issues.

integer

HTTP status code.

string

Response code. Success on success.

string

Informational message.

enum<string>

Request status: SUCCESS or FAILED.

Available options:SUCCESS,FAILED

boolean

Whether the request succeeded.

object

Show child attributes

integer

Current page number.

integer

Number of items per page.

integer

Total number of records.

object[]

List of Agents.

Show child attributes

string

Agent ID.

string

Agent name.

string

Agent scene: chat or search.

string

Agent status: draft, deployed, edited, deleted.

string

Current Agent version number.

string

Creation time (ISO 8601).

string

Modification time (ISO 8601).

object[]

List of associated knowledge bases.

Show child attributes

string

Knowledge base Pipeline ID.

string

Knowledge base name.

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": "Customer Service Q&A Assistant", "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": "Product Documentation Knowledge Base" } ] }, { "agent_id": "aid-1a2b3c4d5e6f7a8b", "agent_name": "Technical Documentation Search Assistant", "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": "Technical Documentation Knowledge Base" }, { "pipeline_id": "pipeline-zzzzzz", "pipeline_name": "FAQ Knowledge Base" } ] } ] } }