Get Usage

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/admin/v1/usage' \
  -H 'Authorization: Bearer sk_xxxxxx'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "by_model": [
      {
        "completion_tokens": 1200000,
        "model": "example",
        "prompt_tokens": 1200000,
        "requests": 1,
        "used_tokens": 1200000
      }
    ],
    "period": {
      "end_date": "example",
      "start_date": "example",
      "timezone": "example"
    },
    "quota": {
      "available_tokens": 1200000,
      "unlimited": false
    },
    "scope": "team",
    "totals": {
      "completion_tokens": 1200000,
      "prompt_tokens": 1200000,
      "requests": 1,
      "used_tokens": 1200000
    },
    "buckets": [
      {
        "completion_tokens": 1200000,
        "date": "example",
        "end_time": 1760000000,
        "prompt_tokens": 1200000,
        "requests": 1,
        "start_time": 1760000000,
        "used_tokens": 1200000,
        "by_member": [
          {
            "completion_tokens": 1200000,
            "display_name": "Alice",
            "principal_id": "7eccf77fb75500eaacca3ce819c381f0",
            "prompt_tokens": 1200000,
            "requests": 1,
            "used_tokens": 1200000
          }
        ],
        "by_model": [
          {
            "completion_tokens": 1200000,
            "model": "example",
            "prompt_tokens": 1200000,
            "requests": 1,
            "used_tokens": 1200000
          }
        ]
      }
    ],
    "by_member": [
      {
        "completion_tokens": 1200000,
        "display_name": "Alice",
        "principal_id": "7eccf77fb75500eaacca3ce819c381f0",
        "prompt_tokens": 1200000,
        "requests": 1,
        "used_tokens": 1200000
      }
    ]
  }
}

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/admin/v1/usage' \
  -H 'Authorization: Bearer sk_xxxxxx'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "by_model": [
      {
        "completion_tokens": 1200000,
        "model": "example",
        "prompt_tokens": 1200000,
        "requests": 1,
        "used_tokens": 1200000
      }
    ],
    "period": {
      "end_date": "example",
      "start_date": "example",
      "timezone": "example"
    },
    "quota": {
      "available_tokens": 1200000,
      "unlimited": false
    },
    "scope": "team",
    "totals": {
      "completion_tokens": 1200000,
      "prompt_tokens": 1200000,
      "requests": 1,
      "used_tokens": 1200000
    },
    "buckets": [
      {
        "completion_tokens": 1200000,
        "date": "example",
        "end_time": 1760000000,
        "prompt_tokens": 1200000,
        "requests": 1,
        "start_time": 1760000000,
        "used_tokens": 1200000,
        "by_member": [
          {
            "completion_tokens": 1200000,
            "display_name": "Alice",
            "principal_id": "7eccf77fb75500eaacca3ce819c381f0",
            "prompt_tokens": 1200000,
            "requests": 1,
            "used_tokens": 1200000
          }
        ],
        "by_model": [
          {
            "completion_tokens": 1200000,
            "model": "example",
            "prompt_tokens": 1200000,
            "requests": 1,
            "used_tokens": 1200000
          }
        ]
      }
    ],
    "by_member": [
      {
        "completion_tokens": 1200000,
        "display_name": "Alice",
        "principal_id": "7eccf77fb75500eaacca3ce819c381f0",
        "prompt_tokens": 1200000,
        "requests": 1,
        "used_tokens": 1200000
      }
    ]
  }
}

GET /openapi/memorylake/admin/v1/usage

Returns the current quota snapshot plus consumption over the requested period (at most 92 days). With usage:view_all the figures cover the whole team; a caller holding only usage:view_self receives their own usage (including their API keys), and scope says which. bucket_width=1d adds a per-day series; group_by=member adds a per-member breakdown and requires usage:view_all.

Permission required: usage:view_all (whole team) or usage:view_self (your own only)

When you pass group_by=member: usage:view_all

Query Parameters

string

First day to include, YYYY-MM-DD, in the timezone stated by period.timezone. Defaults to six days before end_date.

string

Last day to include, YYYY-MM-DD, in the timezone stated by period.timezone. Defaults to today.

string

Set to 1d to also receive buckets: a per-day time series over the period.

array

Repeatable. by_model is always returned for the period; member adds by_member (requires usage:view_all). With bucket_width=1d, each bucket also carries the breakdowns listed here.

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/admin/v1/usage' \
  -H 'Authorization: Bearer sk_xxxxxx'

Response

object

Show Usage object

array

Per-model breakdown over the period

Show Usage By Model object

integer

Completion tokens produced

string

Model name, or the name of a platform metering operation (files_process, memory_input, retrieval_call, search_call)

integer

Prompt tokens consumed

integer

Number of requests

integer

Consumption charged against the balance, in tokens

object

The period these totals cover

Show Usage Period object

string

Last day included, YYYY-MM-DD

string

First day included, YYYY-MM-DD

string

IANA timezone the days are cut in (Asia/Shanghai)

object

Account-level quota snapshot — NOT scoped to the period

Show Usage Quota object

integer

Currently available tokens (one-time credit plus unexpired subscription). Account-level snapshot, NOT scoped to the period.

boolean

When true, available_tokens is not meaningful

string

Whose consumption the figures cover: team (caller holds usage:view_all) or self (only usage:view_self — the caller’s own usage, including their API keys; API key usage before 2026-05-21 was recorded under the key itself and is not part of the self figures)

object

Aggregate consumption over the period

Show Usage Totals object

integer

Completion tokens produced

integer

Prompt tokens consumed

integer

Number of requests

integer

Consumption charged against the balance, in tokens — the same unit as quota.available_tokens. Covers platform operations too, which carry no prompt/completion tokens.

array

Present only with bucket_width=1d: one entry per day of the period, oldest first, days without usage included as zeros. Each bucket carries the breakdowns named in group_by.

Show Usage Bucket object

integer

Completion tokens produced

string

The day, YYYY-MM-DD, in period.timezone

integer

Bucket end, Unix seconds (exclusive)

integer

Prompt tokens consumed

integer

Number of requests

integer

Bucket start, Unix seconds (inclusive)

integer

Consumption charged against the balance, in tokens

array

Present when group_by includes member: this day’s per-member breakdown

Show Usage By Member object

integer

Completion tokens produced

string

The member’s display name. When none is set, owners and admins get the member’s username instead; anyone else gets an empty string

string

Identifier of the member (principal_id). For usage before 2026-05-21, API key usage was recorded under the key’s own identity and appears as a separate entry

integer

Prompt tokens consumed

integer

Number of requests

integer

Consumption charged against the balance, in tokens

array

Present when group_by includes model: this day’s per-model breakdown

Show Usage By Model object

integer

Completion tokens produced

string

Model name, or the name of a platform metering operation (files_process, memory_input, retrieval_call, search_call)

integer

Prompt tokens consumed

integer

Number of requests

integer

Consumption charged against the balance, in tokens

array

Present only with group_by=member (an empty array when nobody consumed anything): per-member breakdown, largest consumer first. Includes people who have since left the team, so requests and token counts add up to totals; used_tokens is rounded down per entry, so its sum can fall short of totals.used_tokens by under one token per entry

Show Usage By Member object

integer

Completion tokens produced

string

The member’s display name. When none is set, owners and admins get the member’s username instead; anyone else gets an empty string

string

Identifier of the member (principal_id). For usage before 2026-05-21, API key usage was recorded under the key’s own identity and appears as a separate entry

integer

Prompt tokens consumed

integer

Number of requests

integer

Consumption charged against the balance, in tokens

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "by_model": [
      {
        "completion_tokens": 1200000,
        "model": "example",
        "prompt_tokens": 1200000,
        "requests": 1,
        "used_tokens": 1200000
      }
    ],
    "period": {
      "end_date": "example",
      "start_date": "example",
      "timezone": "example"
    },
    "quota": {
      "available_tokens": 1200000,
      "unlimited": false
    },
    "scope": "team",
    "totals": {
      "completion_tokens": 1200000,
      "prompt_tokens": 1200000,
      "requests": 1,
      "used_tokens": 1200000
    },
    "buckets": [
      {
        "completion_tokens": 1200000,
        "date": "example",
        "end_time": 1760000000,
        "prompt_tokens": 1200000,
        "requests": 1,
        "start_time": 1760000000,
        "used_tokens": 1200000,
        "by_member": [
          {
            "completion_tokens": 1200000,
            "display_name": "Alice",
            "principal_id": "7eccf77fb75500eaacca3ce819c381f0",
            "prompt_tokens": 1200000,
            "requests": 1,
            "used_tokens": 1200000
          }
        ],
        "by_model": [
          {
            "completion_tokens": 1200000,
            "model": "example",
            "prompt_tokens": 1200000,
            "requests": 1,
            "used_tokens": 1200000
          }
        ]
      }
    ],
    "by_member": [
      {
        "completion_tokens": 1200000,
        "display_name": "Alice",
        "principal_id": "7eccf77fb75500eaacca3ce819c381f0",
        "prompt_tokens": 1200000,
        "requests": 1,
        "used_tokens": 1200000
      }
    ]
  }
}

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.

Status	Meaning
`400`	A parameter or the body is invalid
`401`	The API key is missing, invalid, disabled or expired
`403`	The key is not allowed to do this
`422`	The body or a parameter failed validation
`429`	Too many requests. Wait for the time in `Retry-After`
`500`	Server-side error

MemoryLake API

Memory Router API

Query Parameters

Response

Errors

​Query Parameters

​Response

​Errors

Query Parameters

Response

Errors