Skip to main content

API Playground

Overview​

The API Playground lets you test the document generation API without writing code. Perfect for exploring templates and debugging issues.

Modes​

Single Document​

Generate one document at a time:

  1. Select an API key for authentication
  2. Choose a template
  3. Select output format (PDF or Excel)
  4. Fill in variable values
  5. Click Generate Document

Batch Generation​

Generate multiple documents in one request:

  1. Set up the template and format
  2. Add multiple documents with different variable values
  3. Click Generate Batch

Job Status​

Check the status of a document generation job:

  • Enter a Job ID to query its current status
  • View completion percentage and download URL

Batch Status​

Check the status of a batch generation:

  • Enter a Batch ID to see overall progress
  • View individual document statuses within the batch

Features​

Variable Editor​

  • Edit variables inline or in the full editor sheet
  • See all template variables with their types
  • Reset to default values when needed

Code Samples​

View ready-to-use code in multiple languages:

  • cURL commands
  • Node.js/JavaScript
  • Python
  • And more

Response Viewer​

  • See the full API response
  • Copy response data
  • View job IDs for status tracking

Tips​

  • Use draft templates for testing before publishing
  • The code samples update as you change settings
  • Check job status for async generation results