[tomasr78]

Problem

The README "Additional conversion parameters" snippet passed ScaleImage and ScaleProportions to pdf -> jpg. Neither is a pdf-to-jpg parameter (spec), and the API ignores them silently, so readers copy two parameters that do nothing. They exist only on jpg-to-jpg (spec).

The snippet also sets both ImageHeight and ImageWidth to 300. Without FitToSize, pdf-to-jpg applies the width and lets the height grow, so a US Letter page comes back 300x388, not inside 300x300. Measured on production on 2026-11-06: the old parameters gave a 300x388 JPG, byte-identical to the same request without ScaleImage and ScaleProportions.

Change

The snippet drops ScaleImage and ScaleProportions and adds params.add('FitToSize', 'true') after ImageWidth, so page 1 becomes a JPG that fits inside 300x300 and keeps the page's aspect ratio. params.add takes string values, so FitToSize is the string 'true', as ScaleImage was. Nothing else in the README changes.

Verification

One conversion on the production API on 2026-11-09: a multipart POST to https://v2.convertapi.com/convert/pdf/to/jpg with the snippet's parameters (ImageHeight 300, ImageWidth 300, FitToSize true) plus PageRange 1, on test.pdf from the SDK examples (6 US Letter pages; the same file as assets/test.pdf in the Go SDK):

HTTP 200
{"ConversionCost": 1, "Files": [{"FileName": "test.jpg", "FileExt": "jpg", "FileSize": 8858}]}

test.jpg is 231x300 px, 8,858 bytes (sips -g pixelWidth -g pixelHeight), byte-identical to the JPGs the fixed Java and Go README snippets produce. PageRange 1 only kept the check to one page: the snippet converts every page, and result.files[0] is page 1.

The live spec lists ImageWidth, ImageHeight, PageRange and FitToSize ("scale the output image to fit within both ImageWidth and ImageHeight while maintaining the aspect ratio"; it needs both sizes), and no ScaleImage or ScaleProportions.

Only the README changes, not the library's behaviour, so there is no CHANGELOG entry (RELEASING.md asks for one in pull requests that change behaviour).

The same README fix for Java is in ConvertAPI/convertapi-library-java#57, for Go in ConvertAPI/convertapi-library-go#21 and for .NET in ConvertAPI/convertapi-library-dotnet#83.

🤖 Generated with Claude Code

[Copilot]

🟢 Approval recommended

No active review issues remain for the README-only update to the PDF-to-JPG sizing example.

No open issues 🎉

What changed in this PR

Corrects the README’s PDF-to-JPG example to use supported conversion parameters and preserve aspect ratio within a 300×300 bounding box. No library behavior changes.

Changes:

• Removes unsupported ScaleImage and ScaleProportions parameters.
• Adds FitToSize with the string value 'true', retaining both image dimensions.

File	Description
README.md	Updates the PDF-to-JPG sizing example to use FitToSize.

_{Review effort: Balanced}