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

# Read available credits

> Read this project key’s organization credit summary. total_credits is available USD after reservations; total_usage is recorded USD usage. Requires credits:read.



## OpenAPI

````yaml /openapi.json get /v1/credits
openapi: 3.1.0
info:
  title: Limitless API
  version: 0.2.0
  description: >-
    Customer inference, scoped organization administration, policies, and health
    probes for Limitless at https://trylimitless.ai. This deployment uses
    sandbox credits and test payments but sends real inference requests. Model
    features depend on the active backend. The OpenAI SDK base URL is
    https://trylimitless.ai/v1.
servers:
  - url: https://trylimitless.ai
    description: >-
      Limitless sandbox API: test payments and real inference. OpenAI SDK
      clients add /v1 to this origin.
security:
  - customerKey: []
tags:
  - name: Health
  - name: Models
  - name: Inference
  - name: Credits
  - name: Organization
  - name: Projects
  - name: Project keys
  - name: Admin keys
  - name: Spending limits
  - name: Reports
  - name: Policies
paths:
  /v1/credits:
    get:
      tags:
        - Credits
      summary: Read available credits
      description: >-
        Read this project key’s organization credit summary. total_credits is
        available USD after reservations; total_usage is recorded USD usage.
        Requires credits:read.
      operationId: getCredits
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCreditsResponse'
          description: Successful response.
          headers:
            X-Request-ID:
              description: Gateway request ID for Activity and support.
              schema:
                type: string
                format: uuid
        '401':
          $ref: '#/components/responses/Api401'
        '403':
          $ref: '#/components/responses/Api403'
        '422':
          $ref: '#/components/responses/Api422'
        '429':
          $ref: '#/components/responses/Api429'
        '500':
          $ref: '#/components/responses/Api500'
        '503':
          $ref: '#/components/responses/Api503'
      security:
        - customerKey: []
        - customerHeaderKey: []
components:
  schemas:
    PublicCreditsResponse:
      properties:
        data:
          $ref: '#/components/schemas/PublicCreditsData'
      type: object
      required:
        - data
    PublicCreditsData:
      properties:
        total_credits:
          type: number
          description: Spendable USD after subtracting current reservations.
        total_usage:
          type: number
          description: Recorded lifetime USD usage for this organization.
      type: object
      required:
        - total_credits
        - total_usage
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - error
    ErrorDetail:
      properties:
        code:
          type: string
        message:
          type: string
        type:
          type: string
          description: Error category; policy failures use policy_error.
        param:
          anyOf:
            - type: string
            - type: 'null'
        request_id:
          type: string
        doc_url:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - code
        - message
        - type
  responses:
    Api401:
      headers:
        X-Request-ID:
          description: Gateway request ID for Activity and support.
          schema:
            type: string
            format: uuid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Missing or invalid credential.
    Api403:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Credential scope or policy denied this operation.
      headers:
        X-Request-ID:
          description: Gateway request ID for Activity and support.
          schema:
            type: string
            format: uuid
    Api422:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Provider request validation failed.
      headers:
        X-Request-ID:
          description: Gateway request ID for Activity and support.
          schema:
            type: string
            format: uuid
    Api429:
      headers:
        X-Request-ID:
          description: Gateway request ID for Activity and support.
          schema:
            type: string
            format: uuid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Request rate or concurrency exceeded.
    Api500:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Unexpected gateway failure.
      headers:
        X-Request-ID:
          description: Gateway request ID for Activity and support.
          schema:
            type: string
            format: uuid
    Api503:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: A required service or configuration is unavailable.
      headers:
        X-Request-ID:
          description: Gateway request ID for Activity and support.
          schema:
            type: string
            format: uuid
  securitySchemes:
    customerKey:
      type: http
      scheme: bearer
      bearerFormat: lk_...
      description: >-
        Project customer key. Requires the permission for the requested
        endpoint.
    customerHeaderKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Alternative project-key header. Authorization takes precedence when both
        are supplied.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.