API リファレンス
この章では現在の公開エンドポイント（/api/v1）をまとめます。
https://api.codeer.ai/api/v1
認証
すべてのリクエストで API キーヘッダーを使用します。
x-api-key: YOUR_API_KEY
レスポンス形式
API は共通の envelope（data / message / error_code / pagination）を返します。
Chat エンドポイント
| 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 エンドポイント
| Method | Endpoint |
|---|---|
| POST | /batches |
| GET | /batches |
| GET | /batches/{batch_id} |
| GET | /batches/{batch_id}/results |
| POST | /batches/{batch_id}/cancel |
詳細は Batch API を参照してください。
external_user_id について
- 一部 workspace では whitelist mode が有効です。
- whitelist mode で許可されていないユーザーは
403とerror_code=14103になります。 - API key 連携では
external_user_idを一貫して渡すことを推奨します。
主なエラーコード
| HTTP | error_code | 意味 |
|---|---|---|
| 400 | 10006 |
リクエスト不正 |
| 403 | 10001 |
権限不足 |
| 403 | 14103 |
Client user が許可されていない |
| 404 | 10003 |
リソース未検出 |
| 500 | 10005 |
サーバーエラー |