> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackone.com/llms.txt > Use this file to discover all available pages before exploring further. # Lumin > How to set up the Lumin connector, plus the actions and events that are available. ![Lumin](https://stackone-logos.com/api/lumin/filled/svg) Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/lumin/changelog.md) [27 actions](#actions) · [10 events](#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](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md). **2. Configure the Connector** Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile). > [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/lumin/guides/connector-profile/api-key.md) > > No app registration required. The key is generated by a Workspace Owner and acts on that Workspace, and up to 4 keys can... > [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/lumin/guides/connector-profile/oauth-2-0.md) > > 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. > [card] [Webhooks setup](https://docs.stackone.com/connectors/lumin/guides/webhook-setup.md) **3. Link an Account** Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)). See the guide for the authentication type chosen in the Connector Profile: > [card] [API Key · Link Account](https://docs.stackone.com/connectors/lumin/guides/link-account/api-key.md) > [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/lumin/guides/link-account/oauth-2-0.md) **4. Use Actions** Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md). Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md). ## Actions Authentication type Select all | Clear API Key OAuth 2.0 No auth methods found Scopes Select all | Clear agreements pdf:files profile.read sign:requests sign:requests.read templates workspaces workspaces.read No scopes found 27 actions ActionDescriptionRequired scopes Create Agreement`lumin_create_agreement` Create a new AgreementGen document from a AgreementGen template. `agreements` Get Agreement File`lumin_get_agreement_file` Obtain a downloadable file or binary PDF data from an AgreementGen document. `agreements` Create Document`lumin_create_document` Create and save a PDF file in the user's Workspace. `pdf:files` Merge Documents`lumin_merge_documents` Merge multiple documents into a single PDF file and return a temporary download URL. `pdf:files` Compress Document`lumin_compress_document` Compress a PDF document to reduce its file size and return a temporary download URL. `pdf:files` Split Document`lumin_split_document` Split or extract pages from a PDF document into one or more output files and return a temporary download URL. `pdf:files` Add Password`lumin_add_password` Add or change password protection on a PDF document and return the encrypted file as a temporary download URL. `pdf:files` Remove Password`lumin_remove_password` Remove password protection from a PDF document and return the unprotected file as a temporary download URL. `pdf:files` Summarize Document`lumin_summarize_document` Generate a concise AI-powered summary of a PDF document's text content. `pdf:files` Translate Document`lumin_translate_document` Translate a PDF document into a target language while preserving the original formatting, layout, and images. `pdf:files` Get Signature Request`lumin_get_signature_request` Returns the information of the signature request. `sign:requests.read` Update Signature Request`lumin_update_signature_request` Update the due date of an existing signature request. `sign:requests` Send Signature Request`lumin_send_signature_request` Creates and sends a new signature request with the submitted documents. `sign:requests` Send Signature Request From Template`lumin_send_signature_request_from_template` Creates and sends a new signature request from a template with the submitted template data. `sign:requests``templates` Get Signing Link`lumin_get_signing_link` Returns a signing link for an existing signature request. This enables presenting signing links within your own applicat... `sign:requests` Create Signing Session`lumin_create_signing_session` Returns a short-lived embedded-signing session URL (`sign_url`) for a single recipient on an existing signature request.... `sign:requests` Cancel Signature Request`lumin_cancel_signature_request` Cancel a signature request. `sign:requests` Send Reminder Emails`lumin_send_reminder_emails` Send reminder emails to selected signers under a signature request whose signer status is `NEED_TO_SIGN`. `sign:requests` Get Signature Request File`lumin_get_signature_request_file` Obtain the file of the Signature Request by id. This endpoint supports returning different types of files: - The agreeme... `sign:requests.read` List Templates`lumin_list_templates` Returns a paginated list of templates in a Lumin Workspace, including AgreementGen, Sign and PDF templates. `templates` Get Template Details`lumin_get_template_details` Returns essential template details for a specific template. `templates` Generate Document From Template`lumin_generate_document_from_template` Creates a downloadable PDF document from an existing Lumin template. `templates` Get User Information`lumin_get_user_information` Get information of current user `profile.read` Get Workspace Information`lumin_get_workspace_information` Return information of the authorized Workspace. `workspaces.read` Get Workspace Members`lumin_get_workspace_members` Return a paginated list of members in a Workspace. `workspaces.read` List Spaces`lumin_list_spaces` Return a paginated list of Spaces within the authorized Workspace. `workspaces.read` Create Space`lumin_create_space` Create a new Space within the authorized Workspace. `workspaces` ## Events Tags Select all | Clear Signature Requests Webhooks No tags found 10 events EventDescriptionTags Signature Request Created`lumin_webhook_signature_request_created` Fires on the Lumin signature\_request\_created event. Signature RequestsWebhooks Signature Request Viewed`lumin_webhook_signature_request_viewed` Fires on the Lumin signature\_request\_viewed event. Signature RequestsWebhooks Signature Request Signed`lumin_webhook_signature_request_signed` Fires on the Lumin signature\_request\_signed event. Signature RequestsWebhooks Signature Request Approved`lumin_webhook_signature_request_approved` Fires on the Lumin signature\_request\_approved event. Signature RequestsWebhooks Signature Request Declined`lumin_webhook_signature_request_declined` Fires on the Lumin signature\_request\_declined event. Signature RequestsWebhooks Signature Request Downloadable`lumin_webhook_signature_request_downloadable` Fires on the Lumin signature\_request\_downloadable event. Signature RequestsWebhooks Signature Request Invalid`lumin_webhook_signature_request_invalid` Fires on the Lumin signature\_request\_invalid event. Signature RequestsWebhooks Signature Request Canceled`lumin_webhook_signature_request_canceled` Fires on the Lumin signature\_request\_canceled event. Signature RequestsWebhooks Signature Request Cancel Failed`lumin_webhook_signature_request_cancel_failed` Fires on the Lumin signature\_request\_cancel\_failed event. Signature RequestsWebhooks Signature Request Due Date Updated`lumin_webhook_signature_request_due_date_updated` Fires on the Lumin signature\_request\_due\_date\_updated event. Signature RequestsWebhooks This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.