Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.fileloom.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Workspaces

A workspace is your isolated environment in Fileloom. Everything belongs to a workspace: templates, files, API keys, team members, and billing.
When you sign up, a default workspace is created automatically. You can create additional workspaces to separate projects or clients.
Key points:
  • Each workspace has its own API keys, templates, and usage quota
  • Team members can be invited with different roles (owner, editor, viewer)
  • Billing and subscription are per-workspace
  • Switch between workspaces using the dropdown in the dashboard sidebar

​
Templates

Templates are reusable HTML documents with Handlebars placeholders for dynamic content. 
<div class="invoice">
  <h1>Invoice #{{invoiceNumber}}</h1>
  <p>Customer: {{customer.name}}</p>
  <p>Total: {{currency total "USD"}}</p>
</div>
Template components:
ComponentDescription
HTMLThe document structure and content
CSSStyling (inline or in a separate tab)
Test DataSample JSON for preview
SettingsPaper size, margins, orientation, headers/footers
Template lifecycle:
  1. Draft — Work in progress, auto-saved
  2. Published — Available for API use, version tracked
  3. Versions — Each publish creates a new version you can reference or rollback

​
Handlebars Templating

Fileloom uses Handlebars for dynamic content. Basic syntax: 
{{! Variable output }}
{{variableName}}

{{! Nested objects }}
{{customer.address.city}}

{{! Helpers with arguments }}
{{currency amount "EUR"}}
{{formatDate date "MMMM D, YYYY"}}

{{! Conditionals }}
{{#if isPaid}}
  <span class="paid">PAID</span>
{{else}}
  <span class="unpaid">UNPAID</span>
{{/if}}

{{! Loops }}
{{#each items}}
  <tr>
    <td>{{this.name}}</td>
    <td>{{currency this.price "USD"}}</td>
  </tr>
{{/each}}
Fileloom provides 70+ built-in helpers for formatting, math, dates, and business logic. See the Helpers Reference.

​
API Keys

API keys authenticate your requests to the Fileloom API. Format: fl_xxxxxxxxxxxx Best practices:
  • Create separate keys for different environments (development, staging, production)
  • Rotate keys periodically
  • Never expose keys in client-side code
  • Use environment variables to store keys
Authentication methods: 
# Header (recommended)
X-API-Key: fl_your_api_key

# Bearer token
Authorization: Bearer fl_your_api_key

​
Credits & Quota

Fileloom uses a credit system for PDF generation: Monthly Quota:
  • Each plan includes a monthly PDF allowance
  • Quota resets on your billing date
  • Unused quota does not roll over
Credit Packs:
  • Purchase additional credits when you need more
  • Credits are consumed after monthly quota is exhausted
  • Credits expire 90 days after purchase
  • Consumed in FIFO order (oldest first)
Consumption order:
  1. Monthly quota (from your plan)
  2. Purchased credit packs (oldest expiring first)
  3. Hard block when no credits remain

​
Files

Every generated PDF is stored as a file in your workspace. File properties:
PropertyDescription
fileIdUnique identifier (e.g., file_1234567890_abc123)
urlPermanent public URL
signedUrlTemporary secure URL (24 hours)
filenameOriginal or generated filename
sizeFile size in bytes
statusgenerated, expired, or deleted
Retention:
  • Files are retained based on your plan (7 days to 365 days)
  • After retention period, files are automatically deleted
  • You can manually delete files at any time

​
Storage Options

By default, Fileloom stores your PDFs in Firebase Storage. You can also configure external storage: Storage modes:
ModeBehavior
fileloomStore in Fileloom only (default)
externalStore in your S3/Supabase only
bothStore in both Fileloom and external
See Integrations to set up AWS S3 or Supabase storage.

​
Webhooks

Webhooks notify your server when events occur in Fileloom. Available events:
EventTrigger
pdf.generatedPDF successfully created
pdf.failedPDF generation failed
Webhook payloads include file details, processing time, and error information (for failures). See Webhooks for setup instructions.

​
Rate Limits

API requests are rate-limited based on your plan:
PlanRequests per Minute
Free60
Starter120
Growth200
Scale400
Scale Business1,000
Scale EnterpriseUnlimited
Rate limit headers are included in every response: 
X-RateLimit-Limit: 200
X-RateLimit-Remaining: 198
X-RateLimit-Reset: 1734012400

​
Plan Limits Summary

Each plan has limits on resources beyond PDF generation:
ResourceFreeStarterGrowthScale
PDFs/month2002,00010,00050,000
Templates550UnlimitedUnlimited
Team Members23510
API Keys12510
Retention7 days30 days90 days180 days
Max HTML Size2 MB5 MB10 MB50 MB
Max PDF Size10 MB25 MB50 MB50 MB
Timeout15s30s45s120s
See Plans & Pricing for full details.

​
Next Steps

API Reference

Complete API documentation

Template Helpers

70+ built-in formatting helpers

Dashboard Guide

Navigate the Fileloom dashboard

Best Practices

Tips for production templates