Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

Get scene details

GET/v1/scenes/{id}
Path parameters
idstring<uuid>required
Responses
200Scene details
dataobjectrequired
Show properties
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
Request
curl -X GET "https://api.roasos.com/v1/scenes/%3Cuuid%3E"
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"
  }
}