通用说明
更新时间：2024-12-23
API认证机制
鉴权的主要目的是用于校验调用者的身份信息。调用千帆ModelBuilder平台功能OpenAPI需使用基于安全认证AK/SK进行签名计算鉴权。
使用安全认证中的Access Key（即AK）和Secret Key（即SK）进行签名计算，将HTTP请求发送到百度智能云时，需要对请求进行签名计算，以便百度智能云可以识别身份。鉴权认证机制的详细内容，请参见鉴权认证机制。
通信协议
API 调用遵循 HTTPS 协议。
请求结构说明
数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。
请求参数包括如下：
| 参数类型 | 说明 |
|---|---|
| HEADER | 通过HTTP头域传入，如:x-bce-date |
| Query参数 | URL中携带的请求参数 |
| RequestBody | 通过JSON格式组织的请求数据体 |
响应结构说明
| 响应内容 | 说明 |
|---|---|
| HTTP STATUS CODE | 如200，400，403，404等 |
| ResponseBody | 通过JSON格式组织的响应数据体 |
公共请求头与公共响应头
公共请求头
| 参数名称 | 描述 | 是否必填 |
|---|---|---|
| Authorization | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 | 必填 |
| Content-Type | 指定数据传输的格式，当前支持： · application/json · multipart/form-data（部分接口支持） |
必填 |
| x-bce-date | 表示日期的字符串，遵循ISO8601规范，格式如2016-04-06T08:23:49Z | 可选 |
| Host | 表示请求API的域名 | 可选 |
公共响应头
| 头域 | 说明 |
|---|---|
| Content-Type | 在返回结果是JSON时，为application/json; charset=utf-8 |
| x-bce-request-id | 对应请求的requestId |