Admin: AI API Keys Management

Overview

The Admin AI API Keys section allows you to configure and manage API keys for AI service integrations such as OpenAI, Anthropic, and Google AI. These keys enable AI-powered features in CitoHR, such as intelligent content generation, automated responses, and AI-assisted workflows.

Prerequisites

• You must have ADMIN role to manage AI API keys
• AI API Keys is a Pro feature - ensure your organization has Pro subscription
• API keys from the AI service provider (OpenAI, Anthropic, Google AI, etc.)

Accessing AI API Keys

1. Log in to your CitoHR account with Admin credentials
2. Click on your organization name in the header
3. Select "System" from the admin menu
4. Click "AI API Keys" from the System dropdown
5. Or navigate directly to /admin/ai-keys

Screenshot Placeholder

Admin navigation showing AI API Keys option

/screenshots/docs/admin/ai-keys/accessing-ai-keys/screenshot.png

Viewing AI API Keys

See all configured AI API keys:

1. On the AI API Keys page, you'll see a table listing all API keys
2. Each key shows:
   • Key name/description
   • AI service (OpenAI, Anthropic, Google AI, etc.)
   • Status (Active, Inactive)
   • Last used date (if available)
   • Actions (Edit, Delete)
3. API key values are masked for security (shown as asterisks)

Screenshot Placeholder

AI API keys table showing all keys

/screenshots/docs/admin/ai-keys/viewing-ai-keys/screenshot.png

Adding an AI API Key

Add a new AI service API key:

1. On the AI API Keys page, click the "Add Key" or "Create" button
2. The API key creation dialog will open
3. Fill in the key details:
   • Name - Enter a descriptive name (e.g., "OpenAI Production", "Anthropic Claude")
   • Service - Select the AI service (OpenAI, Anthropic, Google AI, etc.)
   • API Key - Paste the API key from the service provider
   • Status - Set to Active to enable the key
4. Click "Add" or "Save"
5. The API key will be saved and encrypted
6. A success message will confirm the key was added

Screenshot Placeholder

Add AI API key dialog

/screenshots/docs/admin/ai-keys/adding-ai-key/screenshot.png

Editing an AI API Key

Update an existing API key:

1. On the AI API Keys page, find the key you want to edit
2. Click the "Edit" button or icon
3. The edit dialog will open
4. Update fields as needed:
   • Change the key name
   • Update the API key value (paste new key)
   • Toggle Active/Inactive status
5. Click "Save" or "Update"
6. The changes will be saved

Screenshot Placeholder

Edit AI API key dialog

/screenshots/docs/admin/ai-keys/editing-ai-key/screenshot.png

Activating or Deactivating API Keys

Enable or disable API keys:

1. On the AI API Keys page, find the key
2. Edit the key and toggle the Status field
3. Set to Active to enable the key for use
4. Set to Inactive to disable the key without deleting it
5. Click "Save"

Deleting an AI API Key

Remove an API key from the system:

1. On the AI API Keys page, find the key you want to delete
2. Click the "Delete" button or icon
3. A confirmation dialog will appear
4. Review the warning message carefully
5. Click "Confirm" or "Delete" to proceed
6. The API key will be permanently removed

Obtaining API Keys

Get API keys from AI service providers:

• OpenAI - Sign up at platform.openai.com and create an API key in your account settings
• Anthropic - Sign up at console.anthropic.com and generate an API key
• Google AI - Use Google Cloud Console to create API credentials
• Follow each provider's documentation for specific instructions

Best Practices

• Use descriptive names for API keys to identify their purpose
• Keep API keys secure and never share them publicly
• Rotate API keys periodically for security
• Monitor API key usage and costs through service provider dashboards
• Deactivate unused keys instead of deleting them
• Use separate keys for different environments (development, production) if applicable
• Set up usage alerts with the service provider to avoid unexpected charges

Related Features

• AI-powered features throughout CitoHR that use these API keys