Lyren API Reference for Developers

https://YOUR_DOMAIN

- Health
- Limits
- Chat
- Tools
- Memory
- Knowledge Base
- Business
- Workflows
- Scheduler
- Calendar
- Connectors

x-api-key: YOUR_API_KEY
Content-Type: application/json

x-api-key: YOUR_API_KEY
x-user-id: user_123
Content-Type: application/json

curl https://YOUR_DOMAIN/v1/limits \
  -H "x-api-key: YOUR_API_KEY"

curl https://YOUR_DOMAIN/health

{
  "model": "lyren",
  "messages": [
    { "role": "user", "content": "Hello from my app." }
  ],
  "temperature": 0.3,
  "max_tokens": 400
}

{
  "text": "We need to ship v1 in 7 days. Backend is behind. QA has not started."
}

{
  "text": "Hello, how are you?",
  "target_language": "Spanish"
}

{
  "text": "We are late on the project.",
  "style": "professional"
}

{
  "text": "Jane Doe (jane@acme.com) reported checkout error. Urgency: high.",
  "instruction": "Extract the customer name, email, issue, and urgency."
}

{
  "url": "https://example.com/article"
}

{
  "url": "https://example.com/article"
}

x-api-key: YOUR_API_KEY
x-user-id: user_123
Content-Type: application/json

{
  "query": "How does the user like responses formatted?",
  "limit": 5,
  "ranked": true
}

{
  "id": 42
}

{
  "title": "Finish API docs",
  "description": "Rewrite docs to match public developer routes.",
  "project": "Lyren",
  "tags": "docs,api",
  "status": "open",
  "priority": 8,
  "pinned": true
}

{
  "query": "docs tasks",
  "limit": 5,
  "ranked": true
}

{
  "query": "continue the API reference rewrite",
  "memory_limit": 8,
  "task_limit": 5,
  "include_tasks": true,
  "project": "Lyren"
}

curl -X POST https://YOUR_DOMAIN/v1/knowledge/upload \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-user-id: user_123" \
  -F "file=@./policy.pdf"

{
  "question": "Summarize our refund policy and list exceptions.",
  "top_k": 6
}

{
  "budget_usd": 5000,
  "company_size": 120,
  "timeline_days": 14,
  "stage": "proposal",
  "source": "inbound",
  "engagement": {
    "email_opens": 4,
    "email_replies": 1,
    "meetings": 1,
    "site_visits": 6,
    "demo_requested": true
  }
}

{
  "usage_last_30d": [12, 11, 10, 10, 9, 8, 7, 7, 6, 6, 5, 5, 5, 4, 4],
  "tickets_last_30d": 3,
  "refunds_last_90d": 1,
  "failed_payments_last_30d": 2,
  "last_active_days": 18,
  "nps": 3
}

{
  "currency": "USD",
  "events": [
    { "type": "refund", "amount": 39.99 },
    { "type": "failed_payment", "amount": 49.00 },
    { "type": "chargeback", "amount": 99.00 },
    { "type": "cancellation", "mrr": 49.00 },
    { "type": "downgrade", "mrr_delta": -30.00 }
  ]
}

{
  "name": "sales_followup",
  "definition": {
    "steps": [
      { "type": "rewrite", "style": "professional" },
      { "type": "extract", "instruction": "Extract action items." }
    ]
  }
}

curl https://YOUR_DOMAIN/v1/workflows/list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-user-id: user_123"

{
  "run_at": "2026-03-20T18:30:00Z",
  "job_type": "webhook",
  "payload": {
    "webhook_url": "https://yourapp.com/hooks/reminder",
    "body": {
      "message": "Follow up with the lead."
    }
  }
}

curl https://YOUR_DOMAIN/v1/schedule/list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-user-id: user_123"

curl -X POST https://YOUR_DOMAIN/v1/schedule/cancel/JOB_ID \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-user-id: user_123"

GET  /v1/calendar/providers
POST /v1/calendar/freebusy
POST /v1/calendar/create-event
POST /v1/calendar/book

{
  "name": "Main Sitemap",
  "kind": "sitemap",
  "config": {
    "url": "https://example.com/sitemap.xml"
  }
}

curl https://YOUR_DOMAIN/v1/connectors/list \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-user-id: user_123"

POST /api/auth/signup
POST /api/auth/login
POST /api/auth/logout
GET  /api/me
GET  /api/keys/me
POST /api/keys/regenerate
POST /api/billing/checkout
POST /api/billing/portal
POST /api/billing/webhook
POST /api/auth/forgot-password
POST /api/auth/reset-password

{
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}