コンテンツにスキップ

APIリファレンス

このセクションでは、AIエージェントとのカスタム統合を構築するためのCodeer APIの包括的なドキュメントを提供します。

ベースURL

すべてのAPIリクエストは以下に送信してください：

https://api.codeer.ai/api/v1

認証

すべてのAPIリクエストにはAPIキーによる認証が必要です。リクエストヘッダーにAPIキーを含めてください：

x-api-key: YOUR_API_KEY

APIキーの取得方法については、APIアクセス設定を参照してください。

レスポンス形式

すべてのAPIレスポンスは標準のエンベロープ形式に従います：

{
  "data": { ... },
  "message": null,
  "error_code": 0,
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total_records": 100,
    "total_pages": 2,
    "current_page": 1,
    "next_page": "https://api.codeer.ai/api/v1/chats?offset=50&limit=50",
    "prev_page": null
  }
}
フィールド 説明
data レスポンスペイロード（オブジェクト、配列、またはnull）
message 人間が読めるステータスメッセージ（成功時はnull、エラー時はエラー説明）
error_code エラーコード、整数値（成功時は0）
pagination ページネーション情報（リストエンドポイントのみ）

利用可能なエンドポイント

Chat API

メソッド エンドポイント 説明
GET /chats/published-agents 公開されたエージェントを一覧表示
POST /chats 新しいチャットセッションを作成
GET /chats チャットセッションを一覧表示
GET /chats/{chat_id}/messages チャット内のメッセージを取得
POST /chats/{chat_id}/messages メッセージを送信（SSEストリーミング対応）
POST /chats/upload-file ファイル添付をアップロード
POST /chats/{chat_id}/messages/{message_id}/feedbacks メッセージへのフィードバックを送信

詳細なドキュメントはChat APIを参照してください。

Batch API

メソッド エンドポイント 説明
POST /batches リクエストのバッチを作成
GET /batches バッチを一覧表示
GET /batches/{batch_id} バッチステータスを取得
GET /batches/{batch_id}/results バッチ結果を取得
POST /batches/{batch_id}/cancel バッチをキャンセル

詳細なドキュメントはBatch APIを参照してください。

エラーコード

エラーが発生した場合、レスポンスにはerror_codeフィールド（整数）が含まれます：

HTTPステータス エラーコード 名前 説明
400 10001 SYS_PERMISSION_DENIED 無効または欠落したAPIキー
400 10006 SYS_BAD_REQUEST 無効なリクエストパラメータ
403 10001 SYS_PERMISSION_DENIED アクセスが拒否されました
403 14103 WORKSPACE_CLIENT_NOT_ALLOWED クライアントがホワイトリストに含まれていません（以下の注記を参照）
404 10003 SYS_NOT_FOUND リソースが見つかりません
500 10005 SYS_SERVER_ERROR 内部サーバーエラー

ホワイトリストモードとexternal_user_id

ワークスペースでホワイトリストモードが有効になっている場合、external_user_idパラメータは実質的に必須となります。有効なホワイトリスト登録済みのexternal_user_idがないリクエストは、エラーコード14103の403レスポンスを受け取ります。

レート制限

APIリクエストにはレート制限があります。制限を超えると、429 Too Many Requestsレスポンスが返されます。

レート制限の処理

  • クライアントでジッター付きの指数バックオフを実装してください
  • 1秒の遅延から開始し、リトライごとに倍増（1秒、2秒、4秒、8秒...）
  • サンダリングハード問題を防ぐためにランダムなジッター（±10-25%）を追加
  • 最大リトライ回数（例：5回）または最大遅延（例：32秒）を設定

次のステップ