Skip to main content

API & SDK

Open Integrations & APIs → API & SDK after selecting a workspace. Production currently provides two subtabs: API keys and REST reference.

API keys​

  1. Select Create key.
  2. Enter a name and choose at least one scope available to your workspace role.
  3. Create the key and copy the plaintext immediately.
  4. Confirm that you saved it before closing; the complete key is shown only once.

Available scope names are read, write, analytics, webhooks, and admin. Role rules determine which scopes you may grant. The key list later shows only a masked value, scopes, request count, last use, creation date, and creator. Revoke a key from its row menu; revocation cannot reveal its old plaintext.

The usage cards show requests this month and any plan allowance. The production UI defaults to 50 requests/second with a 100-request burst, but deployment environment values may override those numbers; use the values displayed in your workspace as authoritative.

REST reference​

Select REST reference to load the server-provided endpoint catalog. Choose a group and endpoint to see its HTTP method, path, summary, authentication type, required API-key scope when applicable, sample cURL, and sample success response. Copy examples from this panel instead of relying on a static endpoint list: the catalog is served by /v1/api-reference and can evolve with production.

Never put API keys in browser code, public repositories, or client-visible page-builder fields.

Frequently asked questions​

Can I recover a lost API key?

No. Revoke the old key, create a replacement with the minimum scopes, and update the integration.

What is the rate limit?

Read the rate-limit card in API keys. The UI defaults to 50 requests/second and a burst of 100, but deployment configuration can override it.

Where is the endpoint list?

Use API & SDK → REST reference. It loads the current server catalog and shows auth, scope, cURL, and response examples.