Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.luminpdf.com/llms.txt

Use this file to discover all available pages before exploring further.

The Lumin API lets you build document workflows — eSignatures, templates, and automation — directly into your application.
The Lumin API is a REST API that gives you programmatic access to Lumin’s document and eSignature platform. Use it to send signature requests, manage templates, create documents, work with AgreementGen, and integrate with workspace and user data. All API endpoints use standard HTTP methods, return JSON responses (except documented file downloads), and follow predictable resource-oriented URL patterns.

​
Base URLs

EnvironmentBase URL
Productionhttps://api.luminpdf.com/v1
Use the sandbox environment for development and testing. Requests to the sandbox do not trigger real emails against production workflows.

​
What you can build

Each card below opens the overview for that API area (tag), with links to every endpoint in that group.

Signature requests

Send signature requests, update due dates, cancel requests, send reminders, get signing links, and download agreements and certificates.

Agreements

Create AgreementGen documents from templates and download agreement files.

Templates

List templates, fetch template details, and generate PDFs from Sign or AgreementGen templates.

Documents

Create documents from file upload or PDF templates and organize them in your Workspace.

Workspaces

Read Workspace metadata and list members with pagination.

Users

Retrieve information about the authenticated user.

​
Get started

Quick start

Get oriented and run the docs locally, or follow your team’s onboarding steps.

Authentication

Use API keys or bearer tokens — see schemes and headers for every request.

API reference

Jump into endpoint pages with request bodies, responses, and the interactive playground.

Changelog

See what’s new and what changed in recent API releases.