Skip to main content

​
What API Keys are for

API Keys let you connect Knotie AI Pro to external tools and automations. Common uses:
  • AI automation (MCP)
  • Internal dashboards
  • Custom scripts for customer onboarding
For customer-scoped widgets, iframe embeds, and embedded portal access, use Embed URLs instead of a partner API key.

​
Where to find it

In the Partner Portal:
  1. Open Settings.
  2. Click API Keys.

​
Create a new API key

On the API Keys page:
  1. Click Create API Key (or the create action shown in the key manager section).
  2. Give the key a name you’ll recognize (example: “N8N Production”).
  3. Save.
Important: copy the key and store it safely.

​
Keep keys secure

API keys should be treated like passwords.
  • Do not paste keys into client-side code.
  • Use a password manager or secrets vault.
  • Rotate keys if a contractor leaves your team.

​
Using your API key with MCP

If you’re using MCP endpoints, you’ll typically pass your key in an X-API-Key header. (Your API Reference section includes copy/paste examples.)

​
Platform API

The Platform API allows you to programmatically interact with Knotie AI Pro features:
  • Create and manage customers
  • Trigger automations
  • Access analytics data
  • Manage credits and billing
To use the Platform API:
  1. Generate an API key from Settings → API Keys.
  2. Include the key in your API requests.
  3. Refer to the API Reference section for endpoint documentation.
Platform API Settings

​
API Gateway

The API Gateway feature provides advanced API management with four different types of API keys:

​
1. Partner API Key

  • Full access to partner-level operations
  • Used for internal dashboards and automations
  • Highest privilege level

​
2. Customer API Key

  • Scoped to a specific customer
  • Limited to customer-specific operations
  • Ideal for customer-facing integrations

​
3. Read-Only API Key

  • Can only fetch data (GET requests)
  • Cannot modify any resources
  • Safe for analytics dashboards

​
4. Webhook API Key

  • Used specifically for webhook integrations
  • Limited to webhook-related endpoints
  • Secure callback authentication
API Gateway - 4 Key Types

​
Best practices for API Gateway

  • Use the least privilege key type for each use case.
  • Rotate keys regularly, especially after team changes.
  • Monitor key usage in Agent Analytics.

​
Troubleshooting

  • I don’t see API Keys under Settings
    • You may be logged in as a team member without settings permissions.
    • Ask the account owner to grant access.
  • My API calls fail
    • Confirm you’re using the correct key.
    • Confirm the base URL for the endpoint.

​
Screenshot

Create API Key Modal