Skip to content
roasOS API
Esc
navigateopen⌘Jpreview

List avatars

GET/v1/avatars
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 avatars
dataobject[]required
max items 100
Show properties
Array of object
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
metaobjectrequired
Show properties
cursorstring
min length 1 · max length 4096
has_morebooleanrequired
Request
curl -X GET "https://api.roasos.com/v1/avatars"
Response
{
  "data": [
    {
      "id": "<uuid>",
      "name": "string",
      "description": "string",
      "images": {
        "front": "<uri>",
        "full_body": "<uri>"
      },
      "tags": [
        "string"
      ],
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true
  }
}