Skip to content
Build a Doc
Home Documentation Support
This documentation is currently in preview, therefore subject to change.

Frequently Asked Questions

Connection and Setup

How do I create a connection to Build a Doc?

When you add a Build a Doc action to your flow for the first time, you’ll be prompted to create a connection. Enter your API key from the Customer Portal to authenticate.

Where do I get my API key?

API keys are available in the Build a Doc Customer Portal. Navigate to the API Keys section after logging in.

For detailed instructions, see Manage API Keys.

Can I use multiple API keys?

Yes, you can create multiple API keys for different environments or applications. Manage your keys in the Customer Portal.

For more information on API key management and best practices, see Manage API Keys and API Key Rules.

Templates

What template formats are supported?

Build a Doc supports a range of template types. Supported input extensions and typical output formats are listed below - exact output formats depend on the specific action and options. See the Connector Overview and the Actions Reference for per-action details.

Template TypeInput ExtensionsOutput Formats
Word.doc, .docxpdf, docx, html, svg, jpeg, png, bmp, gif, tiff
Excel.xls, .xlsxxlsx, csv, tsv, html, mhtml, pdf, svg, tiff
PowerPoint.ppt, .pptxpptx, pdf, jpeg, png
HTML.html, .htmhtml, pdf, images
OneNote.onepdf, html, images
Visio.vsd, .vsdxpdf, svg, png, jpeg
PDF (templates).pdfimages (jpeg, png), pdf

Where should I store my templates?

Templates can be stored in any location accessible to Power Automate:

  • SharePoint document libraries
  • OneDrive for Business

For best practices on template storage and organisation, see Publishing Templates to Production.

How do I test my templates?

Use the Build a Doc Word Add-in to test templates directly in Word:

  1. Install the add-in from AppSource
  2. Open your template
  3. Enter sample JSON data
  4. Click Preview to see results

For detailed guidance on template testing, see Preview Templates with Sample Data.

Subscriptions and Billing

What subscription plans are available?

PlanDocument ActionsUtility Actions
Free50 per month50 per month
Standard500 per month5,000 per month
Midsize1,200 per month10,000 per month
Large5,000 per month100,000 per month
EnterpriseCustomCustom

For current pricing, support details, and to upgrade, see the Customer Portal. For more information about plan features and limits, see Subscription Plans.

How do I upgrade my subscription?

  1. Log in to the Customer Portal
  2. Go to Subscription settings
  3. Select your new plan
  4. Complete the payment process

For detailed instructions, see Manage Your Subscription Plan.

What happens if I exceed my quota?

If you exceed your monthly document quota:

  • Requests will return a quota exceeded error
  • Upgrade your plan for additional capacity
  • Wait for the next billing cycle for quota reset

For more information, see Limits and Quotas.

Errors and Troubleshooting

I’m getting an authentication error

Check the following:

  1. Verify your API key is correct and active
  2. Ensure your subscription hasn’t expired
  3. Check that the API key hasn’t been revoked

For more information on authentication, see Authenticate the Connector.

My document generation is failing

Common causes include:

  1. Invalid template syntax - Check for unclosed tags
  2. Missing data fields - Ensure JSON includes all required fields
  3. File too large - Check your plan’s file size limit

For comprehensive troubleshooting guidance, see the Troubleshooting Guide and Handle Errors in Flows.

The output looks wrong

Try these steps:

  1. Preview the template using the Word Add-in
  2. Verify JSON data structure matches template expectations
  3. Check for formatting issues in the template

For more help with template issues, see Debug Template Validation Errors.

Word Add-in

How do I install the Word Add-in?

  1. Open Microsoft Word
  2. On the Home Ribbon, Go to Insert → Get Add-ins
  3. Search for “Build a Doc”
  4. Click Add to install

For more information on using the Word Add-in, see Author Advanced Word Templates.

The Add-in isn’t loading

Try these troubleshooting steps:

  1. Restart Microsoft Word
  2. Clear the Office cache
  3. Ensure you have a stable internet connection
  4. Check Compatibility Requirements

Can I use the Add-in offline?

No, the Add-in requires an internet connection to:

  • Validate templates
  • Generate previews
  • Access the Build a Doc service

For more details on Add-in requirements, see Word Add-in Compatibility.

Data and Security

Is my data secure?

Yes. Build a Doc:

  • Uses TLS encryption for all data in transit
  • Does not store your documents after processing
  • Maintains audit logs for compliance

Where is my data processed?

Document processing occurs in secure Azure data centres. See Privacy and Data Handling for details.

Can I use Build a Doc with sensitive data?

Build a Doc is designed for secure document generation. However, you should:

  1. Review your organisation’s data policies
  2. Use appropriate network security
  3. Consider data residency requirements

For more information about security measures, see Security and Data Protection.

Integration

Can I use Build a Doc with Power Apps?

Yes, you can call Power Automate flows containing Build a Doc actions from Power Apps.

For guidance on getting started with Power Apps, see Power Apps Getting Started Guide.

Does Build a Doc work with Dynamics 365?

Yes, Build a Doc integrates well with Dynamics 365 through Power Automate.

For more information on integration patterns, see Supported Integration Patterns.

Can I call Build a Doc from custom applications?

The connector is designed for Power Platform use. For custom application integration, use Power Automate as the intermediary.

For more details on integration approaches, see Supported Integration Patterns.

Still Have Questions?

If your question isn’t answered here: