请求结构简介

API服务域名

通信协议

API 调用遵循 HTTP 协议。

字符编码

可解析内容，所有 request/response body 内容目前均使用 UTF-8 编码。

公共头

公共请求头

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

公共响应头

最终请求形式

请求

最终的请求由以下几部分组成：

• 请求域名: qianfan.baidubce.com。
• 请求路径: 各个接口请求路径不同，详见具体接口详情。
• 请求方式: 支持RESTful风格的请求方式，本接口文档中只涉及到POST方式。
• 请求头: 包括鉴权信息在内的各个公共请求头。详细参考公共头。
• 请求body体：根据接口规定的RequestBody参数结构组成的json结构体。

示例：

curl --location 'https://qianfan.baidubce.com/v2/app/conversation' \
--header 'Authorization: Bearer authorization string' \
--header 'Content-Type: application/json' \
--data '{
    "app_id": "你的app_id"
}'

正确返回结果

使用JSON格式的结构体来描述一个请求返回的具体内容。作为示例，以下是一个正确的返回结果格式：

HTTP/1.1 200 OK
{
  "request_id": "355a4f4e-a6d8-4dec-b840-7075030c6d22",
  "conversation_id": "2370813b-5303-4a4f-b5cc-44f571121342"
}

错误返回结果

请求发生错误时通过respone body返回详细错误信息，遵循如下格式：

示例：

HTTP/1.1 401
{
  "request_id": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
  "code": "PermissionDeniedError",
  "message": "没有权限"
}

错误返回码说明

鉴权认证

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

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

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

日期与时间规范

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

1. 表示日期一律采用YYYY-MM-DD方式，例如2014-06-01表示2014年6月1日。
2. 表示时间一律采用hh:mm:ss方式，并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
3. 凡涉及日期和时间合并表示时，在两者中间加大写字母T，例如2014-06-01T23:00:10Z表示UTC时间2014年6月1日23点0分10秒。