Skip to content

Get Memory usage

View .md
GET

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.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Responses

200Usage.
  • usageobjectrequired

    This month's Memory consumption for the project, with the quota it is measured against.

    11 properties
    • monthKeystringrequired

      The month these counters cover. They reset on the 1st.

    • tierstringrequired

      Plan tier the quotas come from.

    • unitsintegerrequired

      Billable units consumed this month. Units are metered from real capacity, and a write costs 5x a read.

    • readsintegerrequired
    • writesintegerrequired
    • memAddsintegerrequired

      Facts stored this month.

    • memSearchesintegerrequired

      Semantic searches run this month.

    • capReachedbooleanrequired

      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.

    • quotaUnitsintegernullable

      Units included in the plan. Null means unlimited.

    • memoryBytesintegerrequired

      Bytes currently stored across facts and collections. Items with a TTL count as zero.

    • quotaStorageGBnumbernullable

      Storage included in the plan, in GB. Null means unlimited.

401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject