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

# Get the account

> Your balance, prices and billing settings, this month's usage and the last 30 days.



## OpenAPI

````yaml /api-reference/openapi.json get /account
openapi: 3.1.0
info:
  title: Talking Avatar API
  version: '1'
  description: >-
    Your account from your server, with an API key: voice agents, calls,
    knowledge bases, links, usage and billing. Send API-Version: 1 to pin
    version 1.
servers:
  - url: https://backend.talking-avatar.dev/api/talking-avatar
security:
  - apiKey: []
paths:
  /account:
    get:
      summary: Get the account
      description: >-
        Your balance, prices and billing settings, this month's usage and the
        last 30 days.
      parameters:
        - name: API-Version
          in: header
          description: 'The API version. Without it: 1.'
          schema:
            type: string
            enum:
              - '1'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      accountId:
                        type: string
                        format: uuid
                      balanceUsd:
                        type: number
                        description: Your balance, in US dollars
                      ratePerMinuteUsd:
                        type: number
                        description: What a Realistic Avatars minute costs
                      voiceAgentRatePerMinuteUsd:
                        type: number
                        description: What a voice agent minute costs
                      cardSaved:
                        type: boolean
                        description: A card is saved for auto top-up
                      watermarkRemoved:
                        type: boolean
                        description: The Remove watermark plan is on
                      autoTopUp:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                            description: On or off
                          thresholdUsd:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Tops up when your balance drops below this; null
                              when off
                          amountUsd:
                            type:
                              - number
                              - 'null'
                            description: What each top-up adds; null when off
                        required:
                          - enabled
                          - thresholdUsd
                          - amountUsd
                        additionalProperties: false
                        description: Auto top-up
                      spendLimit:
                        type: object
                        properties:
                          monthlyUsd:
                            type:
                              - number
                              - 'null'
                            description: The limit; null for none
                          spentUsd:
                            type: number
                            description: This month's spend, running sessions included
                        required:
                          - monthlyUsd
                          - spentUsd
                        additionalProperties: false
                        description: Monthly spending limit
                      promo:
                        type:
                          - object
                          - 'null'
                        properties:
                          code:
                            type: string
                            description: The offer's code
                          applied:
                            type: boolean
                            description: 'You redeemed it: your next top-up is doubled'
                          maxBonusUsd:
                            type: number
                            description: The most the doubling adds
                          endsAt:
                            type: string
                            format: date-time
                            description: When the offer ends
                        required:
                          - code
                          - applied
                          - maxBonusUsd
                          - endsAt
                        additionalProperties: false
                        description: The current offer; null when none is running
                      customAvatars:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Use it as an avatar ID
                            name:
                              type: string
                            imageUrl:
                              type:
                                - string
                                - 'null'
                          required:
                            - id
                            - name
                            - imageUrl
                          additionalProperties: false
                        description: Your custom avatars
                      month:
                        type: object
                        properties:
                          minutes:
                            type: number
                          costUsd:
                            type: number
                          sessions:
                            type: integer
                        required:
                          - minutes
                          - costUsd
                          - sessions
                        additionalProperties: false
                        description: >-
                          This month's sessions (UTC): Realistic Avatars and
                          voice agent calls
                      liveSessions:
                        type: integer
                        description: Sessions running now
                      activeKeys:
                        type: integer
                        description: How many API keys you have
                      daily:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              format: date
                            minutes:
                              type: number
                            costUsd:
                              type: number
                          required:
                            - date
                            - minutes
                            - costUsd
                          additionalProperties: false
                        description: The last 30 days (UTC), oldest first
                    required:
                      - accountId
                      - balanceUsd
                      - ratePerMinuteUsd
                      - voiceAgentRatePerMinuteUsd
                      - cardSaved
                      - watermarkRemoved
                      - autoTopUp
                      - spendLimit
                      - promo
                      - customAvatars
                      - month
                      - liveSessions
                      - activeKeys
                      - daily
                    additionalProperties: false
                  code:
                    type: integer
                    const: 200
                  message:
                    type: string
                required:
                  - data
                  - code
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://backend.talking-avatar.dev/api/talking-avatar/account \
              -H "Authorization: Bearer $TALKING_AVATAR_API_KEY" \
              -H "API-Version: 1"
        - lang: python
          label: Python
          source: |-
            import os, requests

            response = requests.get(
                "https://backend.talking-avatar.dev/api/talking-avatar/account",
                headers={
                    "Authorization": f"Bearer {os.environ['TALKING_AVATAR_API_KEY']}",
                    "API-Version": "1",
                },
            )
            response.raise_for_status()
            data = response.json()["data"]
        - lang: javascript
          label: Node.js
          source: >-
            const response = await
            fetch("https://backend.talking-avatar.dev/api/talking-avatar/account",
            {
              method: "GET",
              headers: {
                Authorization: `Bearer ${process.env.TALKING_AVATAR_API_KEY}`,
                "API-Version": "1",
              },
            });

            const { data } = await response.json();
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
          description: The HTTP status
        message:
          type: string
          description: What went wrong, readable
        data:
          type: 'null'
      required:
        - code
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Your API key, tav_…
      x-default: YOUR_API_KEY

````

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