---
title: "List avatars"
method: GET
path: "/v1/avatars"
tags: ["Avatars"]
---

# List avatars

`GET /v1/avatars`

List avatars for the authenticated user with cursor-based pagination.

## Query parameters

- `cursor` string
- `limit` integer, required

## Headers

- `X-Runway-Version` '2024-11-06', required

## Response `200`

Success

- object
  - `data` union[], required — The list of items for the current page.
    - union
      - object — An avatar that is still being processed.
        - `id` string, uuid, required — The unique identifier of the avatar.
        - `name` string, required — The character name for the avatar.
        - `personality` string, required — System prompt defining how the avatar should behave in conversations.
        - `startScript` string, nullable, required — Opening message that the avatar will say when a session starts, or null if not set.
        - `voice` union, required — The voice configured for this avatar.
          - object — A preset voice from the Runway API.
            - `type` 'runway-live-preset', required
            - `presetId` 'victoria' | 'vincent' | 'clara' | 'drew' | 'skye' | 'max' | 'morgan' | 'felix' | 'mia' | 'marcus' | 'summer' | 'ruby' | 'aurora' | 'jasper' | 'leo' | 'adrian' | 'nina' | 'emma' | 'blake' | 'david' | 'maya' | 'nathan' | 'sam' | 'georgia' | 'petra' | 'adam' | 'zach' | 'violet' | 'roman' | 'luna', required — The preset voice identifier.
            - `name` string, required — The display name of the voice.
            - `description` string, required — A brief description of the voice characteristics.
          - object — A custom voice created via the Voices API.
            - `type` 'custom', required
            - `id` string, uuid, required — The unique identifier of the custom voice.
            - `deleted` boolean, required — Whether the voice has been deleted. When true, name and description are omitted.
            - `name` string — The display name of the voice.
            - `description` string, nullable — A brief description of the voice characteristics.
        - `referenceImageUri` string, nullable, required — A URI pointing to a low-resolution preview of the avatar's reference image.
        - `processedImageUri` string, nullable, required — A URI pointing to a low-resolution preview of the processed reference image.
        - `documentIds` string[], required — IDs of knowledge documents attached to this avatar.
        - `createdAt` string, date-time, required — When the avatar was created.
        - `updatedAt` string, date-time, required — When the avatar was last updated.
        - `status` 'PROCESSING', required
      - object — An avatar that is ready for use in sessions.
        - `id` string, uuid, required — The unique identifier of the avatar.
        - `name` string, required — The character name for the avatar.
        - `personality` string, required — System prompt defining how the avatar should behave in conversations.
        - `startScript` string, nullable, required — Opening message that the avatar will say when a session starts, or null if not set.
        - `voice` union, required — The voice configured for this avatar.
          - object — A preset voice from the Runway API.
            - `type` 'runway-live-preset', required
            - `presetId` 'victoria' | 'vincent' | 'clara' | 'drew' | 'skye' | 'max' | 'morgan' | 'felix' | 'mia' | 'marcus' | 'summer' | 'ruby' | 'aurora' | 'jasper' | 'leo' | 'adrian' | 'nina' | 'emma' | 'blake' | 'david' | 'maya' | 'nathan' | 'sam' | 'georgia' | 'petra' | 'adam' | 'zach' | 'violet' | 'roman' | 'luna', required — The preset voice identifier.
            - `name` string, required — The display name of the voice.
            - `description` string, required — A brief description of the voice characteristics.
          - object — A custom voice created via the Voices API.
            - `type` 'custom', required
            - `id` string, uuid, required — The unique identifier of the custom voice.
            - `deleted` boolean, required — Whether the voice has been deleted. When true, name and description are omitted.
            - `name` string — The display name of the voice.
            - `description` string, nullable — A brief description of the voice characteristics.
        - `referenceImageUri` string, nullable, required — A URI pointing to a low-resolution preview of the avatar's reference image.
        - `processedImageUri` string, nullable, required — A URI pointing to a low-resolution preview of the processed reference image.
        - `documentIds` string[], required — IDs of knowledge documents attached to this avatar.
        - `createdAt` string, date-time, required — When the avatar was created.
        - `updatedAt` string, date-time, required — When the avatar was last updated.
        - `status` 'READY', required
      - object — An avatar that failed to finish processing.
        - `id` string, uuid, required — The unique identifier of the avatar.
        - `name` string, required — The character name for the avatar.
        - `personality` string, required — System prompt defining how the avatar should behave in conversations.
        - `startScript` string, nullable, required — Opening message that the avatar will say when a session starts, or null if not set.
        - `voice` union, required — The voice configured for this avatar.
          - object — A preset voice from the Runway API.
            - `type` 'runway-live-preset', required
            - `presetId` 'victoria' | 'vincent' | 'clara' | 'drew' | 'skye' | 'max' | 'morgan' | 'felix' | 'mia' | 'marcus' | 'summer' | 'ruby' | 'aurora' | 'jasper' | 'leo' | 'adrian' | 'nina' | 'emma' | 'blake' | 'david' | 'maya' | 'nathan' | 'sam' | 'georgia' | 'petra' | 'adam' | 'zach' | 'violet' | 'roman' | 'luna', required — The preset voice identifier.
            - `name` string, required — The display name of the voice.
            - `description` string, required — A brief description of the voice characteristics.
          - object — A custom voice created via the Voices API.
            - `type` 'custom', required
            - `id` string, uuid, required — The unique identifier of the custom voice.
            - `deleted` boolean, required — Whether the voice has been deleted. When true, name and description are omitted.
            - `name` string — The display name of the voice.
            - `description` string, nullable — A brief description of the voice characteristics.
        - `referenceImageUri` string, nullable, required — A URI pointing to a low-resolution preview of the avatar's reference image.
        - `processedImageUri` string, nullable, required — A URI pointing to a low-resolution preview of the processed reference image.
        - `documentIds` string[], required — IDs of knowledge documents attached to this avatar.
        - `createdAt` string, date-time, required — When the avatar was created.
        - `updatedAt` string, date-time, required — When the avatar was last updated.
        - `status` 'FAILED', required
        - `failureReason` string, required — A human-readable error message. This value is not stable and should not be matched against programmatically.
  - `hasMore` boolean, required — Whether there are more items available after this page.
  - `nextCursor` string, nullable, required — Cursor to use for fetching the next page, or null if there are no more pages.

---

[API](https://skmtc.net/runwayml/apis/runwayml-api.md) · [All operations](https://skmtc.net/runwayml/apis/runwayml-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/runwayml/runwayml-api/versions/e7d9a59ac7b0/schema)