Skip to main content

​
Accessing Your Profile

To access your profile, open the user menu found at the top-right corner of the Archetype AI Developer Console, and choose the Profile & API Keys option. User menu with Profile & API Keys option highlighted This opens your Profile page. The Profile page has two sections: Details, which lists details about your user account, and API Keys, where you can view, filter, manage, and search your existing API keys, as well as create new ones. The main user profile page

​
Managing API Keys

​
Creating an API Key

Everything you build on the Archetype Platform authenticates using an API key, and the Developer Console is where you create them. To do so, start by signing in to the Developer Console, then open the Profile & API Keys page using the user menu at the top-right corner of the window.
Don’t have Developer Console access yet? Request a free trial to get started.
  1. Click the + Create Key button at the top-right corner of the API Keys section of the page. This opens the Create API Key panel: Create an API key
  2. Enter a name for your new API key and click the Create Key button to create the new API key. A new modal will appear showing you information about the new API key: Your API Key modal
  3. Copy the secret key, which starts with sk_. This is the value your code sends as ATAI_API_KEY. Treat the secret key like a password: store it in an environment variable or a .env file, never in source control. See Environment Variables for setup details, then head to the Developer Quickstart to run your first queries using your new API key.

​
Revoking an API Key

If you are no longer using a particular API key, you should revoke it so that it can no longer be used to access your account and its data. To revoke an API key, mouse over the API key you want to revoke. This causes a revoke button () to appear at the right-hand side of the API key’s row in the list. Click the revoke button to open the Revoke API Key panel: The Revoke API Key modal Review the displayed information about the API key. If you’re certain you want to revoke the API key, click the Revoke Key button.
Once you revoke an API key, all applications and services configured using that key immediately lose access to all Archetype AI APIs.

​
Filtering API Keys By Status

To filter the list of your API keys to show only those whose status (Active, Revoked, Expired, etc.) matches a given value, use the popup located immediately below the API Keys heading: Filtering to show only Revoked API Keys In this example, the Revoked filter is highlighted. This will restrict the API key list to show only those keys which have been revoked.