Menu

快速開始

從零開始,完成你的第一筆圖生影片任務。以下步驟依序進行即可。

1. 註冊帳號並完成 Email 驗證

到註冊建立帳號,並點擊驗證信裡的連結完成 Email 驗證。若未收到驗證信,請點擊重新發送。

2. 試用積分

登入後台後,在頁面上確認帳號已有付費積分餘額,或名下有一筆尚未到期、仍有剩餘額度的試用額度。沒有可用積分時,建立任務會在扣款階段被拒絕,詳見〈積分與計費〉。

3. 建立對應類型的 API Key

到API 金鑰頁面,依步驟 2 確認的積分來源,點擊「建立付費金鑰」(使用付費餘額,要先儲值成功過一次)或「建立試用金鑰」(使用某一批試用積分)。

金鑰建立後請立即複製保存,之後也可以回到同一頁點擊「顯示」再次查看。請勿將金鑰寫在網頁前端程式碼中,或提交到版本控制。

4. 設定環境變數

把 API 網址和金鑰存成環境變數,後面的範例都會用到:

export YUYU_API_BASE_URL="https://yuyuvideo.com"
export YUYU_API_KEY="sk-live-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

5. 準備圖片

圖片要轉成 base64 格式的 data URI 再放進 images,支援 PNG、JPEG、WebP。目前沒有另外的圖片上傳 API,請在程式裡自行轉換,例如:

echo "data:image/png;base64,$(base64 -w0 /path/to/photo.png)"

6. 建立影片任務

以下用 YUYU_M1 示範。請求要帶這三個 header:

  • X-Api-Key:你的 API 金鑰
  • Idempotency-Key:自訂一組不重複的值,重送請求時可避免重複建立任務和重複扣款
  • Content-Type: application/json

YUYU_M1 的影片長度固定 5 秒,但 duration 仍然要填 5。

curl -X POST "$YUYU_API_BASE_URL/api/tasks/video-generation" \
  -H "X-Api-Key: $YUYU_API_KEY" \
  -H "Idempotency-Key: quickstart-demo-001" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YUYU_M1",
    "prompt": "一隻貓在陽光灑落的草地上奔跑",
    "images": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."],
    "duration": 5
  }'

建立成功會回傳 201 Created 和任務資料。以下只列出部分欄位,credits 的數字僅供參考:

{
  "public_id": "01K0ZC8QW3E5F1234567890ABC",
  "status": 0,
  "credits": 10
}

7. 記下 public_id

public_id 是這筆任務的編號,之後查詢進度和下載影片都會使用到。

8. 查詢任務進度

用 public_id 查詢任務,每隔一段時間查一次,直到任務結束:

curl -H "X-Api-Key: $YUYU_API_KEY" \
  "$YUYU_API_BASE_URL/api/tasks/01K0ZC8QW3E5F1234567890ABC"

任務結束時,status 會是以下其中一個值:

status 意思
20 已完成
30 失敗
40 已取消

任務完成後,回應裡的 files 會列出可以下載的檔案網址。

9. 下載影片

直接用 files 裡提供的 url 下載,不需要自己組網址:

curl -H "X-Api-Key: $YUYU_API_KEY" \
  "$YUYU_API_BASE_URL/api/tasks/01K0ZC8QW3E5F1234567890ABC/files/video" \
  -o output.mp4

改用 Webhook 接收通知(選用)

不想一直查詢進度的話,可以在建立任務時加上 callback_url(需要是對外公開的 https:// 網址)。任務完成或失敗時,系統會主動通知這個網址。

收到通知後,請用 Webhook 頁面上的 Webhook 密鑰驗證 X-Signature,確認通知是 YUYU VIDEO 發出的。詳細格式請見〈回呼(Webhook)〉。

下一步