Get your API Key

Learn how to create and manage your Anam API key from the Lab. Required to authenticate requests and integrate personas into your app.

Your API key is used to authenticate your requests to the Anam API and is required for integrating the Personas you create into your own applications. API keys are managed via the Anam Lab.

​

Create a new API key

From the API keys page, click on the “New Key” button (on a phone, the ”+” button). This opens the “Create API key” dialog.

Enter an optional label, then choose what the key can access:

• Full access: the key can read and write everything, and create session tokens.
• Restricted: choose None, Read, or Write for each resource, and whether the key can create session tokens. Write includes read. Restricted starts with every permission turned on, so turn off what the key does not need.

The label is only used to help you identify the API key. It is not used for authentication.

Click “Create key” and your new API key will be shown to you in the “Save your new API key” dialog. Remember to save it somewhere safe as you will not be able to access it later. Click “Copy key” to copy it, or “Copy as ANAM_API_KEY” to copy it as an environment variable line. The “I’ve saved it” button stays disabled until you click one of them. If your browser blocks clipboard access, select the key and copy it yourself.

Anam encrypts and store your API keys securely. For this reason, we are unable to recover lost API keys. If you lose your API key, you will need to create a new key via the Anam Lab.