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

# Usage

<Panel>
  <Note>
    Cost: **free**
  </Note>
</Panel>

Returns the current usage for the account:

* `credits_left`: credits left for the account (current balance; credits granted - credits used),
* `credits_granted`: credits granted for the account (total credits granted),
* `credits_used`: credits used for the account (total credits used),
* `plan`: plan details (name and renewal date if applicable).

**This endpoint does not affect credits, but rate limits apply.**


## OpenAPI

````yaml api-reference/openapi-0.yaml get /usage
openapi: 3.1.0
info:
  title: Workfloows API
  version: '0'
  description: >
    ## Introduction


    This API provides a growing collection of powerful tools and endpoints 

    commonly used in automation workflows. It's designed for individual
    automators, 

    agencies, and app builders who want to streamline processes and connect
    systems.


    ## Authentication


    All requests require an API key, which must be included in the `x-api-key`
    header.


    ```

    x-api-key: <your_api_key>

    ```


    If the API key is missing or invalid, a `401 Unauthorized` response will be
    returned.
servers:
  - url: https://api.workfloo.ws/v0
security: []
paths:
  /usage:
    get:
      tags:
        - Health
      operationId: usage
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                required:
                  - timestamp
                  - credits_left
                  - credits_granted
                  - credits_used
                  - plan
                properties:
                  timestamp:
                    type: string
                    description: Timestamp
                    example: '2025-01-01T00:00:00.000Z'
                  credits_left:
                    type: number
                    description: >-
                      Credits left for the account (current balance; credits
                      granted - credits used)
                    example: 900
                  credits_granted:
                    type: number
                    description: Credits granted for the account (total credits granted)
                    example: 1000
                  credits_used:
                    type: number
                    description: Credits used for the account (total credits used)
                    example: 100
                  plan:
                    type: object
                    description: Plan
                    properties:
                      name:
                        type: string
                        description: Plan name
                        example: Starter
                      renewal_date:
                        type: string
                        description: >-
                          Renewal date (if the plan is not prepaid or
                          subscription cancelled; otherwise null)
                        example: '2025-02-01T00:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - apiKeyAuth: []
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          examples:
            unauthorized:
              summary: Unauthorized
              value:
                error: Unauthorized.
            apiKeyRequired:
              summary: API Key required
              value:
                error: Unauthorized. API key is required.
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          examples:
            invalidApiKey:
              summary: Invalid API key
              value:
                error: Invalid API key.
            apiKeyNotFound:
              summary: API Key not found
              value:
                error: API Key not found.
            rateLimitExceeded:
              summary: Rate limit exceeded
              value:
                error: Rate limit exceeded.
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          examples:
            userNotFound:
              summary: User not found
              value:
                error: User not found.
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: An error occurred while processing your request.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````