Authorize API integrations

Ada APIs use API keys for authorization. You can use an existing API key that someone in your organization generated for your AI Agent, if it was either generated for a specific API, or if it's a newer, general key that works for all of Ada's APIs:

  • If a key was generated for a specific API, that key will still only work for that API. The names for API-specific keys indicate which APIs they're associated with, followed by "(Legacy)".

  • If a key was generated for all of Ada's APIs, you can use that key again, or you can create a new one by following the steps below. Your AI Agent can have multiple active general API keys; creating a new one doesn't invalidate any existing keys.

Regardless of which type of key you have, they don't expire, and provide read and write access to all Ada APIs available to your organization.

Generate an Ada API key

You can generate a new Ada API key from the Ada dashboard, which works for all APIs your organization has access to.

  1. On the Ada dashboard, go to your API settings.

    • If you're using a generative AI Agent, go to Platform > APIs.

    • If you're using a scripted bot, go to Settings > Integrations > APIs.

    The API keys page opens.

  2. Create a new API key:

    • If your AI Agent doesn't have any API keys, click Get started.
    • If your AI Agent has existing API keys, click New API key.

    The New API key window opens.

  3. In the New API key window, enter a Name for the key, then click Generate key.

    You won't be able to change the key's name in the future.

  4. Click Copy to copy your API key, then save it in a secure place immediately.


    For security reasons, the Ada dashboard only displays your API key once. If you lose this key, you'll need to create a new one.

  5. Click Done to close the New API Key window and protect your new API key.

Delete an Ada API key

If you ever need to invalidate an old API key, click the Delete button beside it.

Authenticate your requests

To authenticate your requests, you have to send your API key in the Authorization header in all requests to the API. Without it, your requests will fail.

Example of a request

curl --location {BOT_URL}/api/knowledge/v1/articles' \
--header 'Authorization: Bearer {YOUR_API_TOKEN}’

Example responses

// If the request is not authenticated
status: 401
	"message": "Unauthorized"

// If the request is authenticated
status: 200
	"data": []