Documentation

Getting Started

Get up and running with Lunexa in just a few minutes. Follow these steps to create your account and start managing search.

1. Navigate to app.ailunexa.com/register to create your account.
2. Choose email/password or Sign in with Google.
3. Confirm your email address if signing up with email.
4. After signing in, you will be taken to the main dashboard.

Creating an Organization

Organizations are the top-level container for all your search projects, team members, and billing. Every resource you create belongs to an organization.

1. From the dashboard, click "+ New Organization".
2. Enter a name for your organization. A URL-friendly slug will be auto-generated.
3. Click "Create" to finalize.
4. You will be redirected to your new organization's dashboard.

Managing Projects

Projects group related search indexes together. Use them to separate environments (production, staging) or different applications within the same organization.

1. Click on your organization in the sidebar to expand it.
2. Click "+ New Project" to create a project.
3. Click a project name to view its indexes, API keys, and settings.

Creating an Index (Collection)

An index (also called a collection) defines the schema for your searchable documents. Each field has a name, type, and optional flags like facet and optional.

1. Navigate to your project's Indexes page.
2. Click "New Collection".
3. Enter a collection name (e.g., products).
4. Define your fields — each row needs a name, type, and optional flags.
5. Click "Create Collection".

Supported field types: string int32 int64 float bool string[] auto geopoint

Importing Documents

Once your collection is created, you can populate it with documents using the dashboard or the API.

1. Navigate to your collection's Documents tab.
2. Click "Import" to upload a JSONL file.
3. Or click "Generate" to create sample data for testing.
4. You can also use the API for programmatic imports (see below).

curl -X POST "https://api.ailunexa.com/api/v1/orgs/{org}/projects/{project}/collections/{collection}/documents/import?action=upsert" \
  -H "X-LUNEXA-API-KEY: your-api-key" \
  -H "Content-Type: text/plain" \
  --data-binary @data.jsonl

Searching Documents

Test your search experience directly from the dashboard or integrate it into your application using the API.

1. Open the Documents tab of any collection.
2. Type your query into the search bar at the top.
3. Results update in real time, showing matched documents with highlights.

curl "https://api.ailunexa.com/api/v1/orgs/{org}/projects/{project}/collections/{collection}/documents?q=wireless+headphones&query_by=title,description" \
  -H "X-LUNEXA-API-KEY: your-api-key"

API Keys

API keys control how your applications access Lunexa. Use scoped keys to enforce least-privilege access for every use case.

1. Go to Settings > API Keys or Project > API Keys.
2. Click "Create Key" and choose a template.
3. Configure collection restrictions, expiration, and rate limits.
4. Copy your new key — it is only shown once.

Key templates:

Synonyms & Curations

Fine-tune your search relevance with synonyms and curations. Synonyms ensure alternative terms return the same results; curations let you pin or hide specific documents for a query.

Synonyms

1. Navigate to your collection's Synonyms tab.
2. Click "Add Synonym".
3. Choose Multi-way (all terms are interchangeable) or One-way (one term maps to another).
4. Enter the synonym terms and save.

Curations

1. Navigate to the Curations tab.
2. Enter a query to curate results for.
3. Drag documents to pin them to the top or mark them as hidden.

Team Management

Invite your team and control who can access what with role-based permissions.

1. Go to Settings > Team.
2. Click "Invite Member" and enter their email address.
3. Assign a role: Owner, Admin, Editor, or Viewer.
4. The invitee receives an email and can join immediately.

Billing & Plans

Manage your subscription, view usage, and download invoices from the billing page.

1. Go to Settings > Billing.
2. View your current plan and usage metrics.
3. Click "Upgrade" or "Manage Plan" to change your subscription.
4. Access invoices and payment history in the Invoices section.

API Reference

All endpoints are served from https://api.ailunexa.com/api/v1. Authenticate with the X-LUNEXA-API-KEY header.