Skip to main content
GET
/
characters
List characters
curl --request GET \
  --url https://api.animusai.co/v2/characters \
  --header 'Authorization: Bearer <token>'
{
  "characters": [
    {
      "character_id": "<string>",
      "organization_id": "<string>",
      "creator_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "<string>",
      "current_step": 123,
      "face_images_count": 123,
      "body_images_count": 123,
      "dataset_status": "<string>",
      "face_lora_status": "<string>",
      "body_lora_status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "subscription_id": "<string>"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "returned": 1,
    "has_more": true
  },
  "filters": {
    "organization_id": "<string>",
    "creator_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

Maximum number of characters to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of characters to skip for pagination.

Required range: x >= 0

Response

200 - application/json

Characters for the authenticated organization.

characters
object[]
pagination
object
filters
object
I