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

# Get usage

> Check current ICS consumption and quota status for the authenticated token.



## OpenAPI

````yaml /openapi/client_v1_0.json get /api/v1/usage
openapi: 3.1.0
info:
  title: Blankstate IBF API
  version: 0.2.0
  description: >-
    ## Universal Interaction Sensing


    Measure any interaction against configurable **Protocols**, **Metrics**, and
    **Blueprints**.


    ### Core Concepts


    | Concept | Description |

    |---------|-------------|

    | **Protocol** | A sensor that detects specific interaction patterns
    (metamarkers) |

    | **Metric** | Weighted aggregation of protocol scores |

    | **Blueprint** | A complete sensing configuration, multiple protocols +
    metrics |

    | **ICS** | Interaction Computed Signal, outcome-based billing (1 ICS = 1
    triggered metamarker) |

    | **Fidelity** | Information sufficiency, does the input contain enough
    signal for reliable measurement? |


    ### Sensing Profiles


    Every sensing request accepts an optional `profile` parameter. The default
    is `raw`.


    | Profile | Description |

    |---------|-------------|

    | `raw` | *(default)* Raw sensor output. The sensor measures exactly what
    the protocol defines. Nothing added, nothing filtered. |

    | `detailed` | Same measurement + deep evidence chains with segment-level
    attribution and full reconstruction provenance. |

    | `discovery` | Same measurement + weak signal indicators. Near-threshold
    activations are reported separately so you can explore what the sensor
    _almost_ detected. |


    All profiles are **deterministic**: same profile + same input + same
    protocol = same output, always.


    ### SGM Version


    The API currently runs against SGM **0.2** in production. The API URL stays
    `/api/v1/` across model iterations. Existing Protocols continue to run
    against the same URL as the underlying model advances; version pinning lives
    on the Protocol itself.


    ### Base URL


    ```

    https://ibf.blankstate.ai

    ```


    ### Authentication


    ```

    Authorization: Bearer YOUR_API_TOKEN

    ```


    Obtain tokens from the [Atlas
    Dashboard](https://atlas.blankstate.ai/api-dashboard/tokens).


    ### Response Headers


    Every sensing response includes:


    | Header | Description |

    |--------|-------------|

    | `X-ICS-Consumed` | ICS consumed by this request |

    | `X-ICS-Remaining` | Remaining ICS quota for current period |

    | `X-RateLimit-Limit` | Maximum requests per window |

    | `X-RateLimit-Remaining` | Remaining requests in current window |

    | `X-RateLimit-Reset` | Unix timestamp when the rate limit resets |
  contact:
    name: Blankstate AI
    url: https://blankstate.ai
    email: contact@blankstate.ai
servers:
  - url: https://ibf.blankstate.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Service status and token verification
  - name: Sense
    description: >-
      Core measurement, sense interactions against protocols, metrics, or
      blueprints
  - name: Fidelity
    description: Pre-check information sufficiency before sensing (zero ICS cost)
  - name: Protocols
    description: Protocol sensors, browse and inspect detection configurations
  - name: Metrics
    description: Weighted aggregations of protocol scores
  - name: Blueprints
    description: Complete sensing configurations, protocols + metrics composed together
  - name: Usage
    description: ICS consumption, quotas, and cost estimation
  - name: Jobs
    description: Asynchronous job tracking for large file and batch processing
  - name: Capabilities
    description: Machine-readable API capability descriptions for tooling integration
paths:
  /api/v1/usage:
    get:
      tags:
        - Usage
      summary: Get usage
      description: >-
        Check current ICS consumption and quota status for the authenticated
        token.
      operationId: getUsage
      responses:
        '200':
          description: Current usage status
          content:
            application/json:
              example:
                tier: user
                quota: 50
                used: 12.5
                remaining: 37.5
                period: 2026-02
                reset: '2026-03-01T00:00:00Z'
                overage:
                  rate_usd: 0.003
                  used: 0
                  cost_usd: 0
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: Invalid or missing authentication token
components:
  responses:
    Unauthorized:
      description: Invalid or missing authentication token
      content:
        application/json:
          example:
            error:
              code: unauthorized
              message: >-
                Invalid or expired API token. Obtain a new token from
                atlas.blankstate.ai
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API token from Atlas Dashboard

````