Quickstart

1. Create your workspace

Naming your workspace
Setting your industry and company size
Optionally loading sample catalog data to explore

2. Generate an API key

Navigate to Settings > API Keys in your workspace dashboard, or use the setup endpoint after authentication.

Go to API Keys

Open your workspace settings and click API Keys in the sidebar.

Create a key

Click Create API Key, give it a name (e.g. dev-local), and select the permissions you need.

Copy the key

Your API key is shown once. Copy it and store it securely.

API keys are shown only at creation time. If you lose your key, revoke it and create a new one.

3. Make your first request

Verify your key works by fetching your workspace settings:

curl -X GET "https://app.alana.shopping/api/workspace/{workspaceId}/settings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch(
  `https://app.alana.shopping/api/workspace/${workspaceId}/settings`,
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
  }
);
const workspace = await response.json();
console.log(workspace);

import requests

response = requests.get(
    f"https://app.alana.shopping/api/workspace/{workspace_id}/settings",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
print(response.json())

4. Create your first brand

Brands organize your product content and carry AI specs (tone, keywords, policies).

curl -X POST "https://app.alana.shopping/api/workspace/{workspaceId}/brands" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Brand",
    "description": "Premium lifestyle products"
  }'

5. Create a catalog and add products

# Create a catalog
curl -X POST "https://app.alana.shopping/api/workspace/{workspaceId}/catalogs" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Spring 2026 Collection",
    "brandId": "BRAND_ID_FROM_STEP_4"
  }'

# Add a product
curl -X POST "https://app.alana.shopping/api/workspace/{workspaceId}/catalog/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "catalogId": "CATALOG_ID",
    "title": "Classic Cotton Tee",
    "description": "100% organic cotton t-shirt",
    "brand": "My Brand",
    "price": 29.99,
    "currency": "USD",
    "sku": "CCT-001"
  }'

6. Generate AI content

Use the AI engine to enhance your product description, with brand-aware context:

curl -X POST "https://app.alana.shopping/api/ai/enhance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "100% organic cotton t-shirt",
    "type": "description",
    "brandId": "BRAND_ID"
  }'

Next steps

Authentication deep-dive

Learn about API keys, session auth, and scopes.

Import products in bulk

Upload CSV/Excel files with thousands of products.

Set up AI specs

Configure brand tone, keywords, and policies for AI generation.

Explore the API

Interactive playground with all 90+ endpoints.

Getting Started

Core Concepts

Guides

1. Create your workspace

2. Generate an API key

3. Make your first request

4. Create your first brand

5. Create a catalog and add products

6. Generate AI content

Next steps

Authentication deep-dive

Import products in bulk

Set up AI specs

Explore the API

​1. Create your workspace

​2. Generate an API key

​3. Make your first request

​4. Create your first brand

​5. Create a catalog and add products

​6. Generate AI content

​Next steps

Authentication deep-dive

Import products in bulk

Set up AI specs

Explore the API

1. Create your workspace

2. Generate an API key

3. Make your first request

4. Create your first brand

5. Create a catalog and add products

6. Generate AI content

Next steps