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

# Get remaining credits

> Returns remaining credits across all active subscription lines for the authenticated account.



## OpenAPI

````yaml /reference/openapi.yaml get /v2/credits
openapi: 3.1.0
info:
  title: Tamtam Public API
  version: 2.0.0
servers:
  - url: https://api.tamtam.ai/api
security: []
paths:
  /v2/credits:
    get:
      tags:
        - Credits
      summary: Get remaining credits
      description: >-
        Returns remaining credits across all active subscription lines for the
        authenticated account.
      operationId: get-credits
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCreditsResponseDto'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - apikeyAuth: []
        - bearerAuth: []
components:
  schemas:
    GetCreditsResponseDto:
      additionalProperties: false
      properties:
        credits:
          description: Credit lines for the account across all active subscriptions
          items:
            $ref: '#/components/schemas/CreditLineV2Dto'
          type:
            - array
            - 'null'
      required:
        - credits
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    CreditLineV2Dto:
      additionalProperties: false
      properties:
        credit_type:
          description: Credit type
          examples:
            - MaxKeyAccountsUnlocked
          type: string
        remaining_credits:
          description: Credits remaining in current period
          examples:
            - 4990
          format: int32
          type: integer
        total_credits:
          description: Total credits available in current period
          examples:
            - 5000
          format: int32
          type: integer
        used_credits:
          description: Number of credits used in current period
          examples:
            - 10
          format: int32
          type: integer
      required:
        - credit_type
        - used_credits
        - total_credits
        - remaining_credits
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    apikeyAuth:
      description: Account API key passed in the Authorization header
      in: header
      name: Authorization
      type: apiKey
    bearerAuth:
      description: Bearer JWT obtained via the OAuth 2.1 authorization flow
      scheme: bearer
      type: http

````