Back to Help Center

API Keys

Programmatic access to Caqophony products

What are API Keys?

API keys allow you to access Caqophony products programmatically. Use them to integrate Flowrunner data into your own applications, automate workflows, or build custom integrations.

Security Notice

API keys grant access to your data. Keep them secure and never share them publicly or commit them to version control.

Creating an API Key

  1. 1

    Go to API Keys page

    Navigate to API Keys in your Swarm dashboard.

  2. 2

    Click "Create API Key"

    Choose a descriptive name like "Production Integration" or "Development Testing".

  3. 3

    Copy your key

    Your API key will be shown once. Copy it immediately and store it securely.

Using Your API Key

Include your API key in the x-api-key header when making requests:

curl -X GET \
  https://flowrunner.caqophony.com/api/bd/companies \
  -H "x-api-key: frun_your_api_key_here"

API keys use your Token Pool allocation. Each request consumes tokens based on the operation performed.

Rate Limits

API requests are rate limited to ensure fair usage:

PlanRate Limit
Starter100 requests/minute
Pro500 requests/minute
Enterprise2,000 requests/minute

Best Practices

Use environment variables

Store API keys in environment variables, never hardcode them in your application.

Rotate keys regularly

Create new keys periodically and revoke old ones to minimize exposure risk.

Use separate keys for environments

Create different keys for development, staging, and production environments.