Skip to main content
Every request to /v1 requires an API key. Our team issues keys directly; there is no self-serve signup.

Request a key

To request a key, contact us at {{KEY_REQUEST_URL}} with the following details:
  • Your company and a contact email
  • What you are building
Every new organization starts on the free plan, which includes 100,000 credits per month at no cost.

Key format

A key consists of meta_ followed by 43 characters. The first 12 characters, such as meta_9tK2vQx, form the key’s prefix, which identifies the key without revealing it. When you contact support, include the prefix, never the full key. Keys have no environment prefix. All keys have the same format, but a key works only in the environment that issued it.

Organizations and key lifetime

Every key belongs to an organization, and an organization can have up to 10 active keys. All keys of one organization share its request budget, its credits and its plan. Each key has its own stream limits. A key does not expire. It stays valid until it is revoked.

Key security

  • Store the key in a secret manager or an environment variable on your server.
  • Never put the key in browser code, a mobile app, a public repository or a URL. See Choosing a credential for the reasons. In a browser, use a session token.
  • Use a separate key for each environment, so you can revoke one without affecting the others.

Rotate a key

  1. Request a new key.
  2. Deploy the new key everywhere the old one is in use.
  3. Restart your stream connections so that none still use the old key.
  4. Ask us to revoke the old key.
Both keys remain valid until the old one is revoked, so rotation requires no downtime.

Revoke a leaked key

If a key leaks, contact us at {{KEY_REQUEST_URL}} with its prefix. Within about 30 seconds of revocation, requests and new stream connections that use the key return 401 UNAUTHORIZED, as with any unknown key, and open stream connections that use the key close with code 1008. Revoking a key also invalidates every session token created with it. See Close codes.