Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <key>. Testnet: lum_test_…; Mainnet: lum_live_…. A key works only on its own network, so pick the server that matches it (the other network answers 401). Publishable lum_pub_… keys call the GET data routes only, from an allowed browser origin. Webhook keys (whk_…) are not accepted here.

Body

application/json
name
string

Label shown in the dashboard. Empty or omitted becomes "default".

Maximum string length: 100
network
enum<string>

Network the key works on. Defaults to the network of the host you call.

Available options:
mainnet,
testnet
access
enum<string>

full (default), read or publishable. Read keys call product data routes and non-submitting RPC methods only; workspace, key and billing routes and sendTransaction return 403. Publishable keys (lum_pub_…) are browser keys: they read Activity and Assets GET data routes and call read-only RPC methods (not sendTransaction or simulateTransaction) only from an allowed Origin; see browser keys.

Available options:
full,
read,
publishable
expires_at
string<date-time>

Optional. Must be in the future and at most 5 years away. The key stops working at this time.

allowed_origins
string[]

Publishable keys only: a request must send an Origin header equal to one of these. HTTPS is required except http://localhost and http://127.0.0.1; no wildcards; at most 150 characters each.

Required array length: 1 - 20 elements

Exact origin, scheme://host[:port], normalized to lowercase without a default port.

rate_limit_per_minute_per_ip
integer

Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.

Required range: 1 <= x <= 600
monthly_credit_cap
integer

Publishable keys only: settled credits this key may use per billing period. At the cap the key gets 429 until the next period; other keys continue. Omitted when there is no cap.

Required range: 1 <= x <= 1000000000000

Response

The new key. api_key is shown only in this response.

id
string<uuid>
required
name
string
required
api_key
string
required

Plaintext returned once. Never log or share a full or read key; a publishable key (lum_pub_…) is meant to be embedded in web pages.

key_prefix
string
required
network
enum<string>
required
Available options:
mainnet,
testnet
base_url
string
required
created_at
string<date-time>
required
expires_at
string<date-time> | null
required

Set when the key was created with an expiry.

access
enum<string>

full, read for data-only keys, or publishable for browser keys.

Available options:
full,
read,
publishable
allowed_origins
string[]

Publishable keys only: a request must send an Origin header equal to one of these. HTTPS is required except http://localhost and http://127.0.0.1; no wildcards; at most 150 characters each.

Required array length: 1 - 20 elements

Exact origin, scheme://host[:port], normalized to lowercase without a default port.

rate_limit_per_minute_per_ip
integer

Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.

Required range: 1 <= x <= 600
monthly_credit_cap
integer

Publishable keys only: settled credits this key may use per billing period. At the cap the key gets 429 until the next period; other keys continue. Omitted when there is no cap.

Required range: 1 <= x <= 1000000000000