notabotDocs

Authentication

One header: x-api-key.

Header
x-api-key: nab_live_xxxxxxxxxxxxxxxxxxxxxxxx

Keys

  • Keys start with nab_live_. We store a hash, so the secret is shown once, at creation.
  • Make one key per project on the Keys page.
  • A revoked key stops working within seconds. Other keys are untouched.
  • Server side only. If one leaks, revoke it.

Spend limits per key

Cap what a key can spend, so a runaway loop cannot empty your balance:

Key spend limits
LimitResets
NoneNever limited, other than by your balance.
Daily00:00 UTC every day.
Monthly00:00 UTC on the 1st.
TotalNever; the key stops when it has spent that amount.

A key at its cap answers key_limit_reached (402), free.

Failed authentication

Missing, malformed or revoked key: invalid_key (401). Suspended account: account_banned (403).