Create an API key
Creates a lum_ key in your workspace. The key works on the Activity API, the Assets API and RPC of its network. The plaintext api_key is returned once: store it in a secret manager. allowed_origins is required for, and the policy fields are accepted only with, access publishable. Served by the Activity host for all products. Read-only and publishable keys get 403.
Authorizations
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
Label shown in the dashboard. Empty or omitted becomes "default".
100Network the key works on. Defaults to the network of the host you call.
mainnet, testnet 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.
full, read, publishable Optional. Must be in the future and at most 5 years away. The key stops working at this time.
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.
1 - 20 elementsExact origin, scheme://host[:port], normalized to lowercase without a default port.
Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.
1 <= x <= 600Publishable 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.
1 <= x <= 1000000000000Response
The new key. api_key is shown only in this response.
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.
mainnet, testnet Set when the key was created with an expiry.
full, read for data-only keys, or publishable for browser keys.
full, read, publishable 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.
1 - 20 elementsExact origin, scheme://host[:port], normalized to lowercase without a default port.
Publishable keys only: requests per minute per end-user IP (default 60). The organization plan limit still applies.
1 <= x <= 600Publishable 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.
1 <= x <= 1000000000000