API Reference

This page covers the mechanics shared by every model. For model-specific parameters and examples, see Image Models, and Video Models.

Base URL

https://reve2img.com

Authentication

All requests require an API key, passed as a Bearer token:

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Create and manage keys at Settings → API Keys (reve2img.com/settings/apikeys). Keep your key secret — it can spend your account credits. Use it from a server, never in client-side code.

Core endpoints

Create a task

POST /api/v1/generate

The request body always includes a model; the media type (image or video) and scene are inferred from it. These fields are common to all models:

Each category adds its own fields (e.g. image_urls, aspect_ratio, duration, resolution, generate_audio). See the category pages.

Response

{
  "code": 200,
  "message": "success",
  "data": { "task_id": "abc123", "status": "IN_PROGRESS" }
}

Synchronous models (e.g. Reve 2.0) may return SUCCESS with response.resultUrls right away; everything else returns IN_PROGRESS — poll the status endpoint.

Get task status

GET /api/v1/status?task_id={task_id}

Poll every 2–5 seconds until status is SUCCESS or FAILED. Polling too fast simply returns the current state (it is not an error).

{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "abc123",
    "status": "SUCCESS",
    "consumed_credits": 12,
    "response": { "resultUrls": ["https://cdn.reve2img.com/...."] }
  }
}

On failure, status is FAILED and data.error contains a code and message. Failed tasks are not charged.

Response format

Every response uses a consistent envelope:

{ "code": 200, "message": "success", "data": { /* ... */ } }

Successful requests return code: 200. Errors return the HTTP status code in both the HTTP response and code, with a machine-readable message and an optional detail.

Task statuses

Credits

Credits are deducted from your account balance when a task is created, and the exact amount is returned as consumed_credits on success. Pricing depends on the model (and on resolution / duration / options) — see each category page. Failed tasks are refunded automatically. Top up at Settings → Credits.

Errors

{ "code": 401, "message": "INVALID_API_KEY", "detail": "Missing or invalid API key." }