Project API keys

An API key lets you connect an external service to this project, so it can run your applications programmatically instead of through the site. From the API keys page you create a key, see the keys you already have, and open one to rename it, disable it or delete it. A reasoning started with a key shows API as its origin in your history.

Before you start — Creating an API key requires being an administrator of the project. The full key is shown only once, right after creation — copy it before you leave the page.

Create an API key

1. Open the project's API keys page. If you have none yet you'll see No API key has been created on this project. with a Create an API key button.
2. Click Create an API key.
3. Enter a Name that tells you what the key is for, then continue.
4. The new key is shown in full once, with the reminder Important: copy this key now, it will not be shown again. Copy it and store it somewhere safe.

The key starts with sk-project-. After this, only a short preview (sk-project-... plus the last characters) is ever shown.

Important — If you don't copy the key before leaving the page you can't see it again. Delete the key and create a new one if you lose it.

See your API keys

1. Open the API keys page.
2. The list shows each key by its API key (name and preview), its Status, who it was Created by, and when it was Created on.
3. Click Detail on a key to open it.

Rename or disable a key

1. Open the API keys page, then click Detail on the key.
2. On API key details, change the Name, or set the Status to Active or Disabled.
3. Click Save.

You'll see The API key has been updated.

Important — Disabling a key immediately blocks every call that uses it. Set it back to Active to allow calls again.

Delete a key

1. Open the key's detail page.
2. Under the delete section, click Delete.

The key is removed and can no longer be used. Any service still using it will stop working, so update those services first.