How to Request and manage API Key's

Managing agentOS API Keys

Overview

agentOS API keys provide secure access to your system's API endpoints. This guide covers how to create, modify, and manage API keys for both third-party integrations and internal projects.

Prerequisites

• Required Permission: Owner-level staff permissions in agentOS
• Access Location: Settings > API Keys
• If you don't have Owner permissions, contact an administrator within your organization to request API key creation

Creating API Keys

Step 1: Access the API Key Creation Interface

1. Navigate to Settings > API Keys
2. Click the Create API key button

Step 2: Choose Your Key Type

There are two options for creating an API key:

Option A: Integration Key

Use this for prebuilt connections with third-party systems.

Steps:

1. Select "Integration" from the key type options
2. Choose your desired integration from the dropdown menu
3. The system will automatically configure appropriate permissions for the selected integration
4. Click "Create"

Option B: Internal Key

Use this for custom websites, automation tools, or internal applications.

Steps:

1. Select "Internal" (this is the default selection)
2. Review and select the required API permissions by checking the appropriate boxes
3. Consider the principle of least privilege - only grant permissions that are necessary
4. Click "Create"

Step 3: Save Your API Key

After creating the key, a popup will display your new API key details.

The API keys table will automatically update to show your new key's details. This table is ordered newest to oldest key.

Managing Existing API Keys

Modifying API Keys

Note: Only internal keys can be modified. Integration keys have fixed permissions.

To modify an internal key:

1. Locate the key in your API keys table
2. Click the actions menu (three dots) for the desired key
3. Select "Modify"
4. Update the permission checkboxes as needed
5. Click "Save" to apply changes

Revoking API Keys

When an API key is no longer needed, it should be revoked for security purposes.

To revoke a key:

1. Click the actions menu for the key you want to revoke
2. Select "Revoke"
3. Confirm the revocation in the popup dialog
4. The key will appear in red in the table, indicating it's revoked

Note: Revoked keys are retained temporarily in case of accidental revocation. They are automatically purged from the system after an extended period.

Reinstating Revoked Keys

If you've accidentally revoked a key or need to restore access, you can reinstate it.

To reinstate a key:

1. Locate the revoked key (shown in red) in your table
2. Click the actions menu
3. Select "Reinstate"
4. Confirm the reinstatement
5. The key will return to active status with its previous permissions restored

Best Practices

1. Security First
   • Never share API keys in unsecured channels
   • Revoke unused keys promptly
2. Permission Management
   • Grant only necessary permissions
   • Review permissions periodically
   • Use integration keys when possible, for third-party services
3. Key Organization
   • Document which systems use which keys
   • Maintain an inventory of active keys

Troubleshooting

Cannot see API Keys menu option

• Verify you have Owner permissions
• Contact your system administrator

Integration not appearing in dropdown

• Confirm with [e-mail] whether the desired integration is currently integrates with agentOS.

Key creation fails

• Verify all required fields are completed
• The table can sometimes take a minute to update with API keys during heavy system load, if the table is not updating as expected leave and check again in a few minutes.
• Contact support if issues persist