PixAI Platform
API v2 ドキュメントメディア

画像のアップロード URL の取得

入力として使う画像(contextImages の要素、動画のフレーム、インペイントのベース画像など)をアップロードする手順のステップ 1 です。

  1. このエンドポイントを呼び出して uploadUrl と externalId を取得します。
  2. 画像の生バイトを、ファイルの実際の Content-Type(例: image/png)を付けて HTTP PUT で uploadUrl に送信します。マルチパートフォームは使用しないでください。
  3. externalId を指定して POST /v2/media/image/register を呼び出します。返される id が、他のエンドポイントに渡すメディア ID です。
POST
/media/image/upload-url

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
}