Skip to main content
POST
Open an MPP pre-authorized session

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
id
string
required
agentId
string
required
principalId
string
required
spendCap
number
required
maxPerCall
number
required
currency
string
required
expiresAt
integer
required

Response

The opened MPP session.

The opened MPP session.

data
object
required

Serializable MPP (Machine Payments Protocol) pre-authorized session snapshot — a spend cap + REQUIRED expiry an agent opens ONCE, then streams metered micropayments against. Carries a SHA-256 consent digest re-verified before every metered call.

meta
object
required