API v2 ドキュメントタスク
タスクの取得
任意の v2 エンドポイントで作成したタスクを取得します。status が completed、failed、cancelled のいずれかになるまで、数秒ごとにポーリングしてください。
結果の場所:
- 画像（
taskKindがt2i、i2i、inpaint）:outputs.mediaIdsとoutputs.mediaUrls。 - 動画（
taskKindがi2v-inhouse、reference-video）:outputs.videoMediaId。GET /v2/media/batch?ids=<videoMediaId>で解決し、fileUrlをダウンロードしてください。この場合outputs.mediaIdsにはポスター画像のみが入ります。
生成されたメディアは恒久的には保持されません。完了後はできるだけ早く結果をダウンロードしてください。
Authorization
bearerAuth AuthorizationBearer <token>
認証が必要なすべてのリクエストでは、HTTP ヘッダーに次を追加してください
In: header
Path Parameters
id*string
タスク ID です。
Query Parameters
with_parameters?string
true を指定すると、保存されたタスクパラメータが parameters に含まれます。
Value in
"true"Response Body
application/json
application/json
application/json
curl https://api.pixai.art/v2/task/1943547603237249965 \ -H "Authorization: Bearer $PIXAI_API_KEY"{
"id": "string",
"status": "waiting",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"endAt": "2019-08-24T14:15:22Z",
"taskKind": "string",
"paidQuota": 0,
"taskStatusMsgI18n": {
"key": "string",
"defaultMessage": "string"
},
"outputs": {
"videoMediaId": "string",
"seed": "string",
"mediaIds": [
"string"
],
"mediaUrls": [
"string"
]
}
}{
"code": "string",
"status": 0,
"message": "string",
"data": {},
"defined": true
}{
"code": "string",
"status": 0,
"message": "string",
"data": {},
"defined": true
}