Integration Quickstart

import fs from 'fs/promises';

/**
 * Quickstart: Generate a Non-Disclosure Agreement
 */
async function generateAgreement() {
  const apiKey = process.env.LAWYERED_API_KEY;

  if (!apiKey) {
    console.error("Missing LAWYERED_API_KEY environment variable.");
    return;
  }

  // 1. Construct the payload matching the template schema.
  //    Note: `parties` is a required array — agreement templates will fail
  //    to generate if required arrays are missing or empty.
  const payload = {
    templateId: "non-disclosure-agreement",
    format: "pdf",
    data: {
      project: "System Architecture Review",
      ndaDuration: "24 months",
      governingLaw: "Nigeria",
      parties: [
        {
          isCompany: true,
          rcName: "Acme Corp",
          rcCountry: "United States",
          rcNumber: "12345678",
          type: "Private Company limited by shares"
        },
        {
          isCompany: false,
          fullName: "Joshua",
          address: "789 Alpha Ave",
          rcCountry: "Nigeria"
        }
      ]
    }
  };

  try {
    console.log("Generating document...");

    // 2. Call the Document Generation endpoint
    const response = await fetch('https://api.lawyeredapp.com/api/v1/documents/generate', {
      method: 'POST',
      headers: {
        'X-Key': apiKey,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(payload),
    });

    if (!response.ok) {
      // Error responses are JSON. See "Error responses" below for the shapes.
      const errorData = await response.json();
      throw new Error(`API Error ${response.status}: ${JSON.stringify(errorData, null, 2)}`);
    }

    // 3. Handle the binary response and save to disk
    const arrayBuffer = await response.arrayBuffer();
    const buffer = Buffer.from(arrayBuffer);

    const fileName = `./Acme_NDA_${Date.now()}.pdf`;
    await fs.writeFile(fileName, buffer);

    console.log(`Success! Document saved as ${fileName}`);

  } catch (error) {
    console.error('Failed to generate document:\n', error);
  }
}

generateAgreement();

import os
import requests

def generate_agreement():
    api_key = os.getenv("LAWYERED_API_KEY")
    if not api_key:
        print("Error: Missing LAWYERED_API_KEY environment variable.")
        return

    url = "https://api.lawyeredapp.com/api/v1/documents/generate"

    headers = {
        "X-Key": api_key,
        "Content-Type": "application/json"
    }

    # 1. Construct the payload matching the template schema.
    #    Note: `parties` is a required array — agreement templates will fail
    #    to generate if required arrays are missing or empty.
    payload = {
        "templateId": "non-disclosure-agreement",
        "format": "pdf",
        "data": {
            "project": "System Architecture Review",
            "ndaDuration": "24 months",
            "governingLaw": "Nigeria",
            "parties": [
                {
                    "isCompany": True,
                    "rcName": "Acme Corp",
                    "rcCountry": "United States",
                    "rcNumber": "12345678",
                    "type": "Private Company limited by shares"
                },
                {
                    "isCompany": False,
                    "fullName": "Joshua",
                    "address": "789 Alpha Ave",
                    "rcCountry": "Nigeria"
                }
            ]
        }
    }

    try:
        print("Generating document...")

        # 2. Call the Document Generation endpoint
        response = requests.post(url, headers=headers, json=payload)
        response.raise_for_status()

        # 3. Handle the binary response and save to disk
        file_name = "Acme_NDA_Generated.pdf"
        with open(file_name, "wb") as f:
            f.write(response.content)

        print(f"Success! Document saved as {file_name}")

    except requests.exceptions.HTTPError as err:
        print(f"API Error: {err}")
        print(response.json())
    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    generate_agreement()