Skip to main content
Lumin
Previewv0.1.0
27 actions · 10 events · 2 auth methods
Documents

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile

No app registration required. The key is generated by a Workspace Owner and acts on that Workspace, and up to 4 keys can…

OAuth 2.0 · Connector Profile

Requires registering a private OAuth app in Lumin. Access tokens expire after one hour and are refreshed using the offli…
Optionally, configure receiving Events for Lumin into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account

OAuth 2.0 · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
|
27 actions
Action
Description
Required scopes
Create Agreement
Create a new AgreementGen document from a AgreementGen template.
Get Agreement File
Obtain a downloadable file or binary PDF data from an AgreementGen document.
Create Document
Create and save a PDF file in the user’s Workspace.
Merge Documents
Merge multiple documents into a single PDF file and return a temporary download URL.
Compress Document
Compress a PDF document to reduce its file size and return a temporary download URL.
Split Document
Split or extract pages from a PDF document into one or more output files and return a temporary download URL.
Add Password
Add or change password protection on a PDF document and return the encrypted file as a temporary download URL.
Remove Password
Remove password protection from a PDF document and return the unprotected file as a temporary download URL.
Summarize Document
Generate a concise AI-powered summary of a PDF document’s text content.
Translate Document
Translate a PDF document into a target language while preserving the original formatting, layout, and images.
Get Signature Request
Returns the information of the signature request.
Update Signature Request
Update the due date of an existing signature request.
Send Signature Request
Creates and sends a new signature request with the submitted documents.
Send Signature Request From Template
Creates and sends a new signature request from a template with the submitted template data.
Get Signing Link
Returns a signing link for an existing signature request. This enables presenting signing links within your own applicat…
Create Signing Session
Returns a short-lived embedded-signing session URL (sign_url) for a single recipient on an existing signature request…
Cancel Signature Request
Cancel a signature request.
Send Reminder Emails
Send reminder emails to selected signers under a signature request whose signer status is NEED_TO_SIGN.
Get Signature Request File
Obtain the file of the Signature Request by id. This endpoint supports returning different types of files: - The agreeme…
List Templates
Returns a paginated list of templates in a Lumin Workspace, including AgreementGen, Sign and PDF templates.
Get Template Details
Returns essential template details for a specific template.
Generate Document From Template
Creates a downloadable PDF document from an existing Lumin template.
Get User Information
Get information of current user
Get Workspace Information
Return information of the authorized Workspace.
Get Workspace Members
Return a paginated list of members in a Workspace.
List Spaces
Return a paginated list of Spaces within the authorized Workspace.
Create Space
Create a new Space within the authorized Workspace.

​
Events

|
10 events
Event
Description
Tags
Signature Request Created
Fires on the Lumin signature_request_created event.
Signature RequestsWebhooks
Signature Request Viewed
Fires on the Lumin signature_request_viewed event.
Signature RequestsWebhooks
Signature Request Signed
Fires on the Lumin signature_request_signed event.
Signature RequestsWebhooks
Signature Request Approved
Fires on the Lumin signature_request_approved event.
Signature RequestsWebhooks
Signature Request Declined
Fires on the Lumin signature_request_declined event.
Signature RequestsWebhooks
Signature Request Downloadable
Fires on the Lumin signature_request_downloadable event.
Signature RequestsWebhooks
Signature Request Invalid
Fires on the Lumin signature_request_invalid event.
Signature RequestsWebhooks
Signature Request Canceled
Fires on the Lumin signature_request_canceled event.
Signature RequestsWebhooks
Signature Request Cancel Failed
Fires on the Lumin signature_request_cancel_failed event.
Signature RequestsWebhooks
Signature Request Due Date Updated
Fires on the Lumin signature_request_due_date_updated event.
Signature RequestsWebhooks