Authentication

    All API requests require authentication using an API key. Learn how to generate and use your API key securely.

    Getting Your API Key

    Follow these steps to generate your API key

    1. 1

      Sign in to your PlumoAI account at app.plumoai.com

    2. 2

      Navigate to SettingsAPI Keys

    3. 3

      Click "Create API Key" and give it a descriptive name

    4. 4

      Copy your API key immediately. Important: Store it securely as it won't be shown again

    Using Your API Key

    Include your API key in all API requests

    Include your API key in the Authorization header of every request:

    Authorization: Bearer YOUR_API_KEY

    Example Request

    curl https://api.plumoai.com/v1/pages \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json"

    API Key Security Best Practices

    Keep your API keys secure

    Never commit API keys to version control

    Use environment variables or secure secret management tools

    Rotate keys regularly

    Generate new keys periodically and revoke old ones

    Use different keys for different environments

    Separate keys for development, staging, and production

    Monitor key usage

    Regularly review API key activity in your account settings

    API Key Permissions

    Understand what your API key can access

    API keys inherit the permissions of the user account that created them. They have access to all workspaces and projects that the user can access.

    To restrict access, create API keys from user accounts with limited permissions, or use workspace-specific access controls.