AI API keys

An API key lets your own software call the AI API for your AI space: run your applications, read the runs and the usage. Runs made with a key use the tokens of your plan, like the ones you start in the workspace. Manage your keys from the API keys tab of Shop AI, under AI in the main menu.

Note — Only a workspace administrator can create, change or revoke a key. Other team members see the list.

Create a key

1. Open the main menu and, under AI, click Shop AI, then the API keys tab.
2. Click Create a key.
3. Enter a Name that tells you where the key is used, for example Production server.
4. In Access, choose Full access, or Restricted access to choose, for Applications, Runs, Usage and API keys, between No access, Read and Read and write.
5. In Expires, choose In 30 days, In 90 days, In 1 year or Never.
6. Click Create the key.

The message The key has been created. appears with Your new key.

Important — Copy the key now: it is shown in full only once and will not be shown again. Keep it secret: anyone holding it can run your AI applications on your tokens.

To make your first call with the key, see Your first AI API call.

Follow your keys

On the API keys tab, each key shows its Key (a short preview), its Status, its Access, when it Expires, when it was Last used and when it was Created.

Rename or suspend a key

1. On the API keys tab, click Edit in the row of the key.
2. Change the Name, or choose Suspended (or Active) in Status.
3. Click Save.

The message The key has been saved. appears. A suspended key is refused by the API until you reactivate it.

Revoke a key

Revoking a key is final: the key stops working at once and cannot be restored.

1. Open the key with Edit.
2. Under Revoke the key, tick I understand that this key stops working at once.
3. Click Revoke the key.

The message The key has been revoked. It no longer works. appears. Give the software that used it a new key.