千帆AI应用开发者中心的API为开发者提供了便捷的模型调用能力，了解其通用说明是顺利完成接口对接的基础，所有接口相关规则都围绕稳定、安全的调用体验设计。
API认证机制
调用模型API时需要通过API Key完成身份校验，具体的鉴权流程可以参考官方给出的认证鉴权相关文档，确保每一次请求都具备合法的访问权限。
通信协议
所有API调用都遵循HTTPS协议，在保障数据传输安全的同时，也符合当前主流接口调用的协议规范，开发者无需额外适配特殊协议。
请求结构说明
接口的数据交换格式统一为JSON，所有请求和响应的body内容都采用UTF-8编码，避免中文或特殊字符出现乱码问题。
请求参数主要分为三类：
- HEADER参数：通过HTTP头域传入，例如x-bce-date这类时间相关的头域参数。
- Query参数：直接携带在请求的URL中，用于传递简单的筛选或标识类信息。
- RequestBody：通过JSON格式组织的请求数据体，承载核心的业务请求内容。
响应结构说明
接口的响应内容主要包含两部分：
- HTTP STATUS CODE：常见的状态码包括200表示请求成功，400表示请求参数错误，403表示无访问权限，404表示请求的资源不存在等。
- ResponseBody：通过JSON格式组织的响应数据体，返回具体的业务结果或错误提示信息。
公共请求头与公共响应头
公共请求头
所有请求都需要携带或可选携带以下公共头域：
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值为application/json，标识请求体的数据格式。 |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，该字段值需要由字符串Bearer和API Key值拼接组成，示例值如Bearer bce-v3/ALTAK-*********/614fb**********。API Key可以在控制台的系统管理与统计板块下的API Key管理页面创建并获取，该值永久有效。 |
| appid | string | 否 | V2版本接口对应的应用ID，可以在控制台的系统管理与统计板块下的应用接入页面，在应用列表中查看。如果没有对应应用，需要先在该页面创建V2版本服务对应的应用。 |
| X-Request-Id | string | 否 | 用户自定义入参的X-Request-Id，返回的X-Request-Id头会直接使用用户的入参值，方便开发者追踪请求链路。 |
公共响应头
接口返回时会携带以下公共头域：
- Content-Type：当返回结果为JSON时，该头域的值为application/json; charset=utf-8，标识响应数据的格式和编码。
- X-Request-Id：对应本次请求的requestId，和请求时传入的X-Request-Id（如果有）保持一致，用于请求全链路追踪。