Docs / Quick Start

Quick Start

Get your API key and generate your first video clip with two HTTP calls.

#Basic information

Field	Value
`API Base URL`	`https://relaydance.com/v1`
`API Key`	Obtain from the console, format: `sk-xxxxxxxxxxxx`
`Supported Protocols`	OpenAI API compatible images (gpt-image-2) plus an async video task API

#Step 1: Create your account

#Step 2: Get your API key

Open the console and go to the API keys section
Create a new key
Copy and store it securely

Never commit your key to version control. Keep it in an environment variable such as RELAYDANCE_API_KEY.

#Step 3: Submit a video task

Video generation is asynchronous. POST /v1/video/generations returns a task_id immediately; the clip renders in the background. Vendor parameters such as ratio and resolution go inside metadata.

Tasks start immediately (no queue), and no BytePlus account or KYC is required. Face and portrait generation is supported, and you get access to special SKUs not available on the official platform. Failed requests are not billed.

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"
}

#Step 4: Poll until the clip is ready

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"
}

Status moves through submitted, running, then succeeded or failed. Poll every few seconds until it settles.

Skip polling entirely: set metadata.callback_url when you submit and the final task JSON is POSTed to your webhook when the clip finishes. See Video Generation.

#Step 5: Explore the rest of the API

The same key also serves OpenAI-compatible image generation with gpt-image-2, plus super-resolution upscaling of your finished clips. RelayDance is video and image only, there are no chat or LLM models.

terminalbash

# Image generation (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
  }'

Image output is free: you only pay for the input you send.

#Next steps

Video Generation : Full parameter table, reference media, webhooks
Image-to-Video : Animate a still image with reference media
Upload Files : Host local images for use as references
API Keys : Manage separate keys for dev and production

←Overview API Keys→