Skip to main content
POST
/
agreements
Create Agreement
curl --request POST \
  --url https://api.luminpdf.com/v1/agreements \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "method": "template",
  "agreement_name": "NDA Agreement",
  "agreement_data": {
    "template_id": "ag_12312321",
    "fields": {
      "Client.Name": "Acme Corp",
      "Document.EffectiveDate": "2025-08-01"
    },
    "variables": {
      "Client.Name": "Acme Corp",
      "Document.EffectiveDate": "2025-08-01"
    },
    "linked_objects": [
      {
        "integration": "your_integration",
        "entity_type": "opportunity",
        "record_id": "0065g00000Vh123ABC",
        "reference_url": "https://your-crm-instance.example.com/record/001XXXXXXXXX"
      }
    ]
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "created_at": 123,
  "preview_url": "<string>",
  "linked_objects": [
    {
      "integration": "<string>",
      "entity_type": "<string>",
      "record_id": "<string>",
      "reference_url": "<string>"
    }
  ]
}

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.

Authorizations

X-API-Key
string
header
required

Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.

Body

application/json
method
enum<string>
required

Must be set to template.

Available options:
template
agreement_data
object
required
agreement_name
string

Human-friendly title of the agreement (1-255 chars). Defaults to input name or "New document" if not provided in the request body.

Required string length: 1 - 255

Response

Returns the Agreement summary object data

id
string
required

The unique identifier for the agreement.

name
string
required

The name of the agreement.

created_at
integer<unix-epoch>
required

The time the agreement was created (Unix timestamp in milliseconds).

preview_url
string<uri>

The URL to preview the agreement in the browser.

linked_objects
object[]

CRM or external objects linked to the agreement.