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

# Get signal-credit usage for the current billing period

> The workspace's existing signal credits, as the dashboard shows them: credits used so far
in the current billing period and the plan's limit. It reports usage only; it does not
reserve credits or list individual charges.




## OpenAPI

````yaml /api-reference/openapi.yaml get /usage
openapi: 3.1.0
info:
  title: Avina API
  version: 1.0.0-draft
  description: >
    The Avina developer API, for calling Avina from your own servers.


    **Authentication.** Send your workspace API key: `Authorization: Bearer
    <key>`. Create keys in

    the Avina dashboard under Settings → API keys.


    **Credits.** `GET /usage` reports your workspace's signal credits for the
    current billing

    period: the same credits and period the dashboard shows.


    **Conventions.** JSON with snake_case fields and UTC ISO-8601 timestamps.
    Paginated lists use

    `limit` + `after` cursor pagination. `POST` requests accept an
    `Idempotency-Key` header

    (kept 24 hours). Every response has `X-Request-Id`. Request bodies must be
    JSON

    (`415 invalid_request` otherwise) and are limited to 100 KB (`413
    invalid_request`). A

    `503 internal_error` means the API key could not be checked; retry the
    request.
servers:
  - url: https://api.avina.io/v1
    description: Production (proposed domain)
security:
  - apiKey: []
tags:
  - name: Account
  - name: Personas
paths:
  /usage:
    get:
      tags:
        - Account
      summary: Get signal-credit usage for the current billing period
      description: >
        The workspace's existing signal credits, as the dashboard shows them:
        credits used so far

        in the current billing period and the plan's limit. It reports usage
        only; it does not

        reserve credits or list individual charges.
      operationId: getUsage
      responses:
        '200':
          description: Credits used and remaining.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Usage:
      type: object
      required:
        - object
        - period_start
        - period_end
        - credits_used
        - credits_limit
        - credits_remaining
      properties:
        object:
          type: string
          const: usage
        period_start:
          type:
            - string
            - 'null'
          format: date-time
          description: '`null` when no usage has been recorded for the current period yet.'
        period_end:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            `null` when the period has no end date, or no usage has been
            recorded yet.
        credits_used:
          type: number
          description: Can be fractional (a web visit uses half a credit).
        credits_limit:
          type:
            - integer
            - 'null'
          description: '`null` means no limit.'
        credits_remaining:
          type:
            - number
            - 'null'
      example:
        object: usage
        period_start: '2026-10-01T00:00:00Z'
        period_end: '2026-11-01T00:00:00Z'
        credits_used: 412
        credits_limit: 3500
        credits_remaining: 3088
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - invalid_api_key
                - not_found
                - idempotency_key_reused
                - rate_limited
                - internal_error
                - timeout
            message:
              type: string
            request_id:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  responses:
    Unauthorized:
      description: The API key is missing, invalid or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
              message: The API key is invalid or revoked.
              request_id: req_8f2a
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Workspace API key from the Avina dashboard (Settings → API keys).

````

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