API Reference

Use our REST API to upload templates, generate documents, and download them as .docx or .pdf. All endpoints require authentication via an API key.

Base URL

All the API requests are made to the following base URL:

https://docubloom.com/api/

Authentication

We use API keys to authenticate requests. You can create and manage your API keys in your organization settings. Make sure to keep your API key secure and do not expose it in client-side code.

All requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Your first API request

Once you have your API key, you can start making requests. Below is a simple example of how to get your list of templates using the GET /template/list endpoint:

curl -X GET https://docubloom.com/api/template/list \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

[
  {
    "key": "my-template-key",
    "name": "My Template",
    "usage": 271,
    "createdAt": "2025-01-01T15:31:10.021Z",
    "updatedAt": "2025-01-01T21:48:56.425Z",
    "lastUsed": "2025-04-07T09:12:34.712Z"
  },
 ...
]

Rate Limits

We enforce rate limits to ensure fair usage. If you exceed this limit, you will receive a 429 Too Many Requests response. The default limit on the document generation endpoint is 200 requests per minute. Other endpoints may have different limits.

Note that rate limits are applied per organization, not per API key. If you need higher limits, you can contact our support team to discuss options.

Error Handling

Errors follow standard HTTP status codes.

The response body will contain a JSON object with an error field describing the issue:

{
  "error": "Template not found"
}

Next Steps

Now that you have the basics, you can explore the available endpoints in detail.

In particular, check out our endpoint to generate documents from templates: POST /template/generate.