API Introduction

Overview

The Plumi API allows you to programmatically:

All API requests should be made to your workspace URL:

https://your-workspace.plumi.ai/api

All API endpoints require authentication using API keys.

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

See Authentication for details on obtaining and using API keys.

All responses are returned as JSON:

{
  "success": true,
  "data": {
    // Response data
  }
}

Error responses include an error message:

{
  "success": false,
  "error": "Error message"
}

API requests are rate limited based on your plan: