Skip to main content

Account Setup

To access the Engage Smarter API, you will need to provide two auth headers with every API call:

  1. An api_key associated with your User and
  2. An org_id associated with your Organisation.

Both of these can be configured and accessed in your Engage Smarter AI platform account settings, as described next.

Platform URL

Link to the Engage Smarter AI platform

Creating a User account and API key​

To use the platform API, you will need to submit an API key with every request. Every API key on the Engage Smarter platform is linked to one User account, so you will first need a User account.

This section guides you through setting up a User account and creating your first API key.

1. Creating a User account​

First, you need to create a User account on the Engage Smarter platform. There are two ways to do this:

  1. Invitation from an existing User. If you are going to be using the platform as part of an organisation already on the platform, it is best to ask an existing Admin member of your organisation to invite you to the platform. Once invited, you will receive an email with a link to create your User account. By following this approach, you ensure that you are part of the correct platform Organisation, if one already exists.

  2. Creating a new Organisation. If your organisation is not already the platform, you can create a new User account by heading to the platform login screen. After verifying your email address and logging back into the platform, you will receive instructions on how to create a new Organisation.

Organisation limits

While the Engage Smarter AI platform is in beta, we are restricting the creation of new Organisations. If you find that this is the case for you and you are unable to be invited to join an existing Organisation, please contact us at support@engagesmarter.ai to request an Organisation.

2. Generating an API key​

Once you have created your User account, you will need to generate a new API key to use the API. You can do this by heading to the API Keys page and clicking on the "Generate new API key" button. You will need to give your API key a name and then click "Create". You will then be presented with your API key. Note that you will only be able to see your API key one time, so make sure you copy it somewhere safe.

API keys

Every API key on the Engage Smarter AI Platform is associated with one User account. If you create an API key and share it with colleagues, their usage of the platform will be associated with your User account and not their own.

If you are concerned that your API key may have been compromised, you must delete it and create a new one in the same way on the API Keys page.

You are responsible for the security and management of your own API Keys. Engage Smarter have no way of accessing your API keys.

Finding your Organisation ID​

To use the platform API, you are required to include an org_id parameter with every request. You can find the org_id for your current Organisation by navigating to the Organisation Profile page within your Organisation Admin settings.

Switching your organisation​

You may be a member of multiple organisations on the Engage Smarter AI Platform. For example, your company may have a separate production and development organisation set up.

If you wish to use the API with a different Organisation than your current one, change your current Organisation by clicking on the Organisation dropdown menu at the top right of the platform and selecting the Organisation you wish to use. Then repeat the steps above to find the org_id for your new Organisation.