Image to PDF HTTP API
Overview
Convert images to PDF documents with a direct HTTP request from any language or platform. For language-specific client libraries, see the SDK guides.
| Request | Details |
|---|---|
| Method and endpoint | POST https://api.pdfcrowd.com/convert/24.04/ |
| Authentication | HTTP Basic: your PDFCrowd username and API key |
| Request body | Form fields; use multipart form data for file uploads |
| Successful response | 200 OK with the PDF bytes in the response body |
Quick Start
Choose an input below. Your API credentials are filled in below. These examples use demo credentials, so you can try them immediately. Get your own API key.
Each example uses cURL and saves the returned PDF to a local file. If a conversion fails, inspect the response for error details.
Convert an Image URL
Send the image's address in the url field. This example converts
a PNG image to PDF
and saves it in logo.pdf:
curl -f -s -S \ -u 'demo:demo' \ -o logo.pdf \ -F url=https://pdfcrowd.com/static/images/logo.png \ -F input_format=image \ https://api.pdfcrowd.com/convert/24.04/
PDFCrowd downloads the image and returns the result in the same request. The URL must return the image itself and be reachable from PDFCrowd's servers.
Convert an Image File
Upload an image in the file field. Replace the path with your
local file; this example also saves the result in
logo.pdf:
curl -f -s -S \ -u 'demo:demo' \ -o logo.pdf \ -F file=@/path/to/logo.png \ -F input_format=image \ https://api.pdfcrowd.com/convert/24.04/
Each request accepts one image. To control page dimensions, margins and image placement, see Add Conversion Settings.
cURL example options
Use a Bash-compatible shell.
Basic options
-u— Supply your username and API key.-F— Send a form field.-o— Save the response to a file.-f— Report HTTP errors as command failures.-s -S— Hide the progress meter while keeping error messages.
File input
file=@document.png— Upload a local file.
Diagnostics
-
--fail-with-body— Use instead of-fto retain the error response body. -D— Save response headers to a file.-
-w— Print response information; the diagnostic example prints the HTTP status.
Build a Request
Authentication
Use your PDFCrowd username as the HTTP Basic username and your API key as the password. Configure these credentials using your HTTP client's Basic authentication option.
Request Format
Send the input and conversion settings as form fields in a POST request. JSON request bodies are not supported. Your HTTP client handles form encoding and the appropriate headers.
Use the versioned endpoint: https://api.pdfcrowd.com/convert/24.04/.
Keep the version explicit in your integration and review
API versioning before changing it.
Errors are returned as plain text by default; add ?errfmt=json
to the endpoint to receive JSON errors. This changes only the error format;
a successful response still contains the converted PDF.
See Handle the Response for response handling.
Choose an Input
Set input_format
to image; the source image format is detected automatically.
The output is a PDF by default.
Supply one of the following inputs:
| Field | What to Send |
|---|---|
url |
An http:// or https:// address that returns an image and is reachable from PDFCrowd's servers. |
file |
The image's contents uploaded as a multipart file part. |
Upload the file's contents, not its filename or local path as a text field.
If the image is already in memory, use your HTTP client's file-upload option
to send those bytes in the file part.
PDFCrowd cannot fetch an image from your computer's localhost;
upload its contents instead.
Add Conversion Settings
Send conversion settings as additional form fields alongside your input. Image operations change the image itself; page settings control how it is placed in the PDF. Common options include:
| Purpose | Options |
|---|---|
| Resize or rotate the image | resize, rotate |
| Crop the image or remove solid-color borders | crop_area_x, crop_area_y, crop_area_width, crop_area_height, remove_borders |
| Set page dimensions | page_size, page_width, page_height, orientation |
| Fit and position the image | print_page_mode, position |
| Set margins and background color | margin_top, margin_right, margin_bottom, margin_left, page_background_color |
| Set image resolution for layout | dpi |
| Add a watermark or background PDF | page_watermark, page_background |
| Protect the output PDF | user_password, owner_password, no_print, no_copy |
| Set metadata or embed attachments | title, author, attachment |
With an explicit page size, print_page_mode=fit fits the image
inside the margins while preserving its aspect ratio. stretch
fills that area and can distort the image. The default mode does not scale
the image to fit and can crop it if it is too large for the page.
Without an explicit size, margins add a border around the image.
The image remains an image in the PDF. To make text in a scan searchable, use a separate OCR step.
The parameter reference lists all settings, accepted values, defaults, and constraints. For complete conversion requests, see the HTTP examples.
Handle the Response
Successful Conversion
A successful conversion returns 200 OK,
Content-Type: application/pdf, and the
PDF bytes in the
response body. Save those bytes to a file or return them to your application's
user.
An illustrative response is:
HTTP/1.1 200 OK Content-Type: application/pdf x-pdfcrowd-job-id: example-job-id x-pdfcrowd-pages: 1 [PDF bytes]
Check the HTTP status before processing the body. Treat a successful response as binary data; parsing it as JSON or decoding it as text will not produce a usable PDF.
Errors
An unsuccessful request returns an error HTTP status. PDFCrowd error responses also include a reason code that identifies the specific problem.
By default, the error body is plain text in this format:
<status_code>.<reason_code> - <message>
For structured errors, append ?errfmt=json to the endpoint:
https://api.pdfcrowd.com/convert/24.04/?errfmt=json
An example JSON error body for missing conversion input is:
{
"status_code": 400,
"reason_code": 325,
"message": "There is no input specified to be converted."
}
PDFCrowd JSON errors use Content-Type: application/json. A
successful request still returns a PDF
when errfmt=json is set. If a failed response has a different
content type, retain its body and status for diagnosis instead of assuming
it is JSON.
Common Status Codes
| Status | What it means | What to do |
|---|---|---|
400 |
Invalid request or conversion failure | Read the reason code and correct the input or settings. |
401 |
Missing credentials or an inactive license | Check your username, API key, and license status. |
403 |
Suspended service or no credits remaining | Check your account and available credits. |
413 |
Upload exceeds the 300 MB limit | Reduce the upload size. |
429 |
Request rate limit reached | Wait and reduce the rate of new requests. |
430 |
Concurrent request limit reached | Allow active requests to finish before starting more. |
503 |
Temporary network issue | Retry after a delay. |
See all status and reason codes for specific error explanations. For request limits and retry guidance, see Limits and Retries.
Response Headers
Use these headers, when present, to record conversion results and diagnose problems:
| Header | Use |
|---|---|
x-pdfcrowd-job-id |
Identify the conversion in logs and support requests. |
x-pdfcrowd-reason-code |
Read the error reason code; 0 indicates success. |
x-pdfcrowd-debug-log |
Open the debug log when debug logging is enabled. |
x-pdfcrowd-consumed-credits |
Record credits consumed by this conversion. |
x-pdfcrowd-remaining-credits |
Monitor the remaining account balance. |
x-pdfcrowd-pages |
Read the output PDF's page count. |
x-pdfcrowd-output-size |
Read the output size in bytes. |
Limits and Retries
Request rate and concurrency limits depend on your license. Control how
quickly you submit conversions and how many you run at once. A 429
response concerns request rate; a 430 response concerns requests
already in progress.
The maximum upload size is 300 MB.
For temporary failures, use a bounded number of retries with increasing delays. Correct invalid input, authentication, or account problems before retrying those requests.
If a conversion exceeds 60 seconds of processing time, PDFCrowd stops it and returns an error response.
Troubleshooting
Inspect a Request
Capture the HTTP status, response headers, and response body when diagnosing
a request. Set debug_log to true to enable a
conversion debug log, and add errfmt=json to the endpoint's
query string for structured error details. Use the input and conversion
settings from the request you're investigating.
curl --fail-with-body \ -u 'demo:demo' \ -D response.headers \ -o response.body \ -w 'HTTP %{http_code}\n' \ -F url=https://pdfcrowd.com/static/images/logo.png \ -F input_format=image \ -F debug_log=true \ 'https://api.pdfcrowd.com/convert/24.04/?errfmt=json'
Check the HTTP status before interpreting the body. A successful response contains PDF bytes; an unsuccessful response should be inspected for error details. If no HTTP response arrives, check the error reported by your HTTP client.
The x-pdfcrowd-debug-log header links to diagnostic information
about the conversion. You can also find logs in your
conversion history.
Common Problems
| Problem | Check |
|---|---|
| No input or no request data | Send form fields rather than JSON. Supply url or upload the image's contents in a multipart file part named file. |
| The image cannot be loaded | Check that the URL returns an image rather than an HTML or login page and is reachable from PDFCrowd's servers. For a local file, check that your client uploads its contents. |
| The image is distorted or cut off |
Check the image dimensions, crop settings and margins.
With an explicit page size, use print_page_mode=fit
to preserve the aspect ratio and fit the whole image inside the content area.
|
| The output looks blurry | Check the source image's pixel dimensions and how much it is enlarged. Increasing dpi or enlarging the image cannot recover detail missing from the source. |
| Text in the PDF cannot be selected or searched | The PDF contains the source image. Recognizing text from a scan requires a separate OCR step. |
| The HTTP client times out before receiving the response | Check its timeout settings and allow enough time for conversion, uploading the input, and downloading the result. |
For help, contact support and include any available diagnostics and enough detail for us to reproduce the problem.