Integrations

Extending Your AI Agent: Creating and Using API Keys

Connect your AI agent to external services, custom applications, or third-party platforms using a secure API key. This makes your agent accessible across multiple environments, giving it the flexibility to serve users wherever you need it most.

Step 1: Access the API Management Section

  1. Log in to your Flockx dashboard at agents.flockx.io.
  2. In the left-hand navigation menu, click on API Keys.
  3. You’ll be redirected to the API Management tab.

Step 2: Generate Your API Key

  1. Under My Custom Integration, enter a clear, descriptive name (e.g., “Website Backend”, “Mobile App”).
  2. Click Create Key.
  3. A pop-up window will display your newly generated API key.
  4. Copy and store it securely—this key gives access to your agent’s services.

⚠️ Important: Keep your API key private. Anyone with the key can access your agent’s capabilities.

Step 3: Use Your API Key

You can now integrate your AI agent in a variety of scenarios:

  • Official API Documentation: Visit docs.flockx.io for integration examples and best practices.
  • Third-Party Systems: Plug into CRMs, helpdesks, and productivity tools.
  • Custom Applications: Add conversational AI functionality to your own software.
  • Platform Extensions: Use it to deploy your agent on unsupported platforms.

Step 4: Manage Your API Keys

From the API Management tab, you can:

  1. View your full list of existing API keys.
  2. Revoke any keys that are no longer needed.
  3. Create multiple keys for different services to maintain separation and security.

Troubleshooting Tips

  • Key not appearing? Try refreshing the page or checking your browser’s pop-up settings.
  • Lost your key? You’ll need to generate a new one—API keys are only displayed once.
  • Integration errors? Double-check the key was pasted correctly and that it has not been revoked.
  • Security concern? Immediately revoke the compromised key and generate a new one.
  • Need help? Contact contact@flockx.io

Benefits of API Integration

  • Expand your agent’s capabilities beyond the Flockx platform
  • Seamlessly integrate with existing systems and software stacks
  • Enable automated workflows and real-time interaction in custom environments
  • Maintain secure and granular control through key management
  • Rapidly scale use cases by deploying your agent anywhere with ease