Skip to content

API Keys Management

Learn how to create, manage, and secure your Knowledge AI API keys for integrations and automation.

What are API Keys?

API keys provide secure access to your Knowledge AI projects for:

  • Claude Desktop MCP integration
  • Custom applications and scripts
  • Automation and CI/CD workflows
  • Third-party integrations

Creating API Keys

  1. Navigate to your project
  2. Go to SettingsAPI Keys (or use the 🔑 button on the dashboard)
  3. Click "Create New API Key"
  4. Configure the key settings:
    • Name: Descriptive name (e.g., "Claude Desktop", "CI Pipeline")
    • Permissions: Choose appropriate access level
    • Expiration: Set expiration date (recommended)
  5. Click "Generate Key"
  6. Copy and save the key immediately - you won't see it again!

Permission Levels

Read Only

  • Search and retrieve notes
  • Access knowledge graph data
  • View project statistics
  • Perfect for: Claude Desktop, documentation tools

Read/Write

  • All read permissions
  • Create and edit notes
  • Modify wikilinks and relationships
  • Perfect for: Automation scripts, content management tools

Admin

  • All read/write permissions
  • Manage API keys
  • Access project settings
  • Perfect for: CI/CD systems, administrative tools

Security Best Practice

Always use the minimum permission level needed for your use case. Most integrations only need "Read Only" access.

Best Practices

Naming Convention

Use descriptive names that indicate:

  • Purpose: claude-desktop, docs-sync, ci-pipeline
  • Environment: production, staging, development
  • Owner: john-laptop, team-automation

Examples:

  • claude-desktop-john-macbook
  • docs-ci-production
  • research-automation-read-only
  • key1, temp, test

Expiration Dates

  • Short-term testing: 30 days
  • Development work: 90 days
  • Production integrations: 1 year maximum
  • Personal tools: 6 months

Environment Separation

Create separate API keys for:

  • Development/testing environments
  • Staging systems
  • Production applications
  • Different team members

Security Reminder: Treat API keys like passwords. Never share them publicly, store them securely, and rotate them regularly. When in doubt, revoke and regenerate.

Built with VitePress