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

# Get credit balance

> Returns the workspace credit balance and billing configuration

Requires `billing:read` scope.

All parameters, request/response schemas, and examples are auto-generated from the [OpenAPI specification](/api-reference/overview).


## OpenAPI

````yaml GET /v1/workspaces/{workspace_id}/billing/balance
openapi: 3.1.0
info:
  title: Auriko API
  version: 1.0.0
  description: >
    Intelligent LLM routing API with OpenAI-compatible interface.


    ## Overview


    Auriko provides a unified API for accessing multiple LLM providers with
    intelligent

    routing based on cost, latency, throughput, and availability.


    ## OpenAI Compatibility


    The API is compatible with OpenAI's Chat Completions API. You can use any

    OpenAI SDK by changing the base URL and API key.


    ## Auriko Extensions


    Beyond OpenAI compatibility, Auriko adds:


    - **Multi-model routing**: Request multiple models with `gateway.models[]`
    array

    - **Routing options**: Control provider selection with `routing` object

    - **Provider extensions**: Pass provider-specific parameters with
    `extensions` object

    - **Routing metadata**: Get transparency into routing decisions via
    `routing_metadata`
  contact:
    name: Auriko Support
    url: https://auriko.ai
  license:
    name: Proprietary
    url: https://auriko.ai/terms
servers:
  - url: https://api.auriko.ai
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Chat
    description: Chat completion endpoints
  - name: Responses
    description: OpenAI Response API endpoints
  - name: Callable Models
    description: Model IDs available for authenticated inference requests
  - name: Model Catalog
    description: Public model and provider catalog endpoints
  - name: Workspaces
    description: Workspace management
  - name: Budgets
    description: Spend control and budget management
  - name: API Keys
    description: API key management
  - name: BYOK
    description: Bring-your-own-key provider key management
  - name: Billing
    description: Credit balance and billing
  - name: Account
    description: API key introspection
  - name: Messages
    description: Anthropic Messages API endpoints
  - name: Routing
    description: Workspace routing configuration
  - name: Usage
    description: Usage statistics and request lookup
  - name: Members
    description: Workspace member and invite management
  - name: Audit
    description: Workspace audit event log
paths:
  /v1/workspaces/{workspace_id}/billing/balance:
    parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Workspace identifier
    get:
      tags:
        - Billing
      summary: Get credit balance
      description: |
        Returns the workspace credit balance, tier, and billing configuration.
        Requires `billing:read` scope.
      operationId: getCreditBalance
      responses:
        '200':
          description: Credit balance and billing details
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalanceResponse'
              example:
                balance_microdollars: 4850000
                balance_cents: 4850
                balance_dollars: '48.50'
                lifetime_purchased_microdollars: 10000000
                lifetime_purchased_cents: 10000
                lifetime_used_microdollars: 5150000
                lifetime_used_cents: 5150
                auto_reload_enabled: false
                has_payment_method: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/GatewayUnavailable'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: >
            curl
            https://api.auriko.ai/v1/workspaces/550e8400-e29b-41d4-a716-446655440000/billing/balance
            \
              -H "Authorization: Bearer $AURIKO_API_KEY"
components:
  headers:
    X-Request-ID:
      description: |
        Unique request identifier for debugging and support.
        Include this in support requests for fast resolution.
      schema:
        type: string
      example: req_abc123def456
    X-Error-Type:
      description: |
        Same value as the `error.type` field in the response body, exposed as a
        header for programmatic routing without body parsing.
      schema:
        type: string
        enum:
          - invalid_request_error
          - rate_limit_error
          - api_error
          - authentication_error
          - not_found_error
          - permission_error
      example: invalid_request_error
    X-Error-Retryable:
      description: |
        Whether the client should retry this request.
        'true' for api_error and rate_limit_error types; 'false' for all others.
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
      example: 'false'
  schemas:
    CreditBalanceResponse:
      type: object
      required:
        - balance_microdollars
        - balance_cents
        - balance_dollars
        - lifetime_purchased_microdollars
        - lifetime_purchased_cents
        - lifetime_used_microdollars
        - lifetime_used_cents
        - auto_reload_enabled
        - has_payment_method
      properties:
        balance_microdollars:
          type: integer
          description: Current balance in microdollars (1 USD = 1,000,000 μ$)
        balance_cents:
          type: integer
          description: Current balance in cents (computed)
        balance_dollars:
          type: string
          description: Current balance in dollars (computed, string for precision)
          example: '48.50'
        lifetime_purchased_microdollars:
          type: integer
          description: Total credits ever purchased in microdollars
        lifetime_purchased_cents:
          type: integer
          description: Total credits ever purchased in cents (computed)
        lifetime_used_microdollars:
          type: integer
          description: Total credits ever consumed in microdollars
        lifetime_used_cents:
          type: integer
          description: Total credits ever consumed in cents (computed)
        auto_reload_enabled:
          type: boolean
          description: Whether auto-reload is enabled
        auto_reload_threshold_microdollars:
          type:
            - integer
            - 'null'
          description: Balance threshold triggering auto-reload
        auto_reload_threshold_cents:
          type:
            - integer
            - 'null'
          description: Balance threshold in cents (computed)
        auto_reload_amount_microdollars:
          type:
            - integer
            - 'null'
          description: Target balance amount for auto-reload
        auto_reload_amount_cents:
          type:
            - integer
            - 'null'
          description: Target balance amount in cents (computed)
        byok_monthly_cap:
          type:
            - integer
            - 'null'
          description: Monthly BYOK request cap (null if unlimited)
        byok_monthly_remaining:
          type:
            - integer
            - 'null'
          description: Remaining BYOK requests this month
        has_payment_method:
          type: boolean
          description: Whether a payment method is on file
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
    ErrorObject:
      type: object
      description: OpenAI-compatible error format
      required:
        - message
        - type
        - param
        - code
      properties:
        message:
          type: string
          description: Human-readable error message
        type:
          type: string
          description: Error category per guide §4.
          enum:
            - invalid_request_error
            - authentication_error
            - permission_error
            - not_found_error
            - rate_limit_error
            - api_error
        param:
          type:
            - string
            - 'null'
          description: Parameter that caused the error (null if not applicable)
        code:
          type: string
          description: Canonical code per guide §5 and docs/reference/error_codes.json.
          enum:
            - invalid_api_key
            - expired_api_key
            - insufficient_permissions
            - feature_disabled
            - mfa_required
            - invalid_recovery_code
            - mfa_verification_failed
            - invalid_request
            - missing_required_parameter
            - invalid_parameter_value
            - payload_too_large
            - context_length_exceeded
            - content_filtered
            - idempotency_conflict
            - idempotency_replay_unavailable
            - field_immutable
            - operation_not_allowed
            - unknown_field
            - state_precondition_failed
            - duplicate_resource
            - method_not_allowed
            - tools_not_supported
            - json_mode_not_supported
            - structured_output_not_supported
            - tools_with_structured_output_not_supported
            - vision_not_supported
            - reasoning_not_supported
            - thinking_disable_not_supported
            - streaming_not_supported
            - non_streaming_not_supported
            - batch_only
            - tier_opt_in_required
            - tool_choice_required_not_supported
            - cost_constraint_exceeded
            - latency_constraint_exceeded
            - throughput_constraint_not_met
            - provider_not_in_allowlist
            - provider_blocked
            - required_params_not_supported
            - byok_keys_required
            - platform_keys_unavailable
            - unsupported_modalities
            - no_compatible_endpoint
            - no_responses_endpoint
            - input_requires_responses_endpoint
            - response_api_only
            - hosted_tool_not_supported
            - model_not_found
            - resource_not_found
            - rate_limit_exceeded
            - budget_exhausted
            - insufficient_quota
            - no_provider_available
            - upstream_error
            - upstream_timeout
            - client_disconnected
            - model_unavailable
            - internal_error
            - service_unavailable
        doc_url:
          type: string
          description: Link to the canonical documentation page for this error code.
        provider:
          type:
            - string
            - 'null'
          description: >-
            Upstream provider that generated the error (e.g.,
            "google_ai_studio", "openai"). Null for errors not attributable to
            an upstream provider (local validation, auth, internal config).
        suggestion:
          type: string
          description: >-
            Actionable fix hint for routing, capability, or model-not-found
            errors. Absent for other error types.
  responses:
    BadRequest:
      description: Bad request - invalid parameters
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        X-Error-Type:
          $ref: '#/components/headers/X-Error-Type'
        X-Error-Retryable:
          $ref: '#/components/headers/X-Error-Retryable'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_model:
              summary: Missing model parameter
              value:
                error:
                  message: 'Missing required parameter: ''model''.'
                  type: invalid_request_error
                  param: model
                  code: missing_required_parameter
            invalid_models:
              summary: Invalid models array
              value:
                error:
                  message: gateway.models array cannot exceed 10 models
                  type: invalid_request_error
                  param: gateway.models
                  code: invalid_request
            vision_not_supported:
              summary: Model doesn't support requested capability
              value:
                error:
                  message: Model 'gpt-4.1-mini' does not support vision/image input.
                  type: invalid_request_error
                  param: null
                  code: vision_not_supported
            cost_constraint_exceeded:
              summary: Routing constraints excluded all providers
              value:
                error:
                  message: No provider meets the cost constraint for model 'gpt-4o'.
                  type: invalid_request_error
                  param: gateway.routing.max_cost_per_1m
                  code: cost_constraint_exceeded
    Unauthorized:
      description: Authentication failed
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        X-Error-Type:
          $ref: '#/components/headers/X-Error-Type'
        X-Error-Retryable:
          $ref: '#/components/headers/X-Error-Retryable'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: API key is invalid.
              type: authentication_error
              param: null
              code: invalid_api_key
    Forbidden:
      description: You do not have permission to perform this action
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        X-Error-Type:
          $ref: '#/components/headers/X-Error-Type'
        X-Error-Retryable:
          $ref: '#/components/headers/X-Error-Retryable'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: You do not have permission to perform this action.
              type: permission_error
              param: null
              code: insufficient_permissions
    NotFound:
      description: Resource not found
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        X-Error-Type:
          $ref: '#/components/headers/X-Error-Type'
        X-Error-Retryable:
          $ref: '#/components/headers/X-Error-Retryable'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: The requested resource was not found.
              type: not_found_error
              param: null
              code: resource_not_found
    InternalError:
      description: Internal server error
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        X-Error-Type:
          $ref: '#/components/headers/X-Error-Type'
        X-Error-Retryable:
          $ref: '#/components/headers/X-Error-Retryable'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: >-
                An unexpected error occurred. Contact support with the request
                ID.
              type: api_error
              param: null
              code: internal_error
    GatewayUnavailable:
      description: |
        API gateway is temporarily unavailable.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
        X-Error-Type:
          $ref: '#/components/headers/X-Error-Type'
        X-Error-Retryable:
          $ref: '#/components/headers/X-Error-Retryable'
        Retry-After:
          description: Seconds to wait before retrying
          schema:
            type: integer
          required: false
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: Gateway is temporarily unavailable. Retry in a few seconds.
              type: api_error
              param: null
              code: upstream_error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key authentication.
        Keys start with `ak_` prefix.
        Example: `Authorization: Bearer ak_live_xxxxxxxxxxxx`

````