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

# Get Memory usage

> This month's Memory consumption for the project, with the plan quotas it is measured against. Read `capReached` to know whether writes are currently being refused.



## OpenAPI

````yaml /openapi.json get /v1/memory/usage
openapi: 3.0.3
info:
  title: Zavu Unified Messaging Layer API
  version: 0.2.0
  description: >
    Unified multi-channel messaging API for Zavu.


    Supported channels:

    - **SMS**: Simple text messages

    - **WhatsApp**: Rich messaging with media, buttons, lists, CTA URL buttons,
    location requests, and templates

    - **Telegram**: Bot messaging with text, media, and interactive elements

    - **Email**: Transactional emails via Amazon SES


    Design goals:

    - Simple `send()` entrypoint for developers

    - Project-level authentication via Bearer token

    - Support for all WhatsApp message types (text, image, video, audio,
    document, sticker, location, contact, buttons, list, cta_url,
    location_request, reaction, template)

    - If a non-text message type is sent, WhatsApp channel is used automatically

    - 24-hour WhatsApp conversation window enforcement

    - Universal `to` field accepts phone numbers (E.164), email addresses, or
    numeric chat IDs (Telegram/Instagram/Messenger)
servers:
  - url: https://api.zavu.dev
security:
  - bearerAuth: []
paths:
  /v1/memory/usage:
    get:
      tags:
        - Memory
      summary: Get Memory usage
      description: >-
        This month's Memory consumption for the project, with the plan quotas it
        is measured against. Read `capReached` to know whether writes are
        currently being refused.
      operationId: getMemoryUsage
      responses:
        '200':
          description: Usage.
          content:
            application/json:
              schema:
                type: object
                required:
                  - usage
                properties:
                  usage:
                    $ref: '#/components/schemas/MemoryUsage'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    MemoryUsage:
      type: object
      description: >-
        This month's Memory consumption for the project, with the quota it is
        measured against.
      required:
        - monthKey
        - tier
        - units
        - reads
        - writes
        - memAdds
        - memSearches
        - capReached
        - memoryBytes
      properties:
        monthKey:
          type: string
          description: The month these counters cover. They reset on the 1st.
          example: 2026-08
        tier:
          type: string
          description: Plan tier the quotas come from.
        units:
          type: integer
          description: >-
            Billable units consumed this month. Units are metered from real
            capacity, and a write costs 5x a read.
        reads:
          type: integer
        writes:
          type: integer
        memAdds:
          type: integer
          description: Facts stored this month.
        memSearches:
          type: integer
          description: Semantic searches run this month.
        capReached:
          type: boolean
          description: >-
            Whether the plan's unit quota is exhausted. While true, writes are
            refused with `429`; reads and deletes keep working, so stored data
            is never locked away.
        quotaUnits:
          type: integer
          nullable: true
          description: Units included in the plan. Null means unlimited.
        memoryBytes:
          type: integer
          description: >-
            Bytes currently stored across facts and collections. Items with a
            TTL count as zero.
        quotaStorageGB:
          type: number
          nullable: true
          description: Storage included in the plan, in GB. Null means unlimited.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: invalid_request
        message:
          type: string
          example: Phone number is invalid
        details:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````