Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

List scenes

GET/v1/scenes
Query parameters
cursorstring
Opaque composite pagination cursor from the previous response. Do not parse or construct it.
limitinteger
Number of items to return
min 1 · max 100 · default: 20
Responses
200List of scenes
dataobject[]required
max items 100
Show properties
Array of object
idstring<uuid>required
namestringrequired
min length 1 · max length 200
promptstring
max length 10000
image_urlstring<uri>
max length 4096
thumbnail_urlstring<uri>
max length 4096
modelstring
min length 1 · max length 200
aspect_ratiostring
min length 1 · max length 32
resolutionstring
min length 1 · max length 32
modestring
Allowed:ugcproductcustom
created_atstring<date-time>required
metaobjectrequired
Show properties
cursorstring
min length 1 · max length 4096
has_morebooleanrequired
Request
curl -X GET "https://api.roasos.com/v1/scenes"
Response
{
  "data": [
    {
      "id": "<uuid>",
      "name": "string",
      "prompt": "string",
      "image_url": "<uri>",
      "thumbnail_url": "<uri>",
      "model": "string",
      "aspect_ratio": "string",
      "resolution": "string",
      "mode": "ugc",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true
  }
}