Skip to main content

Base URLs

Create credentials for the intended environment in Console. Production access depends on workspace approval and permissions. A sandbox key does not become a production key by changing the URL.

Try it in the API playground

Select the server offered by the endpoint, then supply the credential type shown for that operation. Public health endpoints require no API key. Some user-management operations require a bearer token with the appropriate role, rather than a service API key. Requests sent from the playground are real requests. Write operations can create records, consume quota, or trigger notifications even when used for testing. Use your sandbox workspace and avoid real recipient addresses in test requests.

Workspace and session selection

The service derives the workspace and environment from authenticated credentials. Do not add X-Tenant-ID or an environment header to override them. The Console environment switcher updates the signed-in session. It does not change existing API keys used by a separate backend application. Use a key issued for the target environment in that application. Environment administration and session activation are distinct operations. Activating a session requires user authentication; sending an API key to a session-activation endpoint does not switch subsequent API-key requests.

Limits and retention

Check the workspace’s current billing and environment settings for quotas, retention, and available features. This page does not promise a fixed sandbox allowance, weekly log resets, permanent production retention, or a contractual uptime guarantee. Before going live, verify the target host, key environment, issuer, signing key, permissions, and successful read/write behavior using your own approved workspace.