Skip to main content

How do I create an API key?

Generate a key, copy it, and save it somewhere safe.

Create a key

  1. Open your workspace settings.

  2. Go to API Keys.

  3. Choose New API key.

  4. Give the key a descriptive name (something like "CRM sync — production"). This is how you'll recognize it later.

  5. Generate the key.

The key value is shown to you once, right after it's generated. Copy it now and store it in a safe place — a password manager, a secrets vault, or your tool's environment variables. After you close the screen, the full key isn't shown again.

If you lose a key, you can't recover it. Generate a new one and update wherever you were using the old one.

Use the key

Include the key as a bearer token in the HTTP requests your script or integration makes to the Ambit API. The exact header format and endpoint paths are in our API reference.

Naming keys well

A short, descriptive name on each key saves a lot of time. Six months from now, "CRM sync — production" is recognizable; "Key 3" is not.

If you have multiple integrations, create one key per integration. That way if you ever need to disable one (a third-party tool got compromised, a script got accidentally exposed), you can revoke that one key without breaking everything else.

Where to go next

  • What can I build with an Ambit API key?

  • How do I revoke an API key?

Did this answer your question?