API 简介
CharaStudio 提供完整的 REST API，允许开发者：
- 远程创建和编辑角色
- 生成故事内容
- 管理资产库
- 生成漫画图片
API 基于标准 REST 约定，使用 JSON 作为数据交换格式。
基础 URL
https://api.charastudio.com/v1
认证
CharaStudio API 使用 Bearer Token 认证：
Authorization: Bearer YOUR_API_KEY
您可以在 CharaStudio 设置页面 获取 API 密钥。
请求格式
所有请求都应包含以下 headers：
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 | 服务器内部错误 |
速率限制
| 套餐 | 每分钟请求数 | 每分钟 Token 数 |
|---|---|---|
| 免费版 | 20 | 10,000 |
| 专业版 | 100 | 50,000 |
| 企业版 | 1000 | 500,000 |
触发速率限制时，响应将包含以下 headers：
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 社区仓库。