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

# Retrieve an avatar

> Fetch one avatar: a Boson preset or one of your account's avatars.



## OpenAPI

````yaml /openapi.json get /v1/avatars/{avatar_id}
openapi: 3.0.3
info:
  title: Boson AI API
  description: REST API for Boson AI audio models.
  version: 1.0.0
  license:
    name: Proprietary
servers:
  - url: https://api.boson.ai
security:
  - bearerAuth: []
paths:
  /v1/avatars/{avatar_id}:
    get:
      tags:
        - Avatar Realtime
      summary: Retrieve an avatar
      description: 'Fetch one avatar: a Boson preset or one of your account''s avatars.'
      operationId: getAvatar
      parameters:
        - name: avatar_id
          in: path
          required: true
          description: The avatar ID, e.g. `avatar_9f3c...` or `builtin_claire_v1`.
          schema:
            type: string
      responses:
        '200':
          description: The avatar.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Avatar'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such avatar in your account (`avatar_not_found`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Avatar:
      type: object
      properties:
        avatar_id:
          type: string
          description: Pass this as `avatar_id` when creating a session.
          example: builtin_claire_v1
        object:
          type: string
          enum:
            - avatar
          default: avatar
        name:
          type: string
          example: Claire
        width:
          type: integer
          description: Reference image width in pixels.
        height:
          type: integer
          description: Reference image height in pixels.
        is_public:
          type: boolean
          description: >-
            `true` for a Boson preset, `false` for one of your account's
            avatars.
        created_at:
          type: string
          format: date-time
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
            type:
              type: string
              description: Error category.
            code:
              type: string
              nullable: true
              description: Machine-readable cause within `type`.
            param:
              type: string
              nullable: true
              description: The offending parameter, if any.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your Boson API key, sent as `Authorization: Bearer $BOSON_API_KEY`.'

````

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