Loomie™ 3D Avatar Platform
  • Welcome
  • REST API Tutorials
    • API Credentials
    • Create Avatar & Render
    • Create Avatar & Render (fast)
    • Create Avatar & Download GLTF
    • Create Stickers & Animations
  • Voice2Animation SDK Tutorials
    • Unity Tutorial
    • Loom.ai Facial Rig Specification
  • Loomie SDK Tutorials
    • Deploying the Docker Image
    • Example App Walkthrough
      • Example App Full Source
  • REST API
    • Authentication
      • Authorization Code Flow
      • Authorization Code Flow with PKCE
      • Client Credentials Flow
      • Implicit Flow
      • Refresh Token Flow
      • Resource Owner Flow
    • Authorization
    • Avatars
      • List
      • Create
      • Resolve Status
      • Delete
      • Attachments
        • List
        • Resolve
      • Renderings
        • List
        • Create
        • Resolve
        • Resolve Status
    • Schema
      • Animation
      • Attachment Type
      • Dimensions
      • Quota
      • Scope
      • Status
      • Sticker
Powered by GitBook
On this page
  • GET /avatars

Was this helpful?

  1. REST API
  2. Avatars

List

Resolves a list of current user's avatar ids.‌

GET /avatars

Request

curl -X GET "https://api.loomai.com/v0.5/avatars?page={page}&pagesize={pagesize}&fields={fields}"
curl -X GET "https://api.loomai.com/v0.5/avatars?fields=image,labels"

Parameter

Transport

Type

Description

page

query

integer

Pagination / Page (optional, default 0).

pagesize

query

integer

Pagination / Page Size (optional, default 100, max 100).

fields

query

string

Comma-separated list of fields to include (optional, values image, labels, features).

Response

On success the endpoint returns HTTP 200 OK as well as a JSON body containing the ids, dates of last modification as well as optionally selected fields of the user's previously stored avatars.

{
  "entries": [
    {
      "id": int64,
      "updated_at": "string", // ISO-8601 DATETIME
      "image": {
        "id": int64,
        "width": int32,
        "height": int32,
        "channels": int32
      },
      "labels": {
        "entries": [
          {
            "name": "string",
            "value": "string"
          },
          ...
        ]
      }
    }
  ]
}
{
  "entries": [
    {
      "id": 5723980430835712,
      "updated_at": "2019-10-28T01:36:45Z",
      "image": {
        "id": 5643411273547776,
        "width": 3024,
        "height": 4032,
        "channels": 3
      },
      "labels": {
        "entries": [
          {
            "name": "app",
            "value": "example"
          }
        ]
      }
    }
  ]
}

PreviousAvatarsNextCreate

Last updated 4 years ago

Was this helpful?