API v2 ドキュメントメディア
画像のアップロード URL の取得
入力として使う画像(contextImages の要素、動画のフレーム、インペイントのベース画像など)をアップロードする手順のステップ 1 です。
- このエンドポイントを呼び出して
uploadUrlとexternalIdを取得します。 - 画像の生バイトを、ファイルの実際の
Content-Type(例:image/png)を付けて HTTPPUTでuploadUrlに送信します。マルチパートフォームは使用しないでください。 externalIdを指定してPOST /v2/media/image/registerを呼び出します。返されるidが、他のエンドポイントに渡すメディア ID です。
Authorization
bearerAuth AuthorizationBearer <token>
認証が必要なすべてのリクエストでは、HTTP ヘッダーに次を追加してください
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
# 1. アップロード URL を取得UPLOAD=$(curl -s -X POST https://api.pixai.art/v2/media/image/upload-url \ -H "Authorization: Bearer $PIXAI_API_KEY" \ -H "Content-Type: application/json" -d '{}')URL=$(echo "$UPLOAD" | jq -r .uploadUrl)EXTERNAL_ID=$(echo "$UPLOAD" | jq -r .externalId)# 2. バイトをアップロードcurl -X PUT "$URL" -H "Content-Type: image/png" --data-binary @input.png# 3. 登録してメディア ID を取得curl -s -X POST https://api.pixai.art/v2/media/image/register \ -H "Authorization: Bearer $PIXAI_API_KEY" \ -H "Content-Type: application/json" \ -d "{\"externalId\": \"$EXTERNAL_ID\"}" | jq -r .id{
"uploadUrl": "string",
"externalId": "string"
}{
"code": "string",
"status": 0,
"message": "string",
"data": {},
"defined": true
}音声ファイルのアップロード URL の取得 POST
`POST /v2/reference-video/create` の `referenceAudioMediaIds` に使う音声クリップをアップロードする手順のステップ 1 です。流れは画像と同じです。ファイルの `Content-Type`(`audio/mpeg` または `audio/wav`)を付けてバイトを `uploadUrl` に `PUT` し、その後 `POST /v2/media/audio/register` を呼び出します。
動画・音声ファイルの情報の取得 GET
動画または音声のメディアアイテムの長さ、サイズ、コンテナ、コーデックを返します。参照動画タスクを作成する前に、参照ファイルがモデルの制限を満たしているか確認できます。