Skip to main content

API Keys

Your API key authenticates your requests to the platform. Without a valid key, the platform rejects every request.

A key alone does not give you access to a model. An admin approves access to each model separately. You request access in the API Catalog.

Create a key​

  1. In the portal sidebar, open Developer, then API Keys.
  2. Click Generate API Key.
  3. Copy the key. The portal shows it only once.
caution

Treat your API key like a password. Do not commit it to version control or share it.

Use your key​

The model and Compute API endpoints read the key from the apikey header. Send it with every request:

apikey: <your-api-key>

Some clients put the key in an Authorization header by default, for example the OpenAI SDK. Set the apikey header explicitly for these clients. See Using the API.

Regenerate a key​

Click Regenerate to replace your key. The old key stops working shortly afterwards. Your access to models stays the same.

Revoke a key​

Click Revoke to delete your key. Requests with this key fail shortly afterwards.

warning

Revoking a key also removes your access to all models. After a revoke, you have to request access again in the API Catalog.

Usage​

The API Keys page shows how your key is used: the total number of requests, the requests of the last 24 hours, and the requests per minute right now.

What your key can reach​

Your key works with the Compute API, and with the models and services that you have access to. Requests to other models fail, even with a valid key. Some Compute API endpoints are limited during the pilot, see Limitations.