---
updatedAt: 2026-05-27T01:07:19.000Z
agentTools:
  projectIndex: https://docs.d-id.com/llms.txt
---

# Get a list of the avatars

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Videos Endpoints",
    "version": "0.1"
  },
  "servers": [
    {
      "url": "https://api.d-id.com/"
    }
  ],
  "paths": {
    "/scenes/avatars": {
      "get": {
        "operationId": "GetAvatars",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAvatarsResponseDto"
                }
              }
            }
          }
        },
        "summary": "Get a list of the avatars",
        "tags": [
          "Scenes (Express Avatars)"
        ],
        "security": [
          {
            "basic": []
          },
          {
            "bearer": []
          }
        ],
        "parameters": [
          {
            "description": "pagination - the amount of avatars to return",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": 200,
              "format": "double",
              "type": "number"
            }
          },
          {
            "description": "pagination - the pagination token from the previous response, default = 100",
            "in": "query",
            "name": "token",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "JsonError": {
        "properties": {
          "kind": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "details": {},
          "internal": {
            "type": "string"
          }
        },
        "required": [
          "kind",
          "description"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "Dimension": {
        "type": "number",
        "format": "double",
        "maximum": 8000
      },
      "Rect": {
        "properties": {
          "top": {
            "$ref": "#/components/schemas/Dimension"
          },
          "left": {
            "$ref": "#/components/schemas/Dimension"
          },
          "bottom": {
            "$ref": "#/components/schemas/Dimension"
          },
          "right": {
            "$ref": "#/components/schemas/Dimension"
          }
        },
        "required": [
          "top",
          "left",
          "bottom",
          "right"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "FaceRect": {
        "$ref": "#/components/schemas/Rect",
        "title": "Face"
      },
      "SceneAvatarStatus": {
        "enum": [
          "draft",
          "created",
          "started",
          "training-started",
          "error",
          "done",
          "rejected",
          "validating"
        ],
        "type": "string"
      },
      "ModifiedAt": {
        "type": "string",
        "description": "Last modified time as iso-8601 string"
      },
      "CreationNotes": {
        "properties": {
          "is_clone_voice_failed": {
            "type": "boolean"
          },
          "worker_errors": {
            "items": {
              "$ref": "#/components/schemas/JsonError"
            },
            "type": "array"
          }
        },
        "type": "object",
        "additionalProperties": false
      },
      "GetAvatarResponseDto": {
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the avatar"
          },
          "status": {
            "$ref": "#/components/schemas/SceneAvatarStatus",
            "description": "The status of the avatar"
          },
          "object": {
            "type": "string",
            "enum": [
              "scene_avatar"
            ],
            "nullable": false,
            "description": "An identifier of this avatar"
          },
          "created_at": {
            "type": "string",
            "description": "Avatar creation time as iso-8601 string"
          },
          "owner_id": {
            "type": "string",
            "description": "the organization or user id that owns the avatar"
          },
          "modified_at": {
            "$ref": "#/components/schemas/ModifiedAt"
          },
          "error": {
            "$ref": "#/components/schemas/JsonError",
            "description": "The error that failed the training process."
          },
          "started_at": {
            "type": "string",
            "description": "Avatar train start time as iso-8601 string"
          },
          "completed_at": {
            "type": "string",
            "description": "Avatar train complete time as iso-8601 string"
          },
          "created_by": {
            "type": "string",
            "description": "user id that created the avatar"
          },
          "name": {
            "type": "string",
            "description": "The name of the avatar"
          },
          "image_url": {
            "type": "string",
            "description": "High resolution image of the avatar"
          },
          "thumbnail_url": {
            "type": "string",
            "description": "A low resolution image representing the avatar"
          },
          "talking_preview_url": {
            "type": "string",
            "description": "A preview video of the avatar"
          },
          "preview_url": {
            "type": "string",
            "description": "A short gif, trimmed from the original avatar in low resolution"
          },
          "webhook": {
            "type": "string",
            "description": "A webhook URL for sending the payload. In a case of empty value, the webhook will not be triggered"
          },
          "voice_id": {
            "type": "string",
            "description": "The voice id of the avatar"
          },
          "source_url": {
            "type": "string",
            "description": "The source video url of the avatar"
          },
          "consent_id": {
            "type": "string",
            "description": "The consent id used to create the avatar"
          },
          "face_rect": {
            "$ref": "#/components/schemas/FaceRect",
            "description": "The face rect of the avatar"
          },
          "creation_notes": {
            "$ref": "#/components/schemas/CreationNotes",
            "description": "a creation notes for the avatar"
          }
        },
        "required": [
          "id",
          "status",
          "object",
          "created_at",
          "owner_id",
          "modified_at"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "GetAvatarsResponseDto": {
        "properties": {
          "avatars": {
            "items": {
              "$ref": "#/components/schemas/GetAvatarResponseDto"
            },
            "type": "array"
          },
          "token": {
            "type": "string"
          }
        },
        "required": [
          "avatars"
        ],
        "type": "object",
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "basic": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl"
    ]
  }
}
```