Lumea Documentation

Getting Started with Lumea ​

Welcome to Lumea! This guide will help you get started with our platform for agentic AI workflows, operations, observability, and dashboard solutions.

Prerequisites ​

Before you begin, make sure you have:

  • A Lumea account (sign up at app.lumea.ai if you don't have one)
  • Your custom API endpoint information (provided during onboarding)
  • Authentication credentials (API key or user credentials)
  • Basic understanding of AI concepts
  • Your use case requirements defined

Custom Deployment Information ​

Important: Each customer receives a custom deployment with a unique API endpoint. All API endpoints described in our documentation should be prefixed with your organization's specific API URL provided during onboarding.

For example, if your custom API endpoint is https://acme-corp.lumea.ai, then the workflows endpoint would be:

https://acme-corp.lumea.ai/workflows

Quick Start ​

1. Create an Account ​

  1. Go to app.lumea.ai
  2. Click "Sign Up"
  3. Fill in your details and create your account
  4. Complete the onboarding process

2. Set Up Authentication ​

Lumea supports two authentication methods:

API Key Authentication ​

  1. Log in to your Lumea dashboard
  2. Navigate to Settings > API Keys
  3. Click Create New API Key
  4. Give your key a descriptive name (e.g., "Production", "Development")
  5. Set appropriate permissions
  6. Click Generate Key
  7. Securely store your API key (it will only be shown once)

For detailed information on managing API keys, see the API Keys Dashboard Guide.

JWT Token Authentication ​

For user sessions and applications where you need to authenticate as specific users, JWT tokens are provided through our authentication endpoints.

3. Set Up Your Workspace ​

  1. Create a new workspace or join an existing one
  2. Configure your workspace settings
  3. Invite team members if needed

4. Create Your First Workflow ​

  1. Navigate to the Workflows section
  2. Click "Create New Workflow"
  3. Choose a template or start from scratch
  4. Give your workflow a name and description
  5. Use the visual editor to design your workflow
  6. Save your workflow

5. Configure Your Agent ​

  1. Navigate to the Agents section
  2. Click "Create New Agent"
  3. Configure your agent's settings:
    • Select an AI model
    • Configure parameters
    • Define capabilities
  4. Save your agent configuration

6. Deploy and Run Your Workflow ​

  1. Go back to your workflow
  2. Configure any required inputs
  3. Click "Deploy" to make your workflow available
  4. Run a test execution to verify functionality

7. Monitor Your Workflow ​

  1. Navigate to the Analytics section
  2. Select your workflow
  3. View performance metrics and execution logs

Key Concepts ​

Agents ​

Agents are the core building blocks of Lumea workflows. An agent is an AI entity that can perform tasks, make decisions, and interact with other agents or systems.

Workflows ​

Workflows define how agents interact and collaborate to achieve a goal. Lumea's visual workflow builder makes it easy to design complex agent interactions.

Runs ​

Runs are individual executions of your workflows. Each run has inputs, outputs, execution logs, and status information. Through the Runs API, you can start, monitor, and manage these executions programmatically.

Operations ​

Operations include deployment, scaling, and management of your AI workflows. Lumea handles the infrastructure so you can focus on building great AI applications.

Observability ​

Observability tools help you monitor, debug, and optimize your AI workflows. Track performance, identify issues, and gain insights into your agents' behavior.

First API Call ​

To make your first API call, use your custom endpoint and API key:

bash
curl -X POST "https://your-custom-endpoint.lumea.ai/workflows/{workflow_id}/runs" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "query": "What's the weather like today?"
    }
  }'

Replace:

  • your-custom-endpoint.lumea.ai with your actual endpoint URL
  • {workflow_id} with your actual workflow ID
  • your-api-key-here with your API key

Alternatively, you can use JWT authentication:

bash
curl -X POST "https://your-custom-endpoint.lumea.ai/workflows/{workflow_id}/runs" \
  -H "Authorization: Bearer your-jwt-token-here" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "query": "What's the weather like today?"
    }
  }'

This API call will start a new workflow run with your specified input. You can then retrieve the status and results using the Runs API. For more information about available endpoints, see the Workflows API Documentation.

API Security Best Practices ​

  1. Keep your API keys secure and don't expose them in client-side code
  2. Store API keys in environment variables for server applications
  3. Rotate API keys periodically for better security
  4. Use custom API keys with limited permissions whenever possible
  5. Always use HTTPS for all API requests to ensure credentials are encrypted

For detailed information on API key management, see the API Keys Dashboard Guide.

Next Steps ​

Need Help? ​

If you encounter any issues or have questions:

Copyright © 2025 Lumea AB