查询用户应用详情
更新时间：2025-06-04
接口描述
该接口查询用户下状态为已发布的应用详情。
在线调试
百度智能云千帆提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，支持Python、Java、PHP、C#、Go、Node.js、C++ 7种主流语言示例代码自动生成。
权限说明
Authorization需要填写密钥。
接口定义
| Path | /v2/app?Action=DescribeApp |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Authorization | 请求签名(Bearer <AppBuilder API Key>) |
请求结构
Plain Text
1POST /v2/app?Action=DescribeApp HTTP/1.1
2HOST: qianfan.baidubce.com
3Authorization: Bearer <AppBuilder API Key>
4Content-Type: application/json
5{
6 "id": "appId"
7}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| id | string | 是 | 应用id |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| requestId | string | 是 | requestId |
| id | string | 是 | 应用id |
| name | string | 是 | 应用名称 |
| description | string | 是 | 应用描述 |
| instruction | string | 是 | 用户指令 |
| prologue | string | 是 | 开场白 |
| exampleQueries | []string | 是 | 推荐问题 |
| followUpQueries | dict | 是 | 追问 |
| followUpQueries \ type | string | 是 | 追问类型 (default | custom) |
| followUpQueries \ prompt | string | 是 | 追问问题生成prompt |
| followUpQueries \ round | string | 是 | 追问问题生成轮数 |
| components | []dict | 是 | 引用组件列表 |
| components \ name | string | 否 | 组件名称 |
| components \ description | string | 否 | 组件描述 |
| components \ customDesc | string | 否 | 组件自定义描述 |
| knowledgeBaseConfig | dict | 是 | 知识库配置 |
| knowledgeBaseConfig \ knowledgeBases | []dict | 是 | 知识库列表 |
| knowledgeBaseConfig \ knowledgeBases \ id | string | 否 | 知识库id |
| knowledgeBaseConfig \ knowledgeBases \ name | string | 否 | 知识库名称 |
| knowledgeBaseConfig \ knowledgeBases \ description | string | 否 | 知识库描述 |
| knowledgeBaseConfig \ retrieval | string | 是 | 检索配置 |
| knowledgeBaseConfig \ retrieval \ enableWebSearch | bool | 否 | 是否开启百度搜索 |
| knowledgeBaseConfig \ retrieval \ order | string | 否 | 排序策略(Combined | RagFirst | WebSearchFirst), enableWebSearch 等于true时生效 |
| knowledgeBaseConfig \ retrieval \ strategy | string | 否 | 检索策略(Advanced | Fulltext | Semantic) |
| knowledgeBaseConfig \ retrieval \ topK | int | 否 | 召回数量 |
| knowledgeBaseConfig \ retrieval \ threshold | float | 否 | 阈值 |
| modelConfig | dict | 是 | 模型配置 |
| modelConfig \ plan | dict | 是 | 思考模型配置 |
| modelConfig \ plan \ modelId | string | 是 | 模型id |
| modelConfig \ plan \ model | string | 是 | 模型名称 |
| modelConfig \ plan \ maxRounds | int | 是 | 最大思考轮数 |
| modelConfig \ plan \ config | dict | 是 | rag模型配置 |
| modelConfig \ plan \ config \ temperature | float | 是 | |
| modelConfig \ plan \ config \ topP | float | 是 | |
| modelConfig \ chat | dict | 是 | 对话模型配置 |
| modelConfig \ chat \ modelId | string | 是 | 模型id |
| modelConfig \ chat \ model | string | 是 | 模型名称 |
| modelConfig \ chat \ historyChatRounds | int | 是 | 历史对话参考轮数 |
| modelConfig \ chat \ config | dict | 是 | rag模型配置 |
| modelConfig \ chat \ config \ temperature | float | 是 | |
| modelConfig \ chat \ config \ topP | float | 是 | |
| background | dict | 否 | 背景图 |
| background \ id | string | 否 | 背景图id |
| background \ path | string | 否 | 图片链接地址 |
| background \ mobile_config | dict | 否 | 背景图移动端配置 |
| background \ mobile_config \ left | string | 否 | 距离左边的距离 |
| background \ mobile_config \ top | string | 否 | 距离顶部的距离 |
| background \ mobile_config \ height | string | 否 | 背景图的高 |
| background \ mobile_config \ color | string | 否 | 背景图颜色 |
| background \ pc_config | dict | 否 | 背景图pc端配置 |
| background \ pc_config \ left | string | 否 | 距离左边的距离 |
| background \ pc_config \ top | string | 否 | 距离顶部的距离 |
| background \ pc_config \ height | string | 否 | 背景图的高 |
| background \ pc_config \ color | string | 否 | 背景图颜色 |
请求curl 示例
Plain Text
1curl --location 'https://qianfan.baidubce.com/v2/app?Action=DescribeApp' \
2--header 'Authorization: Bearer <AppBuilder API Key>' \
3--header 'Content-Type: application/json' \
4--data '{
5 "id": "405d90c0-474c-4ff1-a2ed-3070a66dc7ae"
6}'正确响应示例
Plain Text
1HTTP/1.1 200 OK
2
3{
4 "id": "应用id",
5 "name": "应用名称"
6 "description": "应用描述",
7 "instruction": "指令",
8 "prologue": "开场白",
9 "exampleQueries": ["推荐问题1", "推荐问题2"], # 推荐问题列表
10 "followUpQueries": { # 追问配置
11 "type": "custom", # 追问配置
12 "prompt": "prompt", # 追问prompt
13 "round": 3, # 追问生成轮数
14 },
15 "components": [
16 {
17 "name": "组件名称",
18 "description": "组件描述",
19 "customDesc": ""
20 }
21 ],
22 "knowledgeBaseConfig": {
23 "knowledgeBases": [ # 知识库详情列表
24 {
25 "id": "知识库id",
26 "name": "",
27 "description": ""
28 }
29 ],
30 "retrieval": { # 检索配置
31 "enableWebSearch": true, # 是否开启百度搜索
32 "order": "排序规则", # Combined | RagFirst | WebSearchFirst
33 "strategy": "策略", # Advanced | Fulltext | Semantic
34 "topK": 2, # 召回数量
35 "threshold": 0.5 # 阈值
36 }
37 },
38 "modelConfig": { # 模型配置
39 "plan": { # 思考模型配置
40 "modelId": "",
41 "model": "",
42 "maxRounds":"",
43 "config": { # 模型多样性
44 "temperature": 0,
45 "topP": 0
46 }
47 },
48 "chat": { # 问答模型配置
49 "modelId": "",
50 "model": "",
51 "historyChatRounds":"",
52 "config": { # 模型多样性
53 "temperature": 0,
54 "topP": 0
55 }
56 }
57 }
58}错误响应示例
Plain Text
1HTTP/1.1 401
2{
3 "requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
4 "code": "PermissionDeniedError",
5 "message": "没有权限"
6}