Quickstart

Welcome to Luella’s API. If you’re building an integration, automation, or internal tool using Luella, this page will walk you through how to get started quickly.

API Overview

All Luella endpoints are POST requests and require authentication via request body fields. The base URL for the Luella API is:

https://api.luella.ai

Each endpoint in the documentation will show the full path that should be appended to this base URL.

For example, the ListClusters endpoint is called via:

POST https://api.luella.ai/clusters/ListClusters

Authentication

Luella uses a simplified authentication system.

To get started, email adb@luella.ai with your Luella workspace name and email address ID.

You’ll receive your unique userId and workspaceId, which must be included in the request body of every API call.

Here’s an example of a typical request body:

{
  "userId": "your_user_id",
  "workspaceId": "your_workspace_id",
  // ... other request-specific fields
}

SDKs

Luella does not currently provide any official SDKs. However, since all endpoints are simple JSON-based POST APIs, you can use standard HTTP clients in any language (such as fetch, axios, requests, or curl).

Try the API using Postman

If you’d like to test endpoints quickly, you can use Postman:

1. Install Postman

• Download from: https://www.postman.com/downloads
• Follow the installation steps for your OS.

2. Create a new request

• Open Postman.
• Click New → Request.
• Set the method to POST.
• Set the request URL to: https://api.luella.ai/{your-endpoint} (e.g. clusters/ListClusters).

3. Add Headers

• Under the Headers tab, set:

Key: Content-Type
Value: application/json

4. Add Request Body

• Select Body → raw → JSON.
• Paste in a request body that includes your userId and workspaceId, like so:

{
  "userId": "your_user_id",
  "workspaceId": "your_workspace_id",
  "maxItems": 10
}

5. Send the request

• Click Send.
• You’ll receive a JSON response with the requested data or confirmation.

You're ready to start exploring the API! We recommend beginning with core entities like Clusters, Profiles, Email Addresses, and Campaigns.