Configuration Guide

Learn how to configure SwarmCanvas environment variables and settings for optimal performance.


Accessing Settings

  1. 1. Navigate to the SwarmCanvas dashboard
  2. 2. Click on the Settings icon in the navigation menu
  3. 3. Select "Environment Variables" section

Setting up OpenAI API Key

The OpenAI API key is required for SwarmCanvas to interact with OpenAI's services. To configure it:

  1. 1. Locate the OPENAI_API_KEY field in the Environment Variables section
  2. 2. Enter your OpenAI API key
  3. 3. If you don't have an API key, you can obtain one from OpenAI's platform
  4. 4. Click "Save Changes" to apply the configuration
⚠️

Make sure to keep your API key secure and never share it publicly

Adding Custom Environment Variables

  1. 1. Find the "Add New Variable" section
  2. 2. Enter the variable name in the "New Key" field
  3. 3. Enter the variable value in the "New Value" field
  4. 4. Click "Add" to include the new variable
  5. 5. Click "Save Changes" to apply all configurations

Important Notes

ℹ️

Key Points to Remember:

  • Environment variables are automatically configured when testing your swarm
  • All sensitive information is encrypted and securely stored
  • Changes to environment variables require saving to take effect
  • Make sure to validate your API keys before saving

Troubleshooting

If you encounter issues with your configuration:

  • ✔️
    Verify that your OpenAI API key is valid and active
  • ✔️
    Ensure all required environment variables are properly set
  • ✔️
    Check for any error messages in the interface
  • ✔️
    Make sure to save changes after any modifications
💡

Pro Tip: Always test your configuration with a simple swarm after setting up new environment variables to ensure everything is working correctly.