Query Agent List Information

GET 
/v1/aibot/bots

Query Agent List Information

Request

Query Parameters

name string
Agent name fuzzy query
Example: Name
introduction string
Agent introduction fuzzy query
Example: Introduction
information string
Agent information fuzzy query (query name and introduction)
Example: Information
enable boolean
Whether the Agent is enabled
Example: true
pageSize number
Pagination parameter, default is 10
Example: 10
pageNumber number
Pagination parameter, default is 1
Example: 1

Responses

200

Returned when AI Agent query is successful

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 link
background string
Agent chat background image link
isNeedRecommend boolean
Whether the Agent recommends questions after answering
type string
Agent type, text or image
searchEnable boolean
Whether to enable online search
]
total numberrequired

Total number of Agents

Example (from schema)

{
  "botList": [
    {
      "botId": "bot-xxx",
      "name": "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 AI Agent query 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...