Skip to main content
Version: 1.0.0

Propper Gen API

Document Generation API for the Propper Platform.

Base URL

  • Production: https://api.propper.ai/v1/docgen

Authentication

OAuth 2.0 Bearer token:

Authorization: Bearer <access_token>

OAuth Scopes

ScopeDescription
docgen:readRead templates, documents, batches, approvals
docgen:writeCreate/update templates, generate documents, create batches
docgen:adminArchive/promote templates, cancel/retry batches, review approvals
docgen:previewRender a template for review without generating a document. Standalone: not implied by docgen:read/write/admin

Granular Scopes

ScopeDescription
docgen:templates:readRead templates
docgen:templates:writeCreate/update templates
docgen:documents:readRead documents
docgen:documents:writeGenerate documents
docgen:batches:readRead batch jobs
docgen:batches:writeCreate batch jobs
docgen:approvals:readRead approvals
docgen:approvals:writeReview approvals

Key Endpoints

  • GET /v1/docgen/templates - List templates
  • POST /v1/docgen/templates - Create template
  • POST /v1/docgen/templates/{id}/preview - Preview a template without generating a document
  • POST /v1/docgen/documents - Generate document
  • POST /v1/docgen/batches - Create batch job
  • GET /v1/docgen/approvals/pending - List pending approvals

Rate Limits

CategoryLimit
Default300 req/min
Document Generation60 req/min
Template Preview120 req/min
Batch Creation20 req/min
Downloads120 req/min

Request correlation

Every response (success and error) includes an x-request-id header (a UUID) and a traceparent header (W3C Trace Context). Error bodies also carry the same id as requestId. Quote x-request-id when contacting support to pinpoint the exact request, and use it to correlate the API with your own logs. Send your own traceparent to tie a multi-call workflow under one trace.

Authentication

OAuth 2.0 access token

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT