查询用户应用详情
更新时间：2025-06-05
POST
https://qianfan.baidubce.com/v2/app?Action=DescribeApp
该接口查询用户下状态为已发布的应用详情。
权限说明
调用本API，需使用API Key鉴权方式。Authorization的值为Bearer <API Key>。获取API Key流程，请查看授权。
请求参数
Headers 参数
除公共头域外，无其它特殊头域
Body 参数
id
string
应用id
必选
请求结构
POST /v2/app?Action=DescribeApp HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json
{
"id": "appId"
}示例代码
curl
curl --location 'https://qianfan.baidubce.com/v2/app?Action=DescribeApp' \
--header 'Authorization: Bearer <API Key>' \
--header 'Content-Type: application/json' \
--data '{
"id": "405d90c0-474c-4ff1-a2ed-3070a66dc7ae"
}'返回响应
Headers 参数
除公共头域外，无其它特殊头域
返回参数
id
string
应用id
必选
name
string
应用名称
必选
prologue
string
开场白
必选
components
array
引用组件列表
必选
显示子属性
隐藏子属性
items
object {3}
显示子属性
隐藏子属性
name
string
组件名称
可选
customDesc
string
组件自定义描述
可选
description
string
组件描述
可选
requestId
string
requestId
必选
description
string
应用描述
必选
modelConfig
object {2}
模型配置
必选
显示子属性
隐藏子属性
chat
object {4}
对话模型配置
必选
显示子属性
隐藏子属性
model
string
模型名称
必选
config
object {2}
rag模型配置
必选
显示子属性
隐藏子属性
topP
float
必选
temperature
float
必选
modelId
string
模型id
必选
historyChatRounds
string
历史对话参考轮数
必选
plan
object {4}
思考模型配置
必选
显示子属性
隐藏子属性
model
string
模型名称
必选
config
object {2}
rag模型配置
必选
显示子属性
隐藏子属性
topP
float
必选
temperature
float
必选
modelId
string
模型id
必选
maxRounds
integer
最大思考轮数
必选
instruction
string
用户指令
必选
exampleQueries
array
推荐问题
必选
显示子属性
隐藏子属性
items
string
followUpQueries
object {3}
追问
必选
显示子属性
隐藏子属性
type
string
追问类型 (default | custom)
必选
round
string
追问问题生成轮数
必选
prompt
string
追问问题生成prompt
必选
knowledgeBaseConfig
object {2}
知识库配置
必选
显示子属性
隐藏子属性
retrieval
object {5}
检索配置
必选
显示子属性
隐藏子属性
topK
integer
召回数量
可选
order
string
排序策略(Combined | RagFirst | WebSearchFirst), enableWebSearch 等于true时生效
可选
strategy
string
检索策略(Advanced | Fulltext | Semantic)
可选
threshold
float
阈值
可选
enableWebSearch
boolean
是否开启百度搜索
可选
knowledgeBases
array
知识库列表
必选
显示子属性
隐藏子属性
items
object {3}
显示子属性
隐藏子属性
id
string
知识库id
可选
name
string
知识库名称
可选
description
string
知识库描述
可选
background
object {4}
背景图
可选
显示子属性
隐藏子属性
id
string
背景图id
可选
path
string
背景图链接地址
可选
mobile_config
object {4}
背景图移动端配置
可选
显示子属性
隐藏子属性
left
string
距离左边的距离
可选
top
string
距离顶部的距离
可选
height
string
背景图的高
可选
color
string
背景图颜色
可选
pc_config
object {4}
背景图pc端配置
可选
显示子属性
隐藏子属性
left
string
距离左边的距离
可选
top
string
距离顶部的距离
可选
height
string
背景图的高
可选
color
string
背景图颜色
可选
JSON
HTTP/1.1 200 OK
{
"id": "应用id",
"name": "应用名称"
"description": "应用描述",
"instruction": "指令",
"prologue": "开场白",
"exampleQueries": ["推荐问题1", "推荐问题2"], # 推荐问题列表
"followUpQueries": { # 追问配置
"type": "custom", # 追问配置
"prompt": "prompt", # 追问prompt
"round": 3, # 追问生成轮数
},
"components": [
{
"name": "组件名称",
"description": "组件描述",
"customDesc": ""
}
],
"knowledgeBaseConfig": {
"knowledgeBases": [ # 知识库详情列表
{
"id": "知识库id",
"name": "",
"description": ""
}
],
"retrieval": { # 检索配置
"enableWebSearch": true, # 是否开启百度搜索
"order": "排序规则", # Combined | RagFirst | WebSearchFirst
"strategy": "策略", # Advanced | Fulltext | Semantic
"topK": 2, # 召回数量
"threshold": 0.5 # 阈值
}
},
"modelConfig": { # 模型配置
"plan": { # 思考模型配置
"modelId": "",
"model": "",
"maxRounds":"",
"config": { # 模型多样性
"temperature": 0,
"topP": 0
}
},
"chat": { # 问答模型配置
"modelId": "",
"model": "",
"historyChatRounds":"",
"config": { # 模型多样性
"temperature": 0,
"topP": 0
}
}
}
}JSON
HTTP/1.1 401
{
"requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code": "PermissionDeniedError",
"message": "没有权限"
}