v1

latestOpenAPI 3.1.02026-08-06244570.4 KB
PDF Async

Get PDF job status

Get the current status of an async PDF generation job.

Authentication: API Key required (x-api-key header)

Status Values

StatusDescription
pendingJob is queued, waiting to be processed
processingJob is being processed
completedPDF generated successfully
failedJob failed (check error_message)

Polling Recommendations

  • Poll every 1-2 seconds for small documents
  • Poll every 5-10 seconds for large documents
  • Consider using webhooks instead of polling
get/v1/pdf/jobs/{job_id}

Path parameters

job_idstring required

Async job ID (UUID returned by the create-async endpoint)

Async job ID (UUID returned by the create-async endpoint)

Response

Job status retrieved

idstring required

Job ID

status'pending' | 'processing' | 'completed' | 'failed' required

PDF job status values

template_idstring required

Template used for generation

export_typestring required

Export type (url)

filenamestring nullable

Custom filename if provided

store_s3boolean required

Whether S3 storage was requested

created_atstring required

Job creation timestamp (ISO 8601)

updated_atstring required

Last update timestamp (ISO 8601)

completed_atstring nullable

Completion timestamp (ISO 8601)

result_urlstring nullable

Signed URL to download PDF

result_filenamestring nullable

Final filename

result_expires_atstring nullable

URL expiration (ISO 8601)

result_s3_bucketstring nullable

S3 bucket (if store_s3)

result_s3_keystring nullable

S3 object key (if store_s3)

error_messagestring nullable

Error description if failed

error_codestring nullable

Error code if failed