> ## Documentation Index
> Fetch the complete documentation index at: https://developers.x-pilot.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List owned avatars

> Owned avatars and quota. Only avatars with selectable=true can be used as video_config.avatar_id.

export const XpilotArticleMetadata = () => <script type="application/ld+json" data-xpilot-article-metadata="" dangerouslySetInnerHTML={{
  __html: "{\"@context\":\"https://schema.org\",\"@id\":\"https://developers.x-pilot.ai/api-reference/list-avatars#apireference\",\"author\":{\"@type\":\"Organization\",\"@id\":\"https://www.x-pilot.ai/#organization\",\"name\":\"X-Pilot\",\"url\":\"https://www.x-pilot.ai/\"},\"image\":{\"@type\":\"ImageObject\",\"url\":\"https://developers.x-pilot.ai/images/integration-api.png\",\"width\":1200,\"height\":675,\"caption\":\"REST requests use a scoped API key. Keys, credits and usage are managed in the App console.\"}}"
}} />;

<XpilotArticleMetadata />

export const XpilotBreadcrumb = () => <nav aria-label="Breadcrumb" className="xpilot-breadcrumb"><ol><li><a href="/">X-Pilot Developers</a></li><li aria-current="page"><span aria-hidden="true">/</span><span>List owned avatars</span></li></ol></nav>;

<XpilotBreadcrumb />

<p className="xpilot-doc-author">Documentation by <a href="https://www.x-pilot.ai/">X-Pilot</a></p>

Required scope: `avatars:read`.

[Manage API keys](https://app.x-pilot.ai/developers/console) · [Authentication and recovery](/api-reference)

export const XpilotDocFigure = () => <figure className="xpilot-doc-figure"><img src="/images/integration-api.png" alt="An application sends a scoped API key to the X-Pilot REST API and receives an HTTP status and JSON response." width="1200" height="675" loading="lazy" /><figcaption>REST requests use a scoped API key. Keys, credits and usage are managed in the App console.</figcaption></figure>;

<XpilotDocFigure />


## OpenAPI

````yaml openapi.json GET /v1/avatars
openapi: 3.0.3
info:
  title: X-Pilot Developer API
  version: 1.1.0
  description: >-
    Generated from the same public REST contract used by the X-Pilot app. REST
    uses scoped API Keys. MCP OAuth tokens do not authenticate REST requests.
servers:
  - url: https://api.x-pilot.ai
    description: Production; confirm the deployed base URL in Developer Console.
security:
  - BearerAuth: []
tags:
  - name: Video Agent
  - name: Renders
  - name: Brand kits
  - name: Account & capacity
  - name: Assets
  - name: Voices & audio
  - name: Avatars
paths:
  /v1/avatars:
    get:
      tags:
        - Avatars
      summary: List owned avatars
      description: >-
        Owned avatars and quota. Only avatars with selectable=true can be used
        as video_config.avatar_id.
      operationId: list-avatars
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  items:
                    - id: 11
                      name: Instructor
                      avatar_type: human_video
                      status: ready
                      training_status: ready
                      preview_status: ready
                      selectable: true
                      stage: null
                      preview_image_url: <image_url>
                      preview_video_url: <video_url>
                      error: null
                      created_at: 1791849600
                      updated_at: 1791849680
                  total: 1
                  quota:
                    used: 1
                    limit: 6
        '400':
          description: Check parameter types, required fields and idempotency key.
          content:
            application/json:
              example:
                error:
                  code: invalid_parameter
                  message: Check parameter types, required fields and idempotency key.
                request_id: <request_id>
        '401':
          description: Use an active scoped API Key. MCP OAuth tokens cannot call REST.
          content:
            application/json:
              example:
                error:
                  code: invalid_token
                  message: >-
                    Use an active scoped API Key. MCP OAuth tokens cannot call
                    REST.
                request_id: <request_id>
        '403':
          description: Check the credential scope and resource ownership.
          content:
            application/json:
              example:
                error:
                  code: insufficient_scope
                  message: Check the credential scope and resource ownership.
                request_id: <request_id>
        '429':
          description: >-
            Credential/workspace rate or concurrency limit reached. Respect
            Retry-After before retrying.
          content:
            application/json:
              example:
                error:
                  code: rate_limited
                  message: >-
                    Credential/workspace rate or concurrency limit reached.
                    Respect Retry-After before retrying.
                  retry_after: 60
                request_id: <request_id>
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --fail-with-body --request GET \
              --url "$XPILOT_API_BASE_URL/v1/avatars" \
              --header "Authorization: Bearer $XPILOT_API_KEY"
        - lang: javascript
          label: JavaScript
          source: >-
            const response = await fetch(process.env.XPILOT_API_BASE_URL +
            "/v1/avatars", {
              method: "GET",
              headers: {
                Authorization: `Bearer ${process.env.XPILOT_API_KEY}`,
              },
            });

            const result = await response.json();

            if (!response.ok) throw new Error(JSON.stringify(result));

            console.log(result);
        - lang: python
          label: Python
          source: |-
            import os, json, requests

            response = requests.request(
                "GET",
                os.environ["XPILOT_API_BASE_URL"] + "/v1/avatars",
                headers={
                    "Authorization": "Bearer " + os.environ["XPILOT_API_KEY"],
                },
                timeout=70,
            )
            print(response.status_code, response.text)
            response.raise_for_status()
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Scoped X-Pilot API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.