Quickstart

Was this page helpful?

Create a key and wire a complete list, generate, poll, and download flow in about 60 seconds.

By Wilson Sik Founder, Reviral Last updated September 25, 2026

1. Create an API key

Open API keys, create a key for this integration, and copy it once into a server-side environment variable named REVIRAL_API_KEY.

2. List current models

This public request returns current IDs, accepted inputs, defaults, and live credit prices.

curl "https://reviral.ai/api/v1/models"

3. Start one generation

Use an ID and its current price from the catalog. The public maxCredits value becomes the internal quotedCredits exact-match lock, so it is not a spending ceiling.

curl -X POST "https://reviral.ai/api/v1/generate-media" \
  -H "Authorization: Bearer $REVIRAL_API_KEY" \
  -H "Idempotency-Key: first-generation" \
  -H "Content-Type: application/json" \
  --data '{"model":"seedance-2","prompt":"A slow camera move across a quiet lake at sunrise","durationSec":5,"resolution":"720p","aspectRatio":"16:9","maxCredits":106}'

202 response

{
  "data": {
    "jobId": "550e8400-e29b-41d4-a716-446655440000",
    "kind": "video",
    "model": "seedance-2",
    "creditsCharged": 106,
    "status": "queued",
    "statusUrl": "/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000"
  }
}

4. Poll the job

Use the returned job ID. Poll with backoff until status is ready or failed.

curl "https://reviral.ai/api/v1/jobs/$JOB_ID" \
  -H "Authorization: Bearer $REVIRAL_API_KEY"

5. Download the output

A ready video returns outputUrl; a ready image job returns outputUrls. Download promptly because delivery URLs are signed and expire.

curl "$OUTPUT_URL" --output reviral-output.mp4

Choose a workflow-specific API

Plan interactively with Director chat, start an owned-upload UGC ad, assemble clips with stitch, or draft text with the script writer.

Quickstart Models Errors