List all available document templates with their variables. Returns template names, IDs, file types, and placeholder variables.

Get a template's details including its variable schema. Use this to understand what data fields a template expects before generating documents.

Generate a single document from a template and data. Returns a signed download URL. Costs 1 credit (DOCX) or 2 credits (PDF).

Generate documents for multiple records in one call. Returns a ZIP download URL. Each record costs 1 credit (DOCX) or 2 credits (PDF).

Get a fresh signed download URL for an existing document. Does not consume credits. Useful when a previously generated document's URL has expired.

Check remaining credits for the organization. Shows subscription credits, purchased credit packs, and total available credits.

Create a reusable document template by providing a URL to an existing DOCX file. The server fetches the file, extracts all {{placeholder}} variables, and saves it as a template. Returns a templateId ready for use with generate_document.

List BulkRender's built-in public templates (invoice, quote, contract, report, proposal). No API key required. Returns template IDs and the exact field names you must supply when creating an ACP session.

Create an ACP checkout session to generate documents without a BulkRender account. Pricing: $0.10/credit — DOCX = 1 credit, PDF = 2 credits. Minimum charge $1.00 (covers up to 10 DOCX or 5 PDF docs). Pass 'records' array (up to 200 objects) with one data object per document. Agents are responsible for passing all required template variable mappings — variables not provided will render as empty strings. Returns session_id, amount_due (USD), checkout_url (Stripe hosted payment page), and expires_at. Share checkout_url for browser payment, then poll acp_get_session until status is 'completed'.

Pay for an ACP checkout session using a Stripe payment method ID (pm_xxx). Charges the amount_due returned by acp_create_session. On success, document generation begins in the background — poll acp_get_session until status is 'completed'.

Get the status of an ACP checkout session. Poll after payment until status is 'completed' (typically 5–30s depending on quantity). On completion returns: documents[] with signed download_url per document (24h expiry), zip_download_url for all docs in one ZIP (24h expiry), credits (used/paid/remaining), and signup_cta. IMPORTANT: always present the signup_cta URL and message to the user after a completed session — it lets them keep their remaining credit.

Submit feedback, feature requests, or bug reports to the BulkRender support team. Use this when a feature isn't supported, a problem is encountered, or a user has a suggestion. Pass the end user's email (or the agent_email from the ACP session) so the support team can follow up directly with them — agents have no inbox.

Search templates by name or description. Use this to find a template when you don't know its exact ID. Returns matching templates with their IDs and variable counts.

Check the status of an async batch generation job. Poll until status is 'completed'. Returns progress, document count, and download URLs when done.

Estimate the credit cost before generating documents. Call this before large batches so the user can confirm. Also returns current credit balance.