ayanPDF
Sign in Create account
BayanPDF

Start integration with clear steps

The API is designed to be testable, secure, and understandable for developers.

Start with tools View plans
Core endpoints
  • POST /api/v1/jobs - Create a PDF job from a file and tool options.
  • GET /api/v1/jobs/{id} - Read status, progress percent, and error message when available.
  • GET /api/v1/jobs/{id}/download - Download the result through a temporary link after completion.
Best practices
  • Send `Idempotency-Key` for any retryable request.
  • Do not send huge files entirely from memory; use structured upload and clear limits.
  • Verify webhook signatures and safely ignore duplicate events.
Expected errors
  • 400 - Invalid options or unsupported file.
  • 401/403 - Missing key or insufficient scope.
  • 429 - Rate limit exceeded; wait or use a higher plan.
FAQ

Short answers

Is there a versioned API?

Yes, integration routes start at `/api/v1` so future versions can evolve without breaking integrations.

Should webhooks be verified?

Yes. Verify signatures and ignore duplicate or unexpected events.

Is file content logged?

No. Integration logs should not contain file content, extracted text, or passwords.