Quick Start Guide

Get up and running with Knotie AI Pro MCP API in minutes

What You'll Learn

This guide will walk you through creating your first automated customer onboarding workflow using the Knotie AI Pro MCP API. You'll learn how to authenticate, create customers, and enable portal access programmatically.

1

Create Your API Key

Generate your partner API key from the Knotie AI Pro dashboard

First, log in to your partner dashboard and navigate to the API Keys section:

  1. Go to Partner Settings → API Keys
  2. Click "Generate New API Key"
  3. Copy both credentials provided:
    • API Key (starts with pkt_)
    • Authorization Header (for MCP client tools)
  4. Store them securely - you won't see them again!

💡 New Feature: We now provide both API key headers and a standard Authorization header for maximum compatibility with MCP client tools!

Important: Keep your credentials secure and never expose them in client-side code.

2

Test Your Connection

Verify your API key works by asking the gateway who you are

Base URLs

  • Partner gateway (production): https://mcp.knotie-ai.pro — every example on this page.
  • Main app: https://knotie-ai.pro — or your own white-label domain. Serves the partner routes under /api/partner/.
  • A development gateway also runs at connecthub.kno2gether.com; use it only if you were explicitly given access.

Your pkt_ key goes in a standard Authorization: Bearer header. meta_whoami needs no scope, so it is the safest first call:

Who am I?

curl -X POST https://mcp.knotie-ai.pro/api/partner-rest/tools/meta_whoami \
  -H "Authorization: Bearer pkt_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

What can this key call?

# Scope-filtered tool list, with the JSON Schema for every argument
curl https://mcp.knotie-ai.pro/api/partner-rest/tools \
  -H "Authorization: Bearer pkt_YOUR_API_KEY"

# Or the full OpenAPI 3.1 document (no auth needed)
curl https://mcp.knotie-ai.pro/api/partner-rest/openapi.json

💡 Tip: A 401 with data.type: "mcp_disabled_on_key" means the key is valid but MCP access is toggled off — flip "Enable MCP" on in the key's scope editor.

AI agents should use the MCP endpoint instead — POST https://mcp.knotie-ai.pro/api/partner-mcp (JSON-RPC 2.0, and it requires Accept: application/json, text/event-stream). Same keys, same scopes, same tools. See the Partner MCP guide.

3

Onboard Your First Customer

One call: account, credentials, welcome email, plan, and starting credits

customers_onboard provisions a complete customer in a single call. There is no password field — a secure password is generated server-side and delivered only in the branded welcome email.

Through the gateway (recommended)

curl -X POST https://mcp.knotie-ai.pro/api/partner-rest/tools/customers_onboard \
  -H "Authorization: Bearer pkt_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Corp",
    "initialAiCredits": 250
  }'

Or straight against the main app

curl -X POST https://knotie-ai.pro/api/partner/customers/onboard \
  -H "X-API-Key: pkt_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Corp",
    "planId": "plan_abc123",
    "features": { "showKnowledgeBase": true, "selfServeAgentLimit": 3 },
    "initialAiCredits": 250
  }'

Substitute your own white-label domain for knotie-ai.pro if you have one. A partner bearer token works here too.

Expected Response (201 Created):

{
  "customerId": "cus_abc123",
  "userOnboardingId": "onb_abc123",
  "created": true,
  "existing": false,
  "appliedPlanId": "plan_abc123",
  "appliedFeatures": ["plan:plan_abc123", "showKnowledgeBase",
                      "selfServeAgentLimit", "initialAiCredits"],
  "warnings": []
}

Two things not to miss

  • Always read warnings[]. Your partner master switches are applied last and unconditionally, so a feature you asked for may legitimately not have been enabled — that is reported as a warning, not an error. appliedFeatures is the honest record of what landed.
  • It is idempotent on (partner, email). A repeat call returns HTTP 200 with created: false and mutates nothing — the plan, overrides and credits in that request are ignored. To change a live customer use customers_update or the credit tools.
4

Set Up Their Credits and Access

Give the customer a recurring monthly allocation, and portal credentials if needed

Step 3 already sent portal credentials in the welcome email. Use these when you need a recurring credit allocation, or need to re-issue access.

Recurring monthly credit allocation

curl -X POST https://mcp.knotie-ai.pro/api/partner-rest/tools/customer_credits_set_monthly \
  -H "Authorization: Bearer pkt_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "CUSTOMER_ID_FROM_STEP_3",
    "monthlyAllocation": 500,
    "rolloverEnabled": false,
    "reason": "Growth plan monthly allocation"
  }'

monthlyAllocation: 0 turns the recurring grant off. Omit rolloverEnabled to leave the current setting alone. The ledger row is stamped [via api-key:<your key name>] automatically — do not append it to reason yourself. For a one-off grant use customer_credits_top_up.

Re-issue portal access

curl -X POST https://mcp.knotie-ai.pro/api/partner-rest/tools/customers_enable_portal \
  -H "Authorization: Bearer pkt_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "CUSTOMER_ID_FROM_STEP_3",
    "generatePassword": true,
    "notifyCustomer": true
  }'

Where to go next

🎉 Congratulations! What's Next?

Explore Full API Reference

Discover all available endpoints for agent management, feature control, and more.

View Documentation

Watch Video Tutorials

Learn advanced automation techniques with step-by-step video guides.

Watch Tutorials

Ready to build AI automation? Download our Postman collection for easy testing:

Download Postman Collection