Start
Founder login

Create a sandbox API key

Creates a sandbox API key limited to the actions available in this product. Use it for test traffic before going live. The secret appears once, in this response. The key lasts until you revoke it. A key made from a CLI login or agent token cannot run operations no agent may run, such as webhook.endpoint.create. The response lists those in browserKeyOnlyOperationIds.

post/v1/sandbox-api-keys

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/sandbox-api-keys
  • Auth: HTTP bearer

Headers

X-Hyperscale-Environment'sandbox' | 'live'
Idempotency-Keystring required

Request body

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

namestring required
capabilitiesstring[]

Narrow the key to this subset of the product's enabled capabilities; operations outside them are refused. Omit for the default: full access to everything enabled on the product.

replaceboolean

Revoke the active key with this name in the same call

Response

Success

tenantIdstring required

Organization tenant ID

productIdstring required

Hyperscale product ID

principalIdstring required

Hyperscale principal ID

apiKeyIdstring required

Hyperscale API key ID

replacedApiKeyIdstring

The same-named key this call revoked

secretstring

One-time API key secret surfaced only in the first response; store it now, receipts and replays omit it

status'active' required
scopesstring[] required
allowedOperationIdsstring[] required
browserKeyOnlyOperationIdsstring[]

Present when a CLI login or agent token made this key: the operations a key made in the browser would also run on this Product, such as webhook.endpoint.create. Make the key in the browser to reach them.

capabilityScopestring[] required

The capability families this key can reach; the allowed operations are derived from them

Changes

No recorded changes to this operation across all 1 revision of this API.