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

# Get the credit balance

> Read a wallet's credits: total, blocked, and available.

Defaults to the key's own wallet (for account-bound keys, your account wallet). Pass `workspace_id` to read the balance of any workspace you can manage — ids come from [List workspaces](/api/list-workspaces).


## OpenAPI

````yaml api-reference/openapi.json GET /v1/credits
openapi: 3.0.3
info:
  title: Flowy App API
  version: 1.3.1
  description: >-
    Run Flowy apps and direct generations programmatically.


    Authenticate with a workspace API key in the `Authorization: Bearer` header.
    A **secret** key (`flowy_…`) is for servers; a **publishable** key
    (`flowy_pk_…`) is browser-safe and only works from its allowlisted domains.
    Every run or generation bills the API key's own workspace credits
    (caller-pays), so a leaked key can never spend another workspace's balance.


    Keys carry **scopes**: `apps:read` (list/inspect apps), `runs:read` (poll
    runs), `runs:write` (start runs), `generations:read` (poll direct
    generations), `generations:write` (start direct generations), `assets:read`
    (list/read workspace assets), and `credits:read` (read the credit balance).
    A request that needs a scope the key doesn't hold returns `403`.


    A published (public) app is runnable by any key; a private app is runnable
    only by a key of its own workspace.
servers:
  - url: https://apis.tryflowy.ai/genstudio-svc-v2/api
    description: Flowy production API
security:
  - ApiKeyAuth: []
tags:
  - name: Apps
    description: Discover apps and inspect their input/output schema.
  - name: Runs
    description: Start runs and poll for their results.
  - name: Generations
    description: Start direct image/video generations and poll for their results.
  - name: Assets
    description: Browse the workspace's asset library (uploads + generated media).
  - name: Credits
    description: Read the workspace's credit balance.
  - name: Spec
    description: The machine-readable OpenAPI document.
paths:
  /v1/credits:
    get:
      tags:
        - Credits
      summary: Get the credit balance
      description: >-
        Returns a credit balance: total, blocked (reserved by in-flight work)
        and available. Defaults to the authenticated key's own wallet (for
        account-bound keys, the account wallet). Pass workspace_id to read
        another workspace the account can manage (owner/editor).
      operationId: getCredits
      parameters:
        - name: workspace_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Optional workspace id (from GET /v1/workspaces). Default: the key's
            own wallet.
      responses:
        '200':
          description: The workspace credit balance.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CreditBalance'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the credits:read scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  headers:
    X-RateLimit-Limit:
      description: Maximum requests allowed in the current window (per minute).
      schema:
        type: integer
        example: 60
    X-RateLimit-Remaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
        example: 59
    X-RateLimit-Reset:
      description: Unix epoch second at which the current window resets.
      schema:
        type: integer
        example: 1893456000
    Retry-After:
      description: Seconds to wait before retrying (sent on 429).
      schema:
        type: integer
        example: 12
  schemas:
    CreditBalance:
      type: object
      properties:
        workspaceId:
          type: string
          example: 507f1f77bcf86cd799439011
        credits:
          type: number
          description: Total credits on the workspace wallet.
          example: 5000
        blockedCredits:
          type: number
          description: Credits reserved by in-flight generations/runs.
          example: 120
        available:
          type: number
          description: credits - blockedCredits.
          example: 4880
    Error:
      type: object
      properties:
        error:
          type: string
          example: this API key lacks the runs:write scope
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: flowy_*
      description: >-
        A workspace API key. Secret keys (`flowy_…`) are server-side — keep them
        private. Publishable keys (`flowy_pk_…`) are browser-safe but only work
        from their allowlisted domains.

````