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

# Get credit balance

> Free. Returns the shared customer balance and account-specific terms and limits.



## OpenAPI

````yaml GET /api/v1/credits
openapi: 3.1.0
info:
  title: YCpedia API
  version: 1.0.0
  description: >-
    Read, generate, and update profile articles by LinkedIn ID. Obtain your API
    key and API base URL from the YCpedia team.
servers:
  - url: https://api.thealmanac.ai
    description: Production API
security:
  - CustomerApiKey: []
paths:
  /api/v1/credits:
    get:
      summary: Get credit balance
      description: >-
        Free. Returns the shared customer balance and account-specific terms and
        limits.
      operationId: get_credit_balance
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiBalanceResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          additionalProperties: true
                          type: object
                required:
                  - detail
        '422':
          description: Invalid request or missing Idempotency-Key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          additionalProperties: true
                          type: object
                required:
                  - detail
        '429':
          description: Rate limit exceeded. Wait for the Retry-After duration.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    oneOf:
                      - type: string
                      - type: array
                        items:
                          additionalProperties: true
                          type: object
                required:
                  - detail
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                example: 60
      security:
        - CustomerApiKey: []
components:
  schemas:
    ApiBalanceResponse:
      properties:
        credits:
          title: Credits
          type: integer
        pricing:
          $ref: '#/components/schemas/ApiPricing'
      required:
        - credits
        - pricing
      title: ApiBalanceResponse
      type: object
    ApiPricing:
      properties:
        read_credits:
          default: 1
          exclusiveMinimum: 0
          title: Read Credits
          type: integer
        generation_credits:
          default: 100
          exclusiveMinimum: 0
          title: Generation Credits
          type: integer
        credit_price_cents:
          exclusiveMinimum: 0
          title: Credit Price Cents
          type: integer
          description: Account-specific price per credit in cents, agreed with your team.
        queued_timeout_minutes:
          default: 30
          exclusiveMinimum: 0
          title: Queued Timeout Minutes
          type: integer
        requests_per_minute:
          default: 120
          exclusiveMinimum: 0
          title: Requests Per Minute
          type: integer
        min_purchase_credits:
          default: 10
          exclusiveMinimum: 0
          title: Min Purchase Credits
          type: integer
        max_purchase_credits:
          default: 100000
          exclusiveMinimum: 0
          title: Max Purchase Credits
          type: integer
      title: ApiPricing
      type: object
  securitySchemes:
    CustomerApiKey:
      type: http
      scheme: bearer
      description: Your customer API key (alm_…). Keep it on your server.

````