跳到主要內容
API 參考
API 參考

Seedance 文字轉影片

使用文字轉影片端點建立非同步 Task。

01

概覽

使用文字轉影片端點搭配支援的模型。使用回傳的 Task ID 擷取其狀態,或提供 callback_url 以接收下方說明的回呼通知。

快速入門

  1. 建立 API 金鑰並將其設定為 RUNAPI_API_KEY。
  2. 選擇支援的模型,並傳送本文符合該模型結構描述的 POST 請求。
  3. 儲存返回的任務 ID,然後輪詢直到終止狀態,或處理下方說明的回呼。

端點

POST /api/v1/seedance/text_to_video
基礎 URL
https://runapi.ai
API 版本
v1
身分驗證
Authorization: Bearer YOUR_API_TOKEN
02

支援的模型

開啟模型頁面以查看目前的定價、速率限制及商業用途詳情。

03

請求綱要

JSON 請求內文

欄位及允許值取決於所選模型。若提供 callback_url,其將接收下方記錄的 Task 交付內容。

seedance-1.5-pro11 個欄位
aspect_ratiostring
選填 允許的值: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9
callback_urlstring
選填
duration_secondsinteger
必填 範圍: 4 - 12
enable_safety_checkerboolean
選填
generate_audioboolean
選填
lock_cameraboolean
選填
modelstring
選填
output_resolutionstring
選填 允許的值: 480p, 720p, 1080p
promptstring
選填
seedinteger
選填 範圍: -1 - 2147483647
source_image_urlsarray
選填 項目數上限: 2
seedance-2-mini13 個欄位
aspect_ratiostring
選填 允許的值: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9, auto
callback_urlstring
選填
duration_secondsinteger
選填 預設值: 5 範圍: 4 - 15
first_frame_image_urlstring
選填
generate_audioboolean
選填
last_frame_image_urlstring
選填
modelstring
選填
output_resolutionstring
選填 允許的值: 480p, 720p
promptstring
選填
reference_audio_urlsarray
選填 項目數上限: 3
reference_image_urlsarray
選填 項目數上限: 9
reference_video_urlsarray
選填 項目數上限: 3
web_searchboolean
選填
seedance-2.014 個欄位
aspect_ratiostring
選填 允許的值: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9, auto
callback_urlstring
選填
duration_secondsinteger
選填 預設值: 5 範圍: 4 - 15
enable_safety_checkerboolean
選填
first_frame_image_urlstring
選填
generate_audioboolean
選填
last_frame_image_urlstring
選填
modelstring
選填
output_resolutionstring
選填 允許的值: 480p, 720p, 1080p, 4k
promptstring
選填
reference_audio_urlsarray
選填 項目數上限: 3
reference_image_urlsarray
選填 項目數上限: 9
reference_video_urlsarray
選填 項目數上限: 3
web_searchboolean
選填
seedance-2.0-fast14 個欄位
aspect_ratiostring
選填 允許的值: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9, auto
callback_urlstring
選填
duration_secondsinteger
選填 預設值: 5 範圍: 4 - 15
enable_safety_checkerboolean
選填
first_frame_image_urlstring
選填
generate_audioboolean
選填
last_frame_image_urlstring
選填
modelstring
選填
output_resolutionstring
選填 允許的值: 480p, 720p
promptstring
選填
reference_audio_urlsarray
選填 項目數上限: 3
reference_image_urlsarray
選填 項目數上限: 9
reference_video_urlsarray
選填 項目數上限: 3
web_searchboolean
選填
seedance-2.516 個欄位
aspect_ratiostring
選填

輸出長寬比;auto 讓 RunAPI 自動選取。

允許的值: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9, auto 預設值: auto
callback_urlstring
選填

用於非同步 Task 更新的 Webhook URL。

duration_secondsinteger
選填

影片時長(秒);-1 表示自動選擇時長。

允許的值: -1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 預設值: 5
enable_safety_checkerboolean
選填

RunAPI 是否對生成的內容進行安全性檢查。

first_frame_image_urlstring
選填

用於幀引導生成的公開第一幀影像 URL。

generate_audioboolean
選填

是否生成同步音訊。

預設值: true
last_frame_image_urlstring
選填

公開最後一幀影像 URL;需搭配 first_frame_image_url。

modelstring
必填

RunAPI 模型識別碼。

output_formatstring
選填

輸出影片容器格式。

允許的值: mp4, mov 預設值: mp4
output_resolutionstring
選填

輸出影片解析度。

允許的值: 480p, 720p, 1080p 預設值: 720p
promptstring
必填

影片生成提示。

範圍: 3 - 30000
reference_audio_urlsarray
選填

公開參考音訊 URL;最多 10 個音訊檔案。

項目數上限: 10
reference_image_urlsarray
選填

公開參考影像 URL;最多 30 張影像。

項目數上限: 30
reference_video_urlsarray
選填

公開參考影片 URL;最多 10 個影片。

項目數上限: 10
return_last_frameboolean
選填

是否回傳所生成影片的最後一幀。

預設值: false
web_searchboolean
選填

是否以網路搜尋豐富提示內容。

seedance-v1-pro10 個欄位
aspect_ratiostring
選填 允許的值: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9
callback_urlstring
選填
duration_secondsinteger
必填 允許的值: 5, 10
enable_safety_checkerboolean
選填
first_frame_image_urlstring
選填
lock_cameraboolean
選填
modelstring
選填
output_resolutionstring
選填 允許的值: 480p, 720p, 1080p
promptstring
選填
seedinteger
選填
seedance-v1-pro-fast8 個欄位
callback_urlstring
選填
duration_secondsinteger
必填 允許的值: 5, 10
enable_safety_checkerboolean
選填
first_frame_image_urlstring
必填
modelstring
選填
output_resolutionstring
選填 允許的值: 720p, 1080p
promptstring
選填
seedinteger
選填 範圍: -1 - 2147483647

條件規則

當所有列出的條件均符合時,這些需求即適用。

  1. first_frame_image_url = {"present" => true}, model = seedance-2.5
    必填
    不接受
    reference_image_urls, reference_video_urls, reference_audio_urls
  2. last_frame_image_url = {"present" => true}, model = seedance-2.5
    必填
    first_frame_image_url
    不接受
    reference_image_urls, reference_video_urls, reference_audio_urls
  3. model = seedance-1.5-pro
    必填
    不接受
    first_frame_image_url, last_frame_image_url, reference_image_urls, reference_video_urls, reference_audio_urls, web_search, return_last_frame, output_format
  4. model = seedance-2-mini
    必填
    不接受
    source_image_urls, lock_camera, seed, enable_safety_checker, return_last_frame, output_format
  5. model = seedance-2.0
    必填
    不接受
    source_image_urls, lock_camera, seed, return_last_frame, output_format
  6. model = seedance-2.0-fast
    必填
    不接受
    source_image_urls, lock_camera, seed, return_last_frame, output_format
  7. model = seedance-2.5
    必填
    不接受
    source_image_urls, lock_camera, seed
  8. model = seedance-v1-pro
    必填
    不接受
    source_image_urls, last_frame_image_url, reference_image_urls, reference_video_urls, reference_audio_urls, web_search, generate_audio, return_last_frame, output_format
  9. model = seedance-v1-pro-fast
    必填
    不接受
    aspect_ratio, source_image_urls, lock_camera, last_frame_image_url, reference_image_urls, reference_video_urls, reference_audio_urls, web_search, generate_audio, return_last_frame, output_format
04

建立接受記錄

HTTP 202

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}
05

輪詢處理中

HTTP 200

GET /api/v1/seedance/text_to_video/:id

回應綱要
JSON
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}
06

輪詢已完成

HTTP 200

GET /api/v1/seedance/text_to_video/:id

回應綱要
JSON
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "last_frame_image_url": {
      "type": "string",
      "x-runapi-generated-media": true
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "completed",
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
07

輪詢失敗

HTTP 200

GET /api/v1/seedance/text_to_video/:id

回應綱要
JSON
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "error": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "error": "Task processing failed.",
  "id": "tsk_reference_demo",
  "status": "failed"
}
08

客戶回呼:已完成

HTTP 200

POST callback_url

回應綱要
JSON
{
  "properties": {
    "id": {
      "type": "string"
    },
    "last_frame_image_url": {
      "type": "string",
      "x-runapi-generated-media": true
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "id": "tsk_reference_demo",
  "status": "completed",
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
09

客戶回呼:失敗

HTTP 200

POST callback_url

回應綱要
JSON
{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "id": "tsk_reference_demo",
  "status": "failed"
}
10

錯誤

HTTP 401

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "Authentication required"
}
11

錯誤

HTTP 401

GET /api/v1/seedance/text_to_video/:id

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "Authentication required"
}
12

錯誤

HTTP 400

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "人類可讀的錯誤訊息。",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "人類可讀的驗證摘要。",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "以公開請求欄位為索引鍵的驗證訊息,每個欄位包含一組人類可讀的字串陣列。",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

回應範例

JSON
{
  "error": "model must be one of: seedance-1.5-pro, seedance-2-mini, seedance-2.0, seedance-2.0-fast, seedance-2.5, seedance-v1-pro, seedance-v1-pro-fast"
}
13

錯誤

HTTP 402

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "Insufficient balance"
}
14

錯誤

HTTP 429

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "API key credit limit exceeded"
}
15

錯誤

HTTP 409

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "The request uses features that are not supported for the selected model"
}
16

錯誤

HTTP 429

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "Rate limit reached. Please retry later."
}
17

錯誤

HTTP 503

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "Service under maintenance, please try again later"
}
18

錯誤

HTTP 504

POST /api/v1/seedance/text_to_video

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "The request timed out"
}
19

錯誤

HTTP 404

GET /api/v1/seedance/text_to_video/:id

回應綱要
JSON
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON
{
  "error": "Task with id 'tsk_reference_demo' not found"
}
20

產生的程式碼範例

直接使用 cURL,或為您的程式語言安裝 SDK。每個範例均會提交本參考中所示的已驗證請求。

安裝

Shell
pip install runapi-seedance
PYTHON
import os
from runapi.seedance import SeedanceClient

client = SeedanceClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.text_to_video.create(
  model="seedance-1.5-pro",
  duration_seconds=5,
  prompt="A time-lapse of clouds moving over a mountain lake."
)