查询用户应用列表
更新时间:2024-11-13
接口描述
该接口查询用户下状态为已发布的应用列表,仅支持查询自主规划Agent应用。
在线调试
百度智能云千帆提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用。
权限说明
Authorization需要填写密钥。
接口定义
Path | /v2/app?Action=DescribeApps |
---|---|
Method | POST |
Content-Type | application/json |
Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
POST /v2/app?Action=DescribeApps HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker": "应用起始位置id",
"maxKeys": 10,
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
marker | string | 否 | 起始位置 |
maxKeys | integer | 否 | 数据大小,默认10,最大值100 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
字段 | 类型 | 必然存在 | 说明 |
---|---|---|---|
requestId | string | 是 | requestId |
marker | string | 是 | 起始位置 |
isTruncated | bool | 是 | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | string | 是 | nextMarker下次查询的起始位置 |
maxKeys | int | 是 | 本次查询包含的最大结果集数量 |
data | list[object] | 是 | 应用对象列表 |
应用对象
字段 | 类型 | 必然存在 | 说明 |
---|---|---|---|
id | string | 是 | 应用ID |
name | string | 是 | 应用名称 |
description | string | 是 | 应用描述 |
appType | string | 是 | 应用类型。agent为自主规划Agentchatflow工作流Agent |
isPublished | string | 是 | 应用状态。false:未发布true为已发布 |
updateTime | int | 是 | 编辑时间,格式为Unix时间戳。应用以编辑时间倒序排列 |
请求curl 示例
curl --location 'https://qianfan.baidubce.com/v2/app?Action=DescribeApps' \
--header 'Authorization: Bearer string' \
--header 'Content-Type: application/json' \
--data '{
"marker":"marker_id",
"maxKeys":10
}'
正确响应示例
HTTP/1.1 200 OK
{
"requestId": "355a4f4e-a6d8-4dec-b840-7075030c6d22",
"marker" : "marker_id",
"nextMarker" : "next_marker_id",
"isTruncated" : false,
"maxKeys" : 200,
"data": [
{
"id": "应用ID",
"name": "name",
"description": "应用描述",
"appType": "应用类型",
"isPublished": 应用状态,
"updateTime": 编辑时间
}
]
}
错误响应示例
HTTP/1.1 401
{
"requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code": "PermissionDeniedError",
"message": "没有权限"
}