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

Get generation details

Poll this endpoint to check generation status. When status is completed, the output field contains the result URLs.

GET/v1/generations/{id}
Path parameters
idstring<uuid>required
Responses
200Generation details with status and public artifact output
dataobjectrequired
Show properties
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
404Generation not found
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/%3Cuuid%3E"
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"
  }
}