Skip to content
roasOS API
Esc
navigateopen⌘Jpreview
On this page

Generations

The lifecycle of a generation job.

A generation is any creative you make — an image, a video, audio, or lipsync. They all share the same lifecycle and endpoints.

Types

Type What it makes
image Still images and product shots
video Video clips
audio Voiceovers and audio
lipsync A talking avatar synced to audio

Each type supports specific models. See GET /v1/capabilities for the current list, or the API Reference.

Lifecycle

  1. Quote the generation to see its price.
  2. Confirm to start it. You get an id and status: "processing".
  3. The job runs. Poll GET /v1/generations/{id}, or use a webhook.
  4. It ends as completed or failed.

The result

When status is completed, the output holds your creative:

{
  "id": "a5823100-...",
  "type": "image",
  "status": "completed",
  "credits_used": 5,
  "output": {
    "images": ["https://cdn.roasos.com/.../image.png"]
  }
}

If it failed, error_message explains why and you aren’t charged.

Listing

Get your recent generations with GET /v1/generations. It’s paginated — see Pagination.

Was this page helpful?