Store the OpenAI API key securely

Follow this guide to add or retain the encrypted AI credential.

What this guide helps you do

Add or retain the encrypted AI credential. The workflow below follows the supported application or module flow and does not invent a menu or bypass validation.

Follow these steps

1. Go to the exact navigation path shown above.
2. Select the authorised mailbox, message or configuration record.
3. Complete the fields or action described in this guide.
4. Save or submit once, then verify the resulting status and related record.

Fields and options

• OpenAI API key

Rules and limits

• The key is encrypted before storage.
• Blank on edit retains the existing key.
• The current key is never revealed in plaintext.
• Rotate compromised keys at the provider.

Check it worked

• The requested Mailbox Exchange record is updated through the supported controller and remains attributable to the acting staff member.

Security, audit and troubleshooting checks

• Use the exact authorised account, role and record before saving or sending.
• Verify the saved status and downstream record; a browser success message alone is not sufficient evidence.
• Never expose passwords, API keys, access tokens, protected attachments or raw server paths in support tickets.
• Do not edit module or core database records directly to bypass validation, permissions, migrations or state rules.

Related guides