Skip to main content
An API key lets software your company builds use the prompts you release in Nucleus. You give each key a name, and you can limit how often it is used, when it stops working and which products’ prompts it can reach. How your software uses the key is for your developers; this page covers creating the key in Nucleus.

​
Before you start

Tenant Owners and Workspace Admins can open API Keys and create keys.

​
Create a key

The New API Key window, with Name, Expires (optional), Hourly request limit, Allowed products, Create key and Cancel.
1

Start a key

Select API Keys, then New key.
2

Name it

Enter a Name that says what the key is for, such as the system that will use it.
3

Set an end date if you want one

Under Expires (optional), choose the last day the key should work. Leave it empty for a key that does not expire.
4

Set a limit

Change the Hourly request limit if the key needs more or fewer requests an hour than the one filled in.
5

Choose the products

Under Allowed products, tick the products whose prompts the key can reach. Leave them all unticked to allow every product.
6

Create it

Select Create key.
Nucleus shows the full key once, straight after you create it. Copy it and give it to your developers then, because you cannot see it again. The key now appears in the list on API Keys. Next, set up your products and types.

​
Troubleshooting

Only Tenant Owners and Workspace Admins can open API Keys. Ask one of them to create the key.
Enter a number between 1 and 10000.