Skip to content
roasOS API
Esc
↑↓navigate↵open⌘Jpreview

List generations

GET/v1/generations
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
typestring
Filter by generation type. Avatars and scenes (created via /v1/avatars and /v1/scenes) are stored in the same table and are returned here too, so they can be filtered as `avatar` / `scene`.
Allowed:imagevideoaudiolipsyncavatarscene
statusstring
Filter by status
Allowed:pendingprocessingcompletedfailed
Responses
200List of generations with pagination
dataobject[]required
max items 100
Show properties
Array of object
idstring<uuid>required
typestringrequired
min length 1 · max length 64
statusstringrequired
Allowed:pendingprocessingcompletedfailed
modelstring | nullrequired
min length 1 · max length 200
promptstring | nullrequired
max length 10000
credits_usedintegerrequired
min 0
error_messagestring | nullrequired
max length 500
outputobject
Show properties
urlstring<uri>
max length 4096
imagesstring<uri>[]
max items 4
scene_idstring<uuid>
provider_seedinteger
min -2147483648 · max 2147483647
created_atstring<date-time>required
completed_atstring<date-time> | nullrequired
metaobjectrequired
Show properties
cursorstring
min length 1 · max length 4096
has_morebooleanrequired
401Invalid or missing API key
errorobjectrequired
Show properties
codestringrequired
min length 1 · max length 128
messagestringrequired
min length 1 · max length 2000
retryablebooleanrequired
request_idstring<uuid>required
balanceinteger
min 0
requiredinteger
min 0
fieldstring
min length 1 · max length 512
statestring
min length 1 · max length 128
retryWithNewKeyboolean
parameterstring
min length 1 · max length 128
allowedstring[]
max items 100
Request
curl -X GET "https://api.roasos.com/v1/generations"
Response
{
  "data": [
    {
      "id": "<uuid>",
      "type": "string",
      "status": "pending",
      "model": "string",
      "prompt": "string",
      "credits_used": 0,
      "error_message": "string",
      "output": {
        "url": "<uri>",
        "images": [
          "<uri>"
        ],
        "scene_id": "<uuid>",
        "provider_seed": 0
      },
      "created_at": "2024-01-01T00:00:00Z",
      "completed_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true
  }
}