Image to Image via HTTP API

Overview

This page serves as a guide for using the PDFCrowd API to convert between images formats. You can call the API by sending an HTTP request to the API server address with options passed as POST data.

Quick Start

Below are examples to help you quickly get started with the API. Explore our additional examples for more insights.

curl -f -u "your_username:your_apikey" \
    -o "logo.jpg" \
    -F "input_format=image" \
    -F "output_format=jpg" \
    -F "file=@/path/to/logo.png" \
    https://api.pdfcrowd.com/convert/24.04/

curl -f -u "your_username:your_apikey" \
    -o "logo.jpg" \
    -F "input_format=image" \
    -F "output_format=jpg" \
    -F "url=https://pdfcrowd.com/static/images/logo.png" \
    https://api.pdfcrowd.com/convert/24.04/

Authentication

The authentication method is HTTP Basic authentication.

HTTP Basic authentication

To authenticate, add the following HTTP header to your request. <credentials> is the Base64 encoding of your username and API key joined by a single colon.

Authorization: Basic <credentials>

Server Address

The server address: https://api.pdfcrowd.com/convert/24.04/

Notes:

If your request uploads local files, set the Content-Type to multipart/form-data.
If no files are uploaded, you may use application/x-www-form-urlencoded.

Optional URL Parameter:

errfmt: Specifies the error response format.
- json – Returns errors in JSON format.
- txt – Returns plain-text error messages.

Example:
https://api.pdfcrowd.com/convert/24.04/?errfmt=json

Show older API versions.

Response Headers

The HTTP response contains the following headers.

Name	Description
x-pdfcrowd-debug-log	URL pointing to the debug log for this request.
x-pdfcrowd-remaining-credits	Number of conversion credits remaining in your account.
x-pdfcrowd-consumed-credits	Number of credits consumed for this conversion.
x-pdfcrowd-job-id	Unique identifier assigned to this conversion job.
x-pdfcrowd-output-size	Size of the output data in bytes.
x-pdfcrowd-reason-code	The reason code of the error, or 0.

Troubleshooting

If you are receiving an error, refer to the API Status Codes for more information.
Use debug_log to obtain detailed information about the conversion process, including load errors, load times, browser console output, etc.
Consult the FAQ for answers to common questions.
Contact us if you need assistance or if there is a feature you are missing.

POST Parameter Reference

Refer to the Image to Image POST Reference for a description of all options.

Image to Image / HTTP API Guide