ARI.Software Docs

API Keys

Manage API keys for external access to your ARI instance.

Overview

ARI has two types of API keys:

  1. Provider API keys — Keys for external services like OpenAI, Anthropic, etc. These are configured in Settings > Integrations.
  2. ARI API keys — Keys that grant external applications access to your ARI instance's API.

This page covers ARI API keys. For provider API keys, see AI Integrations.

ARI API Key Management

You can create and manage API keys for external access to your ARI instance in Settings > API.

Creating a Key

  1. Go to Settings > API
  2. Click "Create API Key"
  3. Give the key a descriptive name (e.g. "Automation Script", "Mobile App")
  4. Copy the key immediately — it will not be shown again

Using a Key

Include the API key in the Authorization header of your requests:

Authorization: Bearer your-api-key-here

Revoking a Key

To revoke a key, go to Settings > API and delete it. The key will stop working immediately.

Usage Logging

ARI logs API key usage so you can monitor which keys are being used and how often. Review usage periodically and revoke any keys that are no longer needed.

Email (Resend)

Optional. Enables email notifications and other email-based features.

  1. Create an account at resend.com
  2. Generate an API key
  3. Add RESEND_API_KEY to your environment configuration

Security Best Practices

  • Never share your API keys or commit them to version control
  • Use descriptive names so you can identify what each key is for
  • Revoke keys that are no longer in use
  • Use different keys for different applications
  • Rotate keys periodically
  • Monitor usage logs for unexpected activity

Your Personal Workspace. Your Rules.

Open Source. Self-Hosted. Full Data Control. Fully Extendable. AI Native. Dozens of Built-In Modules And Build Your Own In Minutes. No Coding Required.

Download