docs: update public api docs
This commit is contained in:
25
docs/API.md
25
docs/API.md
@@ -79,6 +79,8 @@ curl -X POST https://你的域名/api/v1/jobs \
|
||||
}
|
||||
```
|
||||
|
||||
新建任务返回 `202`;如果命中相同 `Idempotency-Key` 的已创建任务,返回 `200` 且 `reused: true`。
|
||||
|
||||
### 支持的 capability
|
||||
|
||||
| capability | 说明 |
|
||||
@@ -111,6 +113,16 @@ curl -H "Authorization: Bearer <API_KEY>" \
|
||||
- `limit`:`1` 到 `200`
|
||||
- `before`:ISO 时间,用于翻页
|
||||
|
||||
取消任务:
|
||||
|
||||
```bash
|
||||
curl -X POST \
|
||||
-H "Authorization: Bearer <API_KEY>" \
|
||||
https://你的域名/api/v1/jobs/job_xxx/cancel
|
||||
```
|
||||
|
||||
仅排队中或运行中的任务会被置为 `cancelled`;已进入终态的任务会原样返回。
|
||||
|
||||
## 获取输出资产
|
||||
|
||||
任务成功后,`job.outputAssetIds` 会包含输出资产 ID。
|
||||
@@ -248,15 +260,16 @@ Idempotency-Key: <业务唯一请求ID>
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "generation.succeeded",
|
||||
"job": {
|
||||
"id": "job_xxx",
|
||||
"status": "succeeded",
|
||||
"outputAssetIds": ["asset_xxx"]
|
||||
}
|
||||
"jobId": "job_xxx",
|
||||
"status": "succeeded",
|
||||
"capability": "image.generate",
|
||||
"outputAssetIds": ["asset_xxx"],
|
||||
"updatedAt": "2026-06-08T12:00:00.000Z"
|
||||
}
|
||||
```
|
||||
|
||||
如果任务失败,payload 会包含 `error`。
|
||||
|
||||
如果服务端配置了:
|
||||
|
||||
```env
|
||||
|
||||
Reference in New Issue
Block a user