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

Error Codes

Overview

This page documents error codes returned by the Build a Doc connector and how to resolve them.

HTTP Status Codes

Client Errors (4xx)

CodeNameDescriptionResolution
400Bad RequestInvalid request format or parametersCheck request structure and parameter values
401UnauthorisedInvalid or missing API keyVerify API key is correct and active
403ForbiddenSubscription lacks permissionCheck subscription plan and feature access
404Not FoundResource or action not foundVerify action name and endpoint
429Too Many RequestsRate limit exceededReduce request frequency; implement backoff

Server Errors (5xx)

CodeNameDescriptionResolution
500Internal Server ErrorUnexpected server errorRetry; contact support if persistent
502Bad GatewayGateway/proxy errorRetry after brief delay
503Service UnavailableService temporarily unavailableRetry with exponential backoff
504Gateway TimeoutRequest timed outRetry; consider smaller documents

Authentication Errors

401 - Invalid API Key

Message: Invalid API key or API key not found

Causes:

  • API key is missing
  • API key is incorrect (typo or truncated)
  • API key has been revoked

Resolution:

  1. Copy API key directly from portal (don’t type manually)
  2. Verify no extra spaces before or after the key
  3. Confirm key is active in the portal
  4. Create a new key if necessary

401 - Expired API Key

Message: API key expired

Causes:

  • Key has been revoked
  • Subscription has lapsed

Resolution:

  1. Check key status in portal
  2. Verify subscription is active
  3. Create new key if needed

Authorisation Errors

403 - Feature Not Available

Message: Feature not available for your subscription

Causes:

  • Action requires higher tier plan
  • Feature is not included in current plan

Resolution:

  • Review your subscription plan features
  • Upgrade plan if necessary

403 - Quota Exceeded

Message: Monthly quota exceeded

Causes:

  • Document generation quota reached
  • API call limit reached

Resolution:

  • Wait for quota reset (next billing cycle)
  • Upgrade to higher plan

Rate Limiting Errors

429 - Rate Limit Exceeded

Message: Rate limit exceeded. Retry after X seconds

Causes:

  • Too many requests in short time period
  • Burst limit exceeded

Resolution:

  1. Implement retry logic with exponential backoff
  2. Add delays between requests
  3. Consider batch processing at lower rate
  4. Upgrade plan for higher limits

Document Processing Errors

Document Invalid

Message: Document is invalid or corrupted

Causes:

  • File is corrupted
  • File is not the declared format
  • File is password-protected

Resolution:

  • Verify file opens correctly locally
  • Ensure correct file format
  • Remove password protection

Template Error

Message: Template syntax error at position X

Causes:

  • Invalid template expression
  • Unclosed tags
  • Malformed syntax

Resolution:

  • Check template syntax
  • Enable inline errors for debugging
  • Use template preview in Word Add-in

Data Source Error

Message: Invalid data source format

Causes:

  • JSON/XML/CSV syntax error
  • Mismatched data source format declaration

Resolution:

  • Validate data source format
  • Ensure format declaration matches actual format

Timeout Errors

Request Timeout

Message: Request timed out

Causes:

  • Document too large
  • Complex template processing
  • High service load

Resolution:

  • Reduce document complexity
  • Split large documents
  • Retry at different time

Error Response Format

Error responses include:

{
  "error": {
    "code": "ErrorCode",
    "message": "Human-readable error description",
    "details": [
      {
        "code": "DetailCode",
        "message": "Specific detail"
      }
    ]
  }
}