コンテンツへスキップ
APIリファレンス
APIリファレンス

Seedance テキストから動画生成

テキストから動画へのエンドポイントを使用して、非同期タスクを作成します。

Markdownを表示
01

概要

サポートされているモデルでテキストから動画へのエンドポイントを使用します。返されたタスク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-proフィールド11件
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-miniフィールド13件
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.0フィールド14件
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-fastフィールド14件
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.5フィールド16件
aspect_ratiostring
任意

出力アスペクト比。autoを指定するとRunAPIが自動選択します。

許可される値: 1:1, 4:3, 3:4, 16:9, 9:16, 21:9, auto デフォルト: auto
callback_urlstring
任意

非同期タスク更新用の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-proフィールド10件
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-fastフィールド8件
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."
)