Skip to main content
POST
kv.counter.add

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
namespace
string
required

Your logical namespace, 1 to 128 UTF-8 bytes.

Minimum string length: 1
key
string
required

Your key, used exactly as given in a connected database.

Minimum string length: 1
delta
string
required

Amount to add as an exact decimal string.

Maximum string length: 100
Pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?$
numericType
enum<string>
default:integer

Integer preserves signed 64-bit precision; decimal uses finite decimal arithmetic.

Available options:
integer,
decimal
ttlMs
integer

Expiry in milliseconds, 1 to 30 days.

Required range: 1 <= x <= 2592000000

Response

The result

value
string
required

New counter value as a decimal string, without loss of integer precision.