接入總覽

平臺接口總覽

本章節說明通過 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 文檔或商務協議中說明。