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

# Get the caller's credit balance

> Personal keys return the account balance. Agency (white-label) keys return the shared agency credit pool, with `balance: pool` and the agency name.




## OpenAPI

````yaml /openapi.yaml get /v1/credits
openapi: 3.1.0
info:
  title: Cherry Shot API
  version: 1.0.0
  description: >
    Generate studio-quality product photography and video ads programmatically.
    Authenticate with an API key (`Authorization: Bearer cs_...` or `x-api-key:
    cs_...`). Generation is asynchronous: create a shoot or video, then poll it
    until `status` is `completed`. Credits are charged the same as in the app.
servers:
  - url: https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/credits:
    get:
      summary: Get the caller's credit balance
      description: >
        Personal keys return the account balance. Agency (white-label) keys
        return the shared agency credit pool, with `balance: pool` and the
        agency name.
      responses:
        '200':
          description: Balance
          content:
            application/json:
              schema:
                type: object
                properties:
                  credits:
                    type: integer
                  balance:
                    type: string
                    enum:
                      - pool
                    description: Present on agency keys only.
                  tenant:
                    type: string
                    description: Agency name; present on agency keys only.
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    BearerAuth:
      type: http
      scheme: bearer

````