For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact us
DocumentationAPI Reference
DocumentationAPI Reference
  • Get started
    • Introduction
    • Authentication
    • Concepts
    • Quickstart
    • Errors
Contact us
LogoLogo
On this page
  • How LumenOne is structured
  • What’s next
Get started

Introduction

Programmatic access to your LumenOne instance.
Was this page helpful?

Authentication

API keys, account context, and how to obtain credentials.
Next
Built with

The LumenOne API lets your company read, write, and update your LumenOne data programmatically. With it you can:

  • Manage organizations and workspaces
  • Upload and organize documents, then embed them into workspaces
  • Provision and manage phone numbers and number requests
  • Drive RAG/agent workflows from external systems (iPaaS, CRMs, custom apps)

How LumenOne is structured

LumenOne is multi-tenant. From the top down:

  • Partner — your company. The API key owner. (Internally LumenOne calls API-key holders “partners”.)
  • Account — a customer container under your company. Identified by a UUID, passed via the X-Account-Id header.
  • Organization — a tenant inside an account. Identified by a slug.
  • Workspace — an isolated chat/RAG environment inside an organization. Has its own documents, settings, and threads.
  • Document — a file uploaded into an organization’s storage, optionally embedded into one or more workspaces.

Most endpoints are scoped to an organization (/v1/org/{orgSlug}/...) and require both an API key and an X-Account-Id header.

What’s next

  • Authentication — how to get and use an API key
  • Concepts — slugs, docpaths, and the company/account/org hierarchy
  • Quickstart — your first end-to-end request