Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

Get avatar details

GET/v1/avatars/{id}
Path parameters
idstring<uuid>required
Responses
200Avatar details
dataobjectrequired
Show properties
idstring<uuid>required
namestringrequired
min length 1 · max length 255
descriptionstring | nullrequired
min length 1 · max length 2000
imagesobjectrequired
Show properties
frontstring<uri>required
max length 4096
full_bodystring<uri>required
max length 4096
tagsstring[]required
max items 50
created_atstring<date-time>required
404Not 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/avatars/%3Cuuid%3E"
Response
{
  "data": {
    "id": "<uuid>",
    "name": "string",
    "description": "string",
    "images": {
      "front": "<uri>",
      "full_body": "<uri>"
    },
    "tags": [
      "string"
    ],
    "created_at": "2024-01-01T00:00:00Z"
  }
}