查询 Agent 信息

GET 
/v1/aibot/bots/:botId

查询 Agent 信息

Request

Path Parameters

botId stringrequired

Responses

200

查询 AI Agent 成功时返回

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

botId string

Agent ID，由系统生成

name stringrequired

Agent 名称

introduction stringrequired

Agent 简介

welcomeMessage string

Agent 欢迎语

avatar string

Agent 头像链接

background string

Agent 聊天背景图链接

isNeedRecommend boolean

Agent 回答后是否推荐问题

type string

Agent 类型, text 或者 image

searchEnable boolean

是否开启联网搜索

Example (from schema)

{
  "botId": "bot-xxx",
  "name": "智能体",
  "introduction": "简介",
  "welcomeMessage": "欢迎欢迎",
  "avatar": "http://xxx.avatar.image",
  "background": "http://xxx.background.image",
  "isNeedRecommend": false,
  "type": "text",
  "searchEnable": false
}

default

查询 AI Agent 失败时返回

application/json

Schema

Schema

code string

错误代码

message string

错误信息

requestId string

请求ID

Example (from schema)

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

Loading...