API 概要

プラットフォーム API 概要

このドキュメントでは、ReachAPI が公開している API に共通する設計パターンと基本ルールを説明します。

ベース URL

プラットフォームのベース URL は次のとおりです。

https://direct.reachapi.ai

個々の API における正確なリクエストパスやバージョニング方針は、それぞれの API リファレンスで案内します。

認証

• 認証には API Key を使用します。
• キーは Authorization ヘッダーで送信してください。

Authorization: Bearer YOUR_API_KEY

• キーの発行と管理はダッシュボードの /dashboard/apikeys で行えます。

ヘッダー

• すべてのリクエストで HTTPS を使用してください。
• 推奨ヘッダーは次のとおりです。

Content-Type: application/json
Accept: application/json

エラーハンドリング

エラー時は HTTP ステータスコードと JSON ボディが返されます。例:

{
  "error": {
    "code": "invalid_request",
    "message": "The prompt field is required."
  }
}

各エラーコードの意味や発生条件は、個別の API ドキュメントで説明します。

レート制限とクォータ

• V1 では API キー単位でレート制限が適用される場合があります。
• 詳細な上限や契約条件は、対象 API のドキュメントまたは商用契約で確認してください。