Skip to content

v1.6.0

Choose a tag to compare

@vincentventalon vincentventalon released this 15 Feb 21:23
· 12 commits to main since this release

What's New

  • PDF job status endpoint: Get the current status of async PDF generation jobs using GET /v1/pdf/jobs/{job_id}. Response includes status (pending, processing, completed, failed) and error_message on failure. API key required in the x-api-key header.
  • Polling guidance: Poll every 1–2 seconds for small documents and every 5–10 seconds for large documents while waiting for completion.
  • Endpoint rename / migration: Replace calls to GET /v1/pdf/status/{job_id} with GET /v1/pdf/jobs/{job_id} to align with REST conventions; update integrations accordingly.

API Changes

New Endpoints:

  • GET /v1/pdf/jobs/{job_id} - Get status of an async PDF job (pending, processing, completed, failed). Require x-api-key header. Use for polling until completion or failure.

Removed Endpoints:

  • GET /v1/pdf/status/{job_id} - Removed (renamed to /v1/pdf/jobs/{job_id}); update any existing client code.

Generated from TemplateFox API v1.6.0