Skip to content

Latest commit

History

History
32 lines (26 loc) · 1.32 KB

File metadata and controls

32 lines (26 loc) · 1.32 KB

PDFGeneratorAPI::ConvertPDF2ImageRequest

Properties

NameTypeDescriptionNotes
file_base64StringBase64 encoded PDF file. Required if file_url is not provided.[optional]
file_urlStringPublic HTTPS URL to a PDF file. Required if file_base64 is not provided.[optional]
formatStringOutput image format[optional][default to 'png']
qualityIntegerImage quality (1-100)[optional][default to 85]
resolutionIntegerImage resolution in DPI (72-600)[optional][default to 150]
pagesStringPage number or range to convert. Use a single number (e.g. "1") or a range (e.g. "1-4"). Defaults to all pages.[optional][default to 'all']
outputStringOutput format[optional][default to 'base64']
nameStringDocument name (max 120 characters). Auto-generated if not provided.[optional]

Example

require'pdf_generator_api_client'instance=PDFGeneratorAPI::ConvertPDF2ImageRequest.new(file_base64: JVBERi0xLjcKJeLjz9MKNyAwIG9iago8...,file_url: https://example.org/document.pdf,format: png,quality: 85,resolution: 150,pages: 1-4,output: base64,name: my-document)