Authentication

Documentation Index

Fetch the complete documentation index at: https://docs.plumi.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

API Keys

​

Creating an API Key

1. Go to Settings > API Keys in your Plumi workspace
2. Click Create API Key
3. Give your key a descriptive name
4. Copy the key (it won’t be shown again)

​

Using Your API Key

curl -X GET "https://your-workspace.plumi.ai/api/connections" \
  -H "Authorization: Bearer YOUR_API_KEY"

https://your-workspace.plumi.ai/sse?api_key=YOUR_API_KEY

​

API Key Permissions

• Read-only users can only execute SELECT queries
• Admin users have full access

​

Revoking API Keys

1. Go to Settings > API Keys
2. Find the key you want to revoke
3. Click Revoke

​

Best Practices

• Use separate keys for different integrations
• Rotate keys regularly (at least every 90 days)
• Use environment variables to store keys
• Never expose keys in client-side code or logs

​

Error Responses

​

401 Unauthorized

{
  "success": false,
  "error": "Invalid or missing API key"
}

​

403 Forbidden

{
  "success": false,
  "error": "Insufficient permissions"
}