Quick Start

Quick Start Guide

Overview

Novolem helps you create automated flows that can monitor web sources and take actions based on your requirements. Each flow consists of:

  • Sources: Where to get information from (URLs, search queries)
  • Prompt: What to look for or analyze
  • Destinations: Where to send results (email, webhooks)

Creating Your First Flow

  1. Sign up at novolem.com (opens in a new tab) to get your API key
  2. Create a flow using our API:
curl -X POST "https://api.novolem.com/flow/create" \
  -H "Novolem-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "org_id": "your_org_id",
    "name": "Monitor Tech News",
    "trigger": "schedule",
    "sources": [
      {
        "name": "Tech News",
        "role": "url"
      }
    ],
    "prompt": "Monitor for news about AI developments",
    "destinations": [
      {
        "name": "Email Updates",
        "role": "email",
        "email": "you@example.com"
      }
    ],
    "frequency": "1hr"
  }'

Monitoring Your Flows

Check the status of your flows:

curl -X GET "https://api.novolem.com/flow/retrieve" \
  -H "Novolem-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "statuses": ["active"]
  }'

View flow run results:

curl -X GET "https://api.novolem.com/flow-run/retrieve" \
  -H "Novolem-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "statuses": ["completed"]
  }'

Flow Configuration Options

Sources

  • url: Monitor specific web pages
  • search: Perform web searches

Triggers

  • manual: Run on demand
  • schedule: Run at specified intervals

Destinations

  • email: Send results via email
  • webhook: Send results to a webhook URL

Frequencies

Available for scheduled triggers:

  • 5min, 15min, 30min
  • 1hr, 2hr, 4hr, 8hr, 12hr
  • 1day, 4day, 7day

For detailed API documentation, check out our API Reference.

IntroductionAPI Reference