跳到主要内容

根据ID获取智能体

GET 

/v1/agents/:agentId

根据智能体ID获取单个智能体的详细信息,包括基本信息、分类、媒体资源和权限设置。

Request

Path Parameters

NameTypeRequiredDescription
agentIdinteger (int64)required智能体ID
Example: 1

Body

No request body

Responses

Responses

application/json
codeinteger
响应状态码,0表示成功
Example: 0
integer
响应状态码,0表示成功
messagestring
响应消息
Example: "success"
string
响应消息
dataobject
idinteger(int64)
智能体ID
Example: 1
integer (int64)
智能体ID
namestring
智能体名称
Example: "智能客服助手"
string
智能体名称
descriptionstring
智能体描述
Example: "这是一个智能客服助手,可以回答用户常见问题"
string
智能体描述
typestring
智能体类型
Example: "bot"
string
智能体类型
statusstring
智能体状态
Example: "active"
string
智能体状态
categoryIdinteger(int64)
分类ID
Example: 1
integer (int64)
分类ID
avatarstring
头像URL
Example: "https://cdn.example.com/avatars/agent1.png"
string
头像URL
coverImagestring
封面图URL
Example: "https://cdn.example.com/covers/agent1.jpg"
string
封面图URL
demoVideostring
演示视频URL
Example: "https://cdn.example.com/videos/agent1.mp4"
string
演示视频URL
permissionstring
权限设置
Example: "public"
string
权限设置
allowSourceDownloadboolean
是否允许下载源码
Example: false
boolean
是否允许下载源码
platformIdstring
平台资产ID(来自Coze、豆包等)
Example: "coze_bot_123456"
string
平台资产ID(来自Coze、豆包等)
platformTypestring
平台类型
Example: "coze"
string
平台类型
pricingobject
计费信息
typestring
计费类型
Example: "subscription"
string
计费类型
pricenumber(float)
价格
Example: 99
number (float)
价格
currencystring
货币单位
Example: "CNY"
string
货币单位
createdAtstring(date-time)
创建时间
Example: "2025-01-01T00:00:00Z"
string (date-time)
创建时间
updatedAtstring(date-time)
更新时间
Example: "2025-01-02T00:00:00Z"
string (date-time)
更新时间
requestIdstring
请求唯一ID
Example: "req_123456789"
string
请求唯一ID

Response Info

Status Code:200
Description:成功获取智能体信息
Content Types:
application/json