Base URL & Versioning

Base URL

All API requests are made to:

https://api.docpayload.com/v1

API versioning

The API version is included in the URL path. The current version is v1.

When breaking changes are introduced, a new version will be released (e.g., v2). Previous versions remain available for a deprecation period with advance notice.

Request format

All request bodies must be JSON with the Content-Type: application/json header.

curl -X POST https://api.docpayload.com/v1/{YOUR_TENANT_ID}/documents/generate-from-payload/pdf \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "document": { ... } }'
# { "fileName": "...", "downloadUrl": "...", "status": "Completed" }

Response format

• Document generation endpoints return JSON with fileName, downloadUrl, and status
• CRUD endpoints return application/json
• All error responses are JSON with status, message, and optional details fields

Rate limits

Plan	Requests/minute	Documents/month
Free	10	100
Pro	60	5,000
Enterprise	Custom	Custom

Rate limit headers are included in every response:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 1711843200