Skip to main content
POST
Create a remote API key

Authorizations

Authorization
string
header
required

Verified Batch Relay dashboard session token. This is distinct from a scoped Batch Relay API key.

Headers

Idempotency-Key
string
required
Required string length: 1 - 256
X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

account_id
string
required
Required string length: 1 - 256

Body

application/json
environment
enum<string>
required
Available options:
test,
live
name
string
required
Required string length: 1 - 120
scopes
string[]
required
Required array length: 1 - 8 elements
expires_at
integer<int64>

Response

API key and one-time secret

idempotent_replay
boolean
required
key
object
required