API 简介
CharaStudio は完全な REST API を提供し、開発者が以下を可能にします:
- リモートでキャラクターを作成・編集
- ストーリー内容を生成
- アセットライブラリを管理
- コミック画像を生成
APIは標準 REST 規約に基づき、JSON をデータ交換形式として使用。
ベース URL
https://api.charastudio.com/v1
認証
CharaStudio API は Bearer Token 認証を使用:
Authorization: Bearer YOUR_API_KEY
API キーは CharaStudio 設定ページ で取得可能。
リクエスト形式
すべてのリクエストには以下のヘッダーを 含める必要があります:
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
Accept: application/json
レスポンス形式
成功レスポンスの標準形式:
{
"success": true,
"data": { ... },
"meta": {
"request_id": "req_abc123",
"processing_time_ms": 1523
}
}
エラー レスポンス:
{
"success": false,
"error": {
"code": "INVALID_PARAMETER",
"message": "The 'name' field is required",
"details": { ... }
}
}
ステータスコード
| コード | 意味 |
|---|---|
| 200 | リクエスト成功 |
| 201 | リソース作成成功 |
| 400 | パラメータエラー |
| 401 | 認証失敗 |
| 403 | 権限不足 |
| 404 | リソースが存在しない |
| 429 | リクエスト過多 |
| 500 | サーバー内部エラー |
レート制限
| プラン | 1分あたりのリクエスト数 | 1分あたりのトークン数 |
|---|---|---|
| 無料版 | 20 | 10,000 |
| プロ版 | 100 | 50,000 |
| エンタープライズ版 | 1000 | 500,000 |
レート制限が発生すると、レスポンスには以下のヘッダーが含まれます:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1699999999
Retry-After: 30
SDK とクライアントライブラリ
公式 SDK:
- Python:
pip install charastudio-sdk - JavaScript/TypeScript:
npm install charastudio-sdk - Java:近日公开予定
- Go:近日公开予定
コミュニティ寄稿ライブラリは GitHub コミュニティリポジトリ をご覧ください。