API Reference
接入总览
平台接口总览
本章节说明通过 ReachAPI 暴露的接口所遵循的通用规则和约定。
基础域名
平台基础域名为:
https://direct.reachapi.ai具体请求路径以及是否带版本号,会在各 API 文档中分别说明。
认证方式
- 通过 API Key 进行认证。
- 在请求头中携带:
Authorization: Bearer YOUR_API_KEY- API Key 可在控制台
/dashboard/apikeys中创建和管理。
请求头规范
- 所有请求必须通过
HTTPS发送。 - 推荐请求头:
Content-Type: application/json
Accept: application/json错误处理
错误会通过 HTTP 状态码和 JSON 结构返回,例如:
{
"error": {
"code": "invalid_request",
"message": "prompt 字段为必填。"
}
}具体错误码及含义会在对应 API 文档中给出。
限流与配额
- 在 V1 中,平台可能按 API Key 维度进行限流控制。
- 具体限流策略会在 API 文档或商务协议中说明。