> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bey.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Avatar

> Retrieve a single avatar by ID.



## OpenAPI

````yaml /openapi.json get /v1/avatars/{id}
openapi: 3.1.0
info:
  title: Beyond Presence API
  summary: Create, configure, and run interactive real-time avatars.
  description: >
    The Beyond Presence API lets you build lifelike, real-time avatars.


    ## Authentication


    Authenticate every request with your API key in the `x-api-key` header:


    ```

    x-api-key: <your-api-key>

    ```


    You can create and manage API keys in the dashboard, and verify a key with

    `GET /v1/auth/verify`.


    ## Pagination


    List endpoints are cursor-paginated. Pass `limit` (1-50, default 10) to
    control

    the page size and `cursor` to fetch the next page. Each response includes a

    `next_cursor` when more results are available.


    ## Errors


    Errors return the appropriate HTTP status code with a JSON body containing a

    `detail` message with more information.


    ## Rate limits


    Usage and concurrency limits are tied to your plan and surfaced as HTTP
    `429`

    responses.
  version: 0.3.0
servers:
  - url: https://api.bey.dev
security: []
paths:
  /v1/avatars/{id}:
    get:
      tags:
        - Avatars
      summary: Retrieve Avatar
      description: Retrieve a single avatar by ID.
      operationId: get_avatar_v1_avatars__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            description: Avatar ID.
            title: Id
          description: Avatar ID.
      responses:
        '200':
          description: Requested Avatar
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvatarResponse'
        '401':
          description: >-
            Authentication failed. The `x-api-key` header is missing or the
            provided API key is invalid.
          content:
            application/json:
              examples:
                missing:
                  summary: Missing API key
                  value:
                    detail: API key is required.
                invalid:
                  summary: Invalid API key
                  value:
                    detail: Invalid API key.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            The API key is valid but not permitted to perform this action,
            either because the resource belongs to someone else or because the
            requested feature requires a plan upgrade.
          content:
            application/json:
              examples:
                permission:
                  summary: Not permitted
                  value:
                    detail: You do not have permission to access this resource.
                plan:
                  summary: Plan upgrade required
                  value:
                    detail: >-
                      This feature is not available on your current plan. Please
                      upgrade your plan.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The requested resource does not exist or is not accessible with this
            API key.
          content:
            application/json:
              example:
                detail: The requested resource was not found.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            The request is malformed. `detail` lists each field that failed
            validation, where it was located, and why.
          content:
            application/json:
              example:
                detail:
                  - loc:
                      - body
                      - name
                    msg: Field required
                    type: missing
        '429':
          description: >-
            A plan limit has been exceeded, either the usage limit or the number
            of concurrent sessions.
          content:
            application/json:
              examples:
                usage:
                  summary: Usage limit exceeded
                  value:
                    detail: Usage limit exceeded. Please upgrade your plan.
                concurrency:
                  summary: Concurrency limit exceeded
                  value:
                    detail: >-
                      You have reached your concurrency limit. Please upgrade
                      your plan or stop other ongoing sessions.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    AvatarResponse:
      properties:
        visibility:
          $ref: '#/components/schemas/Visibility'
        id:
          type: string
          title: Id
          description: Unique identifier of the object in the database.
          examples:
            - 01234567-89ab-cdef-0123-456789abcdef
        name:
          type: string
          title: Name
          examples:
            - John Doe
            - Jane Smith
        status:
          $ref: '#/components/schemas/AvatarStatus'
      type: object
      required:
        - visibility
        - id
        - name
        - status
      title: AvatarResponse
      description: Response model for an avatar.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable description of the error.
          examples:
            - Invalid API key.
      type: object
      required:
        - detail
      title: ErrorResponse
      description: >-
        Standard error response body.


        Carries a single human-readable `detail` message describing what went

        wrong. This is the shape of every error response except validation
        errors

        (`422`), which instead return a list of per-field error objects.
    Visibility:
      type: string
      enum:
        - public
        - private
      title: Visibility
      description: Visibility of the resource.
    AvatarStatus:
      type: string
      enum:
        - to-train
        - training
        - available
        - failed
      title: AvatarStatus
      description: Status of an avatar.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Your Beyond Presence API Key.
      in: header
      name: x-api-key

````

## Related topics

- [Retrieve Agent](/api-reference/agents/retrieve-agent.md)
- [Retrieve Call](/api-reference/calls/retrieve-call.md)
- [Retrieve Knowledge File](/api-reference/knowledge-files/retrieve-knowledge-file.md)
- [Retrieve LiveKit Audio-to-Video Sessions](/api-reference/sessions/retrieve-livekit-audio-to-video-sessions.md)
- [Retrieve External API Configuration](/api-reference/external-apis/retrieve-external-api-configuration.md)