Query Agent Information

GET 
/v1/aibot/bots/:botId

Query Agent Information

Request

Path Parameters

botId stringrequired

Responses

200

Returned when AI Agent query is successful

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

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 to recommend questions after the Agent answers

type string

Agent type, text or image

searchEnable boolean

Whether to enable online search

Example (from schema)

{
  "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
}

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...