通用说明

更新时间：2024-12-11

通过密钥校验调用者的身份信息。在调用百度智能云千帆AI原生应用工作台提供的API前，必须先获取密钥。

前往API密钥，点击【新增密钥】按钮创建密钥，可自定义备注，支持一键复制操作。

密钥为使用AppBuilder平台的重要凭证，因密钥长期有效，请勿放在浏览器或外部客户端代码中，请妥善管理分发。如意外泄露，在本页面删除密钥即可关闭对应访问入口。
删除密钥后，已删除密钥和旧地址将无法继续请求服务，并无法恢复，请谨慎操作。

API 调用遵循 HTTPS 协议。

数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。

请求参数包括如下4种：

参数类型	说明
URI	通常用于指明操作实体,如:POST /v{version}/instance/{instanceId}
Query参数	URL中携带的请求参数
HEADER	通过HTTP头域传入,如:x-bce-date
RequestBody	通过JSON格式组织的请求数据体

响应值分为两种形式：

返回内容	说明
HTTP STATUS CODE	如200,400,403,404等
ResponseBody	JSON格式组织的响应数据体

公共请求头

参数名称	描述	是否必填	示例
Authorization	请求签名(此签名为appbuilder平台密钥)	必须	Bearer bce-v3/ALTAK-LLfggwDKNJ3mZJFtIMYP8/0d******55cdb5e8b319f93b00fffc584cex8
Content-Type	application/json;charset=utf-8 通用数据交互格式（默认） multipart/form-data; charset=utf-8 支持图片、文件等上传，以及语音二进制流传输 text/event-stream; charset=utf-8 支持服务端向客户端推送服务、事件和消息通知的数据格式	必须	application/json; charset=utf-8 multipart/form-data; charset=utf-8 text/event-stream; charset=utf-8
x-bce-date	表示日期的字符串	可选	x-bce-date:2013-07-08T22%3A08%3A55Z 注意x-bce-date里面的冒号（`:`）已经被规范化成`%3A`。
Host	表示请求API的域名	可选	host: qianfan.baidubce.com
User-Agent	用户请求来源，SDK的请求，可由SDK指定对应的User-Agent 用户使用OpenAPI接入的情况，一般会被用户使用的工具自行填充	可选	python-requests/2.25.1(python) okhttp/4.10.0、ReactorNetty/1.0.17（java） curl/7.68.0（curl） appbuilder-sdk/0.4.1

HTTPS协议的标准头域不在这里列出。公共头域将在请求中出现。

公共响应头

参数名称	描述
x-bce-request-id	请求ID，后端生成，并自动设置到响应头域中
Content-Type	application/json; charset=utf-8 text/event-stream; charset=utf-8

日期与时间的表示有多种方式。为统一起见，除非是约定俗成或者有相应规范的，凡需要日期时间表示的地方一律采用UTC时间，遵循ISO 8601，并做以下约束：