API Reference
鉴权、工作流、图片资产、异步任务、结果与计费。
Private Beta API 当前使用 https://app.clearcrowds.com/api/v1。下面示例中的 CLEARCROWDS_API_BASE_URL 应设为 https://app.clearcrowds.com；所有示例只使用占位符，并遵循标准 JSON 成功或失败响应结构。
鉴权
把 API Key 或 CLI Access Token 作为 Bearer Token 发送：
Authorization: Bearer cc_test_REPLACE_ME当前接口
| 方法 | 路径 | 用途 |
|---|---|---|
GET | /api/v1/catalog/presets | 无需凭据读取公开工作流目录。 |
GET | /api/v1/presets | 获取公开图片工作流及其输入 schema。 |
POST | /api/v1/assets | 用 multipart 表单上传本地图片。 |
POST | /api/v1/presets/{preset_id}/jobs | 创建异步工作流 Job。 |
GET | /api/v1/jobs/{job_id} | 查询状态、结果、错误和实际扣费。 |
POST | /api/v1/jobs/{job_id}/cancel | 取消尚未到达终态的任务。 |
GET | /api/v1/jobs/{job_id}/result | 下载已完成的图片。 |
GET | /api/v1/account | 查询可用和已预留的 API Credits。 |
上传图片并获取 input_asset_id
input_asset_id 不是本地文件路径或图片 URL，而是上传成功后接口返回的 data.asset_id。图片资产仅属于当前 Project，并会在 24 小时后过期。
curl "$CLEARCROWDS_API_BASE_URL/api/v1/assets" \
-X POST \
-H "Authorization: Bearer $CLEARCROWDS_API_KEY" \
-F "file=@./input.jpg"{
"success": true,
"data": {
"asset_id": "11111111-1111-4111-8111-111111111111",
"status": "ready",
"width": 1920,
"height": 1080,
"expires_at": "2026-09-05T02:00:00.000Z"
}
}将上面返回的 data.asset_id 作为创建任务时的 input_asset_id。
创建任务
curl "$CLEARCROWDS_API_BASE_URL/api/v1/presets/remove-crowds/jobs" \
-X POST \
-H "Authorization: Bearer $CLEARCROWDS_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: example-edit-001" \
-d '{"input_asset_id":"11111111-1111-4111-8111-111111111111","input":{}}'响应结构
{
"success": true,
"data": {
"id": "job_REPLACE_ME",
"status": "queued"
}
}模型 API 目录 由 GET /api/v1/catalog/presets 实时生成，ID、schema、可用状态、案例和 Credits 价格均以后端为准。