RelayDanceDocs / 快速开始
快速开始
获取你的 API 密钥，用两次 HTTP 调用生成你的第一段视频。
#基本信息
| 字段 | 值 |
|---|---|
API 基础 URL | https://relaydance.com/v1 |
API 密钥 | 从控制台获取，格式：sk-xxxxxxxxxxxx |
支持的协议 | 兼容 OpenAI API 的图像（gpt-image-2），外加异步视频任务 API |
#第 1 步：创建账户
注册一个 RelayDance 账户，并充值任意金额即可开始发起请求。
#第 2 步：获取 API 密钥
- 打开控制台，进入 API 密钥页面
- 创建一个新密钥
- 复制并妥善保存
切勿把密钥提交到版本控制系统。请将其保存在环境变量中，例如
RELAYDANCE_API_KEY。#第 3 步：提交一个视频任务
视频生成是异步的。POST /v1/video/generations 会立即返回一个 task_id，视频在后台渲染。ratio、resolution 等厂商参数放在 metadata 里。
任务即时开始（无需排队），无需 BytePlus 账户或 KYC。支持人脸与人像生成，并可使用官方平台没有的特殊 SKU。失败的请求不计费。
terminalbash
curl https://relaydance.com/v1/video/generations \
-H "Authorization: Bearer $RELAYDANCE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "doubao-seedance-2-0-1080p",
"prompt": "A dancer spins in golden hour light, cinematic",
"seconds": "10",
"metadata": {
"ratio": "16:9",
"resolution": "1080p",
"generate_audio": true
}
}'response.jsonjson
{
"task_id": "task_abc123",
"status": "submitted"
}#第 4 步：轮询直到视频就绪
terminalbash
curl https://relaydance.com/v1/video/generations/task_abc123 \
-H "Authorization: Bearer $RELAYDANCE_API_KEY"response.jsonjson
{
"task_id": "task_abc123",
"status": "succeeded",
"url": "https://...mp4",
"format": "mp4"
}状态会依次经过 submitted、running，最后变为 succeeded 或 failed。每隔几秒轮询一次，直到状态稳定。
完全跳过轮询：在提交时设置
metadata.callback_url，视频完成后最终的任务 JSON 会以 POST 发送到你的 webhook。参见视频生成。#第 5 步：探索 API 的其余部分
同一个密钥还可用于兼容 OpenAI 的 gpt-image-2 图像生成，以及对成片进行超分辨率放大。RelayDance 只提供视频与图像，不含对话或 LLM 模型。
terminalbash
# 图像生成 (gpt-image-2)
curl https://relaydance.com/v1/images/generations \
-H "Authorization: Bearer $RELAYDANCE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-image-2",
"prompt": "A watercolor fox in a bamboo forest",
"n": 1
}'图像输出免费：你只为发送的输入付费。