Query Agent list

GET 
/v1/aibot/bots

Query Agent list

Request

Query Parameters

name string
Fuzzy search by Agent name
Example: Name
introduction string
Fuzzy search by Agent introduction
Example: Introduction
information string
Fuzzy search by Agent information (name and introduction)
Example: Information
enable boolean
Whether the Agent is enabled
Example: true
pageSize number
Pagination size, defaults to 10
Example: 10
pageNumber number
Pagination page number, defaults to 1
Example: 1

Responses

200

Returned when the AI Agent list is queried successfully

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

botList object[]required
Agent list
Array [
botId string
Agent ID generated by the system
name stringrequired
Agent name
introduction stringrequired
Agent introduction
welcomeMessage string
Agent welcome message
avatar string
Agent avatar URL
background string
Agent chat background image URL
isNeedRecommend boolean
Whether to recommend follow-up questions after the Agent replies
type string
Agent type, text or image
searchEnable boolean
Whether web search is enabled
]
total numberrequired

Total number of Agents

Example (from schema)

{
  "botList": [
    {
      "botId": "bot-xxx",
      "name": "Intelligent Agent",
      "introduction": "Introduction",
      "welcomeMessage": "Welcome!",
      "avatar": "http://xxx.avatar.image",
      "background": "http://xxx.background.image",
      "isNeedRecommend": false,
      "type": "text",
      "searchEnable": false
    }
  ],
  "total": 10
}

default

Returned when querying AI Agents fails

application/json

Schema

Schema

code string

Error code

message string

Error message

requestId string

Request ID

Example (from schema)

{
  "code": "INVALID_CREDENTIALS",
  "message": "Credentials are invalid",
  "requestId": "6360ba4b-f672-434b-9dee-35686a5589a4"
}

Loading...