API リファレンス

この章では Codeer の Chat API と Batch API のエンドポイントをまとめます。

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

/api/v1 配下に存在する可能性がある内部エンドポイントや workspace 管理エンドポイントをすべて扱うものではありません。

認証

すべてのリクエストで API キーヘッダーを使用します。

x-api-key: YOUR_API_KEY

API は共通の envelope（data / message / error_code / pagination）を返します。

Method	Endpoint
GET	`/chats/published-agents`
POST	`/chats`
GET	`/chats`
PUT	`/chats/{chat_id}`
GET	`/chats/{chat_id}/messages`
POST	`/chats/{chat_id}/messages`
POST	`/chats/{chat_id}/regenerate`
POST	`/chats/{chat_id}/form-requests/{form_request_id}/submit`
POST	`/chats/upload-file`
POST	`/chats/{chat_id}/messages/{message_id}/feedbacks`

詳細は Chat API と SSE ストリーミングを参照してください。

詳細は Batch API を参照してください。

一部 workspace では whitelist mode により、アクセスできる external user を制限します。
API key request が whitelist を確認するかどうかは、workspace の Allow API-key clients to bypass whitelist 設定に従います。
bypass が有効な場合、API key request は whitelist entry なしで workspace にアクセスできます。ただし identity と history を分離するため、external_user_id は一貫して渡すことを推奨します。
bypass が無効な場合、whitelist mode の API key request は許可済みの external_user_id が必要です。そうでない場合は 403 と error_code=14103 が返ります。