Set Low-Balance Alert

curl -X PUT 'https://app.memorylake.ai/openapi/memorylake/admin/v1/billing/credit-balance/alert' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "thresholds": [
      {
        "type": "percent_used",
        "value": 1
      }
    ],
    "notification_channel": {
      "recipients": [
        "example"
      ],
      "type": "email"
    }
  }'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "delivery_enabled": true,
    "enabled": true,
    "is_default": true,
    "notification_channel": {
      "recipients": [
        "example"
      ],
      "type": "email"
    },
    "status": {
      "state": "ok",
      "balance_tokens": 1200000,
      "threshold": {
        "type": "percent_used",
        "value": 1
      },
      "triggered_at": 1760000000
    },
    "thresholds": [
      {
        "type": "percent_used",
        "value": 1
      }
    ]
  }
}

curl -X PUT 'https://app.memorylake.ai/openapi/memorylake/admin/v1/billing/credit-balance/alert' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "thresholds": [
      {
        "type": "percent_used",
        "value": 1
      }
    ],
    "notification_channel": {
      "recipients": [
        "example"
      ],
      "type": "email"
    }
  }'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "delivery_enabled": true,
    "enabled": true,
    "is_default": true,
    "notification_channel": {
      "recipients": [
        "example"
      ],
      "type": "email"
    },
    "status": {
      "state": "ok",
      "balance_tokens": 1200000,
      "threshold": {
        "type": "percent_used",
        "value": 1
      },
      "triggered_at": 1760000000
    },
    "thresholds": [
      {
        "type": "percent_used",
        "value": 1
      }
    ]
  }
}

PUT /openapi/memorylake/admin/v1/billing/credit-balance/alert

Replaces the low-balance alert configuration. Thresholds are all percent_used or all tokens_remaining (at most 5); absolute levels are in tokens. Recipients are added to the team owner, who is always notified. To stop alerts, set enabled to false.

Permission required: credits:manage

Request Body

boolean

required

Whether alerts are sent

array

required

Alert levels, all of one type; duplicates are dropped

Show Balance Alert Threshold object

string

required

Threshold type; every threshold in one request must share it. One of: percent_used, tokens_remaining.

integer

required

1–99 for percent_used; 1–1,000,000,000 for tokens_remaining

object

Omit to send to the team owner only

Show Alert Recipients Channel object

array

required

Additional addresses (the team owner always receives alerts); duplicates are dropped case-insensitively

string

required

Delivery channel. One of: email.

curl -X PUT 'https://app.memorylake.ai/openapi/memorylake/admin/v1/billing/credit-balance/alert' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "thresholds": [
      {
        "type": "percent_used",
        "value": 1
      }
    ],
    "notification_channel": {
      "recipients": [
        "example"
      ],
      "type": "email"
    }
  }'

Response

object

Show Balance Alert object

boolean

false = this deployment does not evaluate low-balance alerts at all; the setting is kept but has no effect

boolean

Whether alerts are sent

boolean

true = nothing has been saved; the defaults shown apply (percent_used 80 / 95 with a subscription, otherwise tokens_remaining 1,600,000 / 320,000)

object

Where alerts go

Show Alert Recipients Channel object

array

Additional addresses, at most 5. The team owner’s email always receives alerts as well

string

Delivery channel. One of: email.

object

Current alert state

Show Balance Alert Status object

string

triggered = an alert has fired and the balance has not recovered above its level yet. One of: ok, triggered.

integer

The balance when it fired, in tokens

object

The level that fired

Show Balance Alert Threshold object

string

percent_used = alert when the share of the subscription cycle (or, without a subscription, of all credit ever added) used reaches value percent; tokens_remaining = alert when the balance falls to value tokens

integer

1–99 for percent_used; 1–1,000,000,000 for tokens_remaining

integer

When the active alert fired, Unix seconds

array

Alert levels; all of one type

Show Balance Alert Threshold object

string

integer

1–99 for percent_used; 1–1,000,000,000 for tokens_remaining

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "delivery_enabled": true,
    "enabled": true,
    "is_default": true,
    "notification_channel": {
      "recipients": [
        "example"
      ],
      "type": "email"
    },
    "status": {
      "state": "ok",
      "balance_tokens": 1200000,
      "threshold": {
        "type": "percent_used",
        "value": 1
      },
      "triggered_at": 1760000000
    },
    "thresholds": [
      {
        "type": "percent_used",
        "value": 1
      }
    ]
  }
}

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

Request Body

Response

Errors

​Request Body

​Response

​Errors

Request Body

Response

Errors