API Reference

The LVNG REST API lets you programmatically interact with every part of the platform. Manage agents, orchestrate workflows, send messages, and build intelligent applications with a consistent, well-documented interface.

Base URL

All API requests are made to the following base URL. HTTPS is required for all requests.

https://api.lvng.ai/api

Versioning

The API is versioned via path prefix. The current version is v2.

Current version. All features land here.

Content Type

All requests and responses use JSON. Set the Content-Type header on every request that includes a body.

Content-Type: application/json

Authentication

All endpoints require a Bearer token in the Authorization header. You can generate API keys from the Settings page in the LVNG dashboard.

Authenticated request

curl -X GET https://api.lvng.ai/api/v2/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Requests without a valid token receive a 401 Unauthorized response.

Response Format

All responses follow a consistent envelope structure. Successful responses include a data field. Error responses include an error field with a human-readable message.

Success response

{
  "success": true,
  "data": {
    "id": "agt_a1b2c3d4",
    "name": "Research Agent",
    "status": "active"
  }
}

Error response

{
  "success": false,
  "error": "Agent not found"
}

Rate Limiting

API requests are rate-limited per API key. Rate limit information is returned in response headers.

Rate limit headers

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 997
X-RateLimit-Reset: 1711843200

If you exceed the limit, you will receive a 429 Too Many Requests response. Wait until the reset timestamp before retrying.

API Resources

Chat

2 endpoints

Send messages to AI and stream responses via Server-Sent Events.

Messages

12 endpoints

Create, read, update, and delete messages within channels. Threads, reactions, file uploads, and AI summarization.

Channels

17 endpoints

Manage channels, members, digital twins, and pinned messages.

Workspaces

16 endpoints

Manage workspaces, team members, roles, permissions, and settings.

Agents

11 endpoints

Create, configure, and control AI agents with custom capabilities and tools.

OODA Loop

3 endpoints

Run iterative Observe-Orient-Decide-Act reasoning cycles for goal-directed analysis.

Workflows

16 endpoints

Build, execute, and schedule multi-step automation workflows.

Digital Twins

5 endpoints

Add and manage AI personas (digital twins) in your workspace.

Artifacts

12 endpoints

Store and manage AI-generated artifacts with versioning and review.

Knowledge

11 endpoints

Ingest, search, and analyze content across a unified knowledge graph.

Canvas

7 endpoints

Visual canvas cards and folders for spatial organization.

Calendar

6 endpoints

Unified calendar across Google and Microsoft with event CRUD and availability.

Voice Notes

7 endpoints

Audio recording, transcription via Whisper, and voice note management.

Search

1 endpoints

Unified semantic search across notes, channels, messages, and knowledge.

Settings

7 endpoints

User and workspace settings with import/export support.

Integrations

11 endpoints

Platform integrations for Discord, Slack, and Teams with channel sync.

Conversations

10 endpoints

Direct messages, group conversations, read receipts, and member management.

API Keys

5 endpoints

Generate, manage, rotate, and revoke per-user API keys for programmatic access and Claude Code.

Invitations

5 endpoints

Create, list, revoke, and accept workspace invitations with secure token-based links.

Emails

6 endpoints

Send, track, and preview emails with shareable public links and delivery status.

Billing

12 endpoints

Credit balance, usage charts, auto-reload, payment methods, invoices, and spending alerts.

Contacts

10 endpoints

CRM-like contact management with relationship graphs, interaction history, and auto-extraction.

Analytics

4 endpoints

Tool usage analytics, error tracking, model usage breakdowns, and cost estimation.

Developer

8 endpoints

Webhooks, per-key usage analytics, delivery logs, and developer event logs.

Platform Connections

6 endpoints

Connect, configure, and manage external platform integrations with history import.

MCP Servers

8 endpoints

Activity

4 endpoints

User activity feed synthesized from AI conversations, workflow executions, and system events.

Onboarding

8 endpoints

User onboarding flow with profile setup, invitation handling, and workspace creation.

Preferences

3 endpoints

User AI mode preferences for configuring model behavior globally or per-workspace.

HTTP Methods

The API uses standard HTTP methods for CRUD operations.

Method	Description
GET	Retrieve a resource or list of resources
POST	Create a new resource or trigger an action
PUT	Replace a resource entirely
PATCH	Partially update a resource
DELETE	Remove a resource

Pagination

List endpoints support cursor-based pagination using limit and before parameters. The default page size is 50 items. Maximum is 100.

Paginated request

curl -X GET "https://api.lvng.ai/api/v2/messages?channel_id=ch_abc123&limit=25&before=2026-03-01T00:00:00Z" \
  -H "Authorization: Bearer YOUR_API_KEY"