> ## 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.

# create avatar

> Create an avatar from an owned asset_id or a public http(s) image/video URL. Third-party URLs are downloaded and archived to the caller’s owned storage before training. Requires platform entitlement. Poll get_avatar for preview_image_url and preview_video_url, or receive avatar.completed / avatar.failed through callback_url or a webhook subscription. Reuse Idempotency-Key on retry; never retrain automatically.

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/create-avatar#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="/api-reference/list-avatars">Avatars</a></li><li aria-current="page"><span aria-hidden="true">/</span><span>create avatar</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:write`. A stable `Idempotency-Key` is required for exact retries.

[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 POST /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:
    post:
      tags:
        - Avatars
      summary: create avatar
      description: >-
        Create an avatar from an owned asset_id or a public http(s) image/video
        URL. Third-party URLs are downloaded and archived to the caller’s owned
        storage before training. Requires platform entitlement. Poll get_avatar
        for preview_image_url and preview_video_url, or receive avatar.completed
        / avatar.failed through callback_url or a webhook subscription. Reuse
        Idempotency-Key on retry; never retrain automatically.
      operationId: create-avatar
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Stable key for exact retries only. Use a different key for a
            different operation or input.
          schema:
            type: string
            minLength: 8
            maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Avatar name.
                  maxLength: 80
                avatar_type:
                  type: string
                  description: Training source.
                  enum:
                    - human_video
                    - virtual_character
                asset_id:
                  type: string
                  description: >-
                    Owned asset ID returned by POST /v1/assets. human_video uses
                    a video asset; virtual_character uses an image asset.
                image_url:
                  type: string
                  description: >-
                    Public http(s) image URL. The backend archives third-party
                    content to your owned storage before training. Use this or
                    asset_id for virtual_character.
                video_url:
                  type: string
                  description: >-
                    Public http(s) training video URL. The backend archives
                    third-party content to your owned storage before training.
                    Use this or asset_id for human_video.
                gender:
                  type: string
                  description: Required for image avatars.
                  enum:
                    - Male
                    - Female
                callback_url:
                  type: string
                  description: >-
                    Optional public HTTPS URL notified once with
                    avatar.completed or avatar.failed. Signed with the workspace
                    callback secret (X-XPilot-Signature). Only set it when you
                    run a receiving service.
                  maxLength: 2048
                callback_id:
                  type: string
                  description: >-
                    Optional reference echoed back as data.callback_id. Requires
                    callback_url.
                  maxLength: 128
              required:
                - name
                - avatar_type
      responses:
        '202':
          description: Success
          content:
            application/json:
              example:
                data:
                  id: <avatar_id>
                  name: Presenter
                  avatar_type: human_video
                  status: generating
                  training_status: pending
                  preview_status: not_requested
                  selectable: false
                  stage: provider_processing
                  preview_image_url: null
                  preview_video_url: null
                  error: null
                  created_at: 1791849600
                  updated_at: 1791849600
        '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>
        '409':
          description: >-
            The same idempotency key must use the exact same input. A
            conversation may already be busy.
          content:
            application/json:
              example:
                error:
                  code: idempotency_conflict
                  message: >-
                    The same idempotency key must use the exact same input. A
                    conversation may already be busy.
                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 POST \
              --url "$XPILOT_API_BASE_URL/v1/avatars" \
              --header "Authorization: Bearer $XPILOT_API_KEY" \
              --header 'Content-Type: application/json' \
              --header 'Idempotency-Key: lesson-request-001' \
              --data '{"name":"<name>","avatar_type":"human_video","video_url":"https://cdn.example.com/training.mp4"}'
        - lang: javascript
          label: JavaScript
          source: >-
            const response = await fetch(process.env.XPILOT_API_BASE_URL +
            "/v1/avatars", {
              method: "POST",
              headers: {
                Authorization: `Bearer ${process.env.XPILOT_API_KEY}`,
                "Content-Type": "application/json",
                "Idempotency-Key": "lesson-request-001",
              },
              body: JSON.stringify({
              "name": "<name>",
              "avatar_type": "human_video",
              "video_url": "https://cdn.example.com/training.mp4"
            }),

            });

            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(
                "POST",
                os.environ["XPILOT_API_BASE_URL"] + "/v1/avatars",
                headers={
                    "Authorization": "Bearer " + os.environ["XPILOT_API_KEY"],
                    "Content-Type": "application/json",
                    "Idempotency-Key": "lesson-request-001",
                },
                json=json.loads("{\"name\":\"<name>\",\"avatar_type\":\"human_video\",\"video_url\":\"https://cdn.example.com/training.mp4\"}"),
                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.