API Key Management
The API Keys page allows you to create, view, update, and manage your workspace keys. Each key controls access to the Arcee API and can be customized with limits, expiration rules, and data retention settings.
Viewing Your API Keys
The API Keys table displays all keys created within your workspace. For each key, you will see:
Name
Key (partially masked)
Token Limit
Request ($ Usage) Limit
Expiration Date
Data Retention Policy
Owner
Status (Active or Inactive)
You can search for a specific key using the search bar at the top right of the table.
Creating a New API Key
To create a new key:
Click Add New API Key in the top right corner.
Fill in the required API Key Name.
(Optional) Add a description to help you identify the use case.
Configure additional settings as needed:
Click Create API Key.
Key Settings
API Key Name
Required. A label to identify how or where the key will be used.
Description
Optional. Notes about the integration, environment, or workflow.
Expiration Date
When enabled, the key becomes invalid after the selected date.
Token Limit
Maximum total tokens the key can use. Useful for cost control.
Request Limit
Dollar usage cap for this key. Once the total spend for this key reaches this amount, requests are blocked. The value is entered in USD.
Data Retention Days
Specify how long user data and logs are stored. If not set, data is kept forever.
Once created, the key value is shown only once. Make sure to save it securely.
Editing an Existing API Key
Each key has an Edit icon located on the right side of the row.
Clicking this will open the Edit Key modal, where you can update all the fields that were available when you created your key.
Deleting or Deactivating Keys
Keys can be deactivated or deleted using the controls inside the Edit modal.
Deactivate: Immediately blocks use of the key but preserves history.
Delete: Permanently removes the key from the workspace.
Choose deactivation when you want to temporarily stop usage. Choose deletion for permanent removal or security cleanup.
Last updated