**Sample request** ```bash CURL theme={null} curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/to/jpg' \ --header 'x-api-key: *******************' \ --header 'Content-Type: application/json' \ --data-raw '{ "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf", "inline": true, "pages": "0-", "async": false }' ``` ```javascript JavaScript/Node.js theme={null} var https = require("https"); var path = require("path"); var fs = require("fs"); // `request` module is required for file upload. // Use "npm install request" command to install. var request = require("request"); // The authentication key (API Key). // Get your own by registering at https://app.pdf.co const API_KEY = "***********************************"; // Source PDF file const SourceFile = "./sample.pdf"; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. const Pages = ""; // PDF document password. Leave empty for unprotected documents. const Password = ""; // 1. RETRIEVE PRESIGNED URL TO UPLOAD FILE. getPresignedUrl(API_KEY, SourceFile) .then(([uploadUrl, uploadedFileUrl]) => { // 2. UPLOAD THE FILE TO CLOUD. uploadFile(API_KEY, SourceFile, uploadUrl) .then(() => { // 3. CONVERT UPLOADED PDF FILE TO IMAGE convertPDFToImage(API_KEY, uploadedFileUrl, Password, Pages, "jpg"); }) .catch(e => { console.log(e); }); }) .catch(e => { console.log(e); }); function getPresignedUrl(apiKey, localFile) { return new Promise(resolve => { // Prepare request to `Get Presigned URL` API endpoint let queryPath = `/v1/file/upload/get-presigned-url?contenttype=application/octet-stream&name=${path.basename(SourceFile)}`; let reqOptions = { host: "api.pdf.co", path: encodeURI(queryPath), headers: { "x-api-key": API_KEY } }; // Send request https.get(reqOptions, (response) => { response.on("data", (d) => { let data = JSON.parse(d); if (data.error == false) { // Return presigned url we received resolve([data.presignedUrl, data.url]); } else { // Service reported error console.log("getPresignedUrl(): " + data.message); } }); }) .on("error", (e) => { // Request error console.log("getPresignedUrl(): " + e); }); }); } function uploadFile(apiKey, localFile, uploadUrl) { return new Promise(resolve => { fs.readFile(SourceFile, (err, data) => { request({ method: "PUT", url: uploadUrl, body: data, headers: { "Content-Type": "application/octet-stream" } }, (err, res, body) => { if (!err) { resolve(); } else { console.log("uploadFile() request error: " + err); } }); }); }); } // `imageType` should correspond to the API we want to use, // i.e. /v1/pdf/convert/to/jpg, /v1/pdf/convert/to/png, /v1/pdf/convert/to/webp or /v1/pdf/convert/to/tiff // we just take the last part of the path, the file extension function convertPDFToImage(apiKey, uploadedFileUrl, password, pages, imageType) { // Prepare URL for PDF to Image API call var queryPath = `/v1/pdf/convert/to/${imageType}`; // JSON payload for api request var jsonPayload = JSON.stringify({ password: password, pages: pages, url: uploadedFileUrl }); var reqOptions = { host: "api.pdf.co", method: "POST", path: queryPath, headers: { "x-api-key": API_KEY, "Content-Type": "application/json", "Content-Length": Buffer.byteLength(jsonPayload, 'utf8') } }; // Send request var postRequest = https.request(reqOptions, (response) => { response.on("data", (d) => { response.setEncoding("utf8"); // Parse JSON response let data = JSON.parse(d); if (data.error == false) { // Download generated image files var page = 1; data.urls.forEach((url) => { var localFileName = `./page${page}.${imageType}`; var file = fs.createWriteStream(localFileName); https.get(url, (response2) => { response2.pipe(file) .on("close", () => { console.log(`Generated image file saved as "${localFileName}" file.`); }); }); page++; }, this); } else { // Service reported error console.log("convertPDFToImage(): " + data.message); } }); }) .on("error", (e) => { // Request error console.log("convertPDFToImage(): " + e); }); // Write request data postRequest.write(jsonPayload); postRequest.end(); } ``` ```python Python theme={null} import os import requests # pip install requests # The authentication key (API Key). # Get your own by registering at https://app.pdf.co API_KEY = "******************************************" # Base URL for PDF.co Web API requests BASE_URL = "https://api.pdf.co/v1" # Source PDF file SourceFile = ".\\sample.pdf" # Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. Pages = "" # PDF document password. Leave empty for unprotected documents. Password = "" def main(args = None): uploadedFileUrl = uploadFile(SourceFile) if (uploadedFileUrl != None): convertPDFToImage(uploadedFileUrl, "jpg") def convertPDFToImage(uploadedFileUrl, imageType): """Converts PDF To Image using PDF.co Web API""" # Prepare requests params as JSON # See documentation: https://developer.pdf.co/api/pdf-to-image/jpg parameters = {} parameters["password"] = Password parameters["pages"] = Pages parameters["url"] = uploadedFileUrl # Prepare URL for PDF To Image API request url = "{}/pdf/convert/to/{}".format(BASE_URL, imageType) # Execute request and get response as JSON response = requests.post(url, data=parameters, headers={ "x-api-key": API_KEY }) if (response.status_code == 200): json = response.json() if json["error"] == False: # Download generated JPG files part = 1 for resultFileUrl in json["urls"]: # Download Result File r = requests.get(resultFileUrl, stream=True) localFileUrl = f"Page{part}.{imageType}" if r.status_code == 200: with open(localFileUrl, 'wb') as file: for chunk in r: file.write(chunk) print(f"Result file saved as \"{localFileUrl}\" file.") else: print(f"Request error: {response.status_code} {response.reason}") part = part + 1 else: # Show service reported error print(json["message"]) else: print(f"Request error: {response.status_code} {response.reason}") def uploadFile(fileName): """Uploads file to the cloud""" # 1. RETRIEVE PRESIGNED URL TO UPLOAD FILE. # Prepare URL for 'Get Presigned URL' API request url = "{}/file/upload/get-presigned-url?contenttype=application/octet-stream&name={}".format( BASE_URL, os.path.basename(fileName)) # Execute request and get response as JSON response = requests.get(url, headers={ "x-api-key": API_KEY }) if (response.status_code == 200): json = response.json() if json["error"] == False: # URL to use for file upload uploadUrl = json["presignedUrl"] # URL for future reference uploadedFileUrl = json["url"] # 2. UPLOAD FILE TO CLOUD. with open(fileName, 'rb') as file: requests.put(uploadUrl, data=file, headers={ "x-api-key": API_KEY, "content-type": "application/octet-stream" }) return uploadedFileUrl else: # Show service reported error print(json["message"]) else: print(f"Request error: {response.status_code} {response.reason}") return None if __name__ == '__main__': main() ``` ```csharp C# theme={null} using System; using System.Collections.Generic; using System.IO; using System.Net; using Newtonsoft.Json; using Newtonsoft.Json.Linq; namespace PDFcoApiExample { class Program { // The authentication key (API Key). // Get your own by registering at https://app.pdf.co const String API_KEY = "***********************************"; // Source PDF file const string SourceFile = @".\sample.pdf"; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. const string Pages = ""; // PDF document password. Leave empty for unprotected documents. const string Password = ""; const string imageType = "jpg"; static void Main(string[] args) { // Create standard .NET web client instance WebClient webClient = new WebClient(); // Set API Key webClient.Headers.Add("x-api-key", API_KEY); // 1. RETRIEVE THE PRESIGNED URL TO UPLOAD THE FILE. // * If you already have the direct file URL, skip to the step 3. // Prepare URL for `Get Presigned URL` API call string query = Uri.EscapeUriString(string.Format( "https://api.pdf.co/v1/file/upload/get-presigned-url?contenttype=application/octet-stream&name={0}", Path.GetFileName(SourceFile))); try { // Execute request string response = webClient.DownloadString(query); // Parse JSON response JObject json = JObject.Parse(response); if (json["error"].ToObject() == false) { // Get URL to use for the file upload string uploadUrl = json["presignedUrl"].ToString(); // Get URL of uploaded file to use with later API calls string uploadedFileUrl = json["url"].ToString(); // 2. UPLOAD THE FILE TO CLOUD. webClient.Headers.Add("content-type", "application/octet-stream"); webClient.UploadFile(uploadUrl, "PUT", SourceFile); // You can use UploadData() instead if your file is byte[] or Stream // 3. CONVERT UPLOADED PDF FILE TO IMAGE // Prepare URL for PDF To Image API call string url = String.Format(@"https://api.pdf.co/v1/pdf/convert/to/{0}", imageType); // Prepare requests params as JSON Dictionary parameters = new Dictionary(); parameters.Add("password", Password); parameters.Add("pages", Pages); parameters.Add("url", uploadedFileUrl); // Convert dictionary of params to JSON string jsonPayload = JsonConvert.SerializeObject(parameters); // Execute POST request with JSON payload response = webClient.UploadString(url, jsonPayload); // Parse JSON response json = JObject.Parse(response); if (json["error"].ToObject() == false) { // Download generated JPEG files int page = 1; foreach (JToken token in json["urls"]) { string resultFileUrl = token.ToString(); string localFileName = String.Format(@".\page{0}.{1}", page, imageType); webClient.DownloadFile(resultFileUrl, localFileName); Console.WriteLine("Downloaded \"{0}\".", localFileName); page++; } } else { Console.WriteLine(json["message"].ToString()); } } else { Console.WriteLine(json["message"].ToString()); } } catch (WebException e) { Console.WriteLine(e.ToString()); } webClient.Dispose(); Console.WriteLine(); Console.WriteLine("Press any key..."); Console.ReadKey(); } } } ``` ```java Java theme={null} package com.company; import com.google.gson.JsonArray; import com.google.gson.JsonElement; import com.google.gson.JsonObject; import com.google.gson.JsonParser; import okhttp3.*; import java.io.*; import java.net.*; import java.nio.file.Path; import java.nio.file.Paths; public class Main { // The authentication key (API Key). // Get your own by registering at https://app.pdf.co final static String API_KEY = "***********************************"; // Source PDF file final static Path SourceFile = Paths.get(".\\sample.pdf"); // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. final static String Pages = ""; // PDF document password. Leave empty for unprotected documents. final static String Password = ""; public static void main(String[] args) throws IOException { // Create HTTP client instance OkHttpClient webClient = new OkHttpClient(); // 1. RETRIEVE THE PRESIGNED URL TO UPLOAD THE FILE. // * If you already have a direct file URL, skip to the step 3. // Prepare URL for `Get Presigned URL` API call String query = String.format( "https://api.pdf.co/v1/file/upload/get-presigned-url?contenttype=application/octet-stream&name=%s", SourceFile.getFileName()); // Prepare request Request request = new Request.Builder() .url(query) .addHeader("x-api-key", API_KEY) // (!) Set API Key .build(); // Execute request Response response = webClient.newCall(request).execute(); if (response.code() == 200) { // Parse JSON response JsonObject json = new JsonParser().parse(response.body().string()).getAsJsonObject(); boolean error = json.get("error").getAsBoolean(); if (!error) { // Get URL to use for the file upload String uploadUrl = json.get("presignedUrl").getAsString(); // Get URL of uploaded file to use with later API calls String uploadedFileUrl = json.get("url").getAsString(); // 2. UPLOAD THE FILE TO CLOUD. if (uploadFile(webClient, API_KEY, uploadUrl, SourceFile)) { // 3. CONVERT UPLOADED PDF FILE TO IMAGE PDFToImage(webClient, API_KEY, Password, Pages, uploadedFileUrl, "jpg"); } } else { // Display service reported error System.out.println(json.get("message").getAsString()); } } else { // Display request error System.out.println(response.code() + " " + response.message()); } } public static void PDFToImage(OkHttpClient webClient, String apiKey, String password, String pages, String uploadedFileUrl, String imageType) throws IOException { // Prepare URL for PDF To Image API call String query = String.format("https://api.pdf.co/v1/pdf/convert/to/%s", imageType); // Make correctly escaped (encoded) URL URL url = null; try { url = new URI(null, query, null).toURL(); } catch (URISyntaxException e) { e.printStackTrace(); } // Create JSON payload String jsonPayload = String.format("{\"password\": \"%s\", \"pages\": \"%s\", \"url\": \"%s\"}", password, pages, uploadedFileUrl); // Prepare request body RequestBody body = RequestBody.create(MediaType.parse("application/json"), jsonPayload); // Prepare request Request request = new Request.Builder() .url(url) .addHeader("x-api-key", API_KEY) // (!) Set API Key .addHeader("Content-Type", "application/json") .post(body) .build(); // Execute request Response response = webClient.newCall(request).execute(); if (response.code() == 200) { // Parse JSON response JsonObject json = new JsonParser().parse(response.body().string()).getAsJsonObject(); boolean error = json.get("error").getAsBoolean(); if (!error) { // Download generated JPEG files JsonArray urls = json.get("urls").getAsJsonArray(); int page = 1; for (JsonElement element: urls) { String resultFileUrl = element.getAsString(); String localFileName = String.format(".\\page%s.%s", page, imageType); downloadFile(webClient, resultFileUrl, Paths.get(localFileName).toFile()); System.out.println(String.format("Downloaded \"%s\".", localFileName)); page++; } } else { // Display service reported error System.out.println(json.get("message").getAsString()); } } else { // Display request error System.out.println(response.code() + " " + response.message()); } } public static boolean uploadFile(OkHttpClient webClient, String apiKey, String url, Path sourceFile) throws IOException { // Prepare request body RequestBody body = RequestBody.create(MediaType.parse("application/octet-stream"), sourceFile.toFile()); // Prepare request Request request = new Request.Builder() .url(url) .addHeader("x-api-key", apiKey) // (!) Set API Key .addHeader("content-type", "application/octet-stream") .put(body) .build(); // Execute request Response response = webClient.newCall(request).execute(); return (response.code() == 200); } public static void downloadFile(OkHttpClient webClient, String url, File destinationFile) throws IOException { // Prepare request Request request = new Request.Builder() .url(url) .build(); // Execute request Response response = webClient.newCall(request).execute(); byte[] fileBytes = response.body().bytes(); // Save downloaded bytes to file OutputStream output = new FileOutputStream(destinationFile); output.write(fileBytes); output.flush(); output.close(); response.close(); } } ``` ```php PHP theme={null} ``` ```json 200 theme={null} { "urls": [ "https://pdf-temp-files.s3.amazonaws.com/c15b8d82e0034d01a73eac719d69349b/sample.jpg", "https://pdf-temp-files.s3.amazonaws.com/152d2fe414b645e38f81a49e5dafa85b/sample.jpg" ], "pageCount": 2, "error": false, "status": 200, "name": "sample.jpg", "duration": 1121, "remainingCredits": 98722216, "credits": 24 } ``` ```json 400 theme={null} { "error": true, "status": 400, "message": "Bad request. Typically due to bad input parameters or unreachable input URLs (e.g., access restrictions like login or password)." } ``` ```json 401 theme={null} { "error": true, "status": 401, "message": "Unauthorized. Authentication is required and has failed or has not yet been provided." } ``` ```json 402 theme={null} { "error": true, "status": 402, "message": "Not enough credits." } ``` ```json 403 theme={null} { "error": true, "status": 403, "message": "Access forbidden for input URL." } ``` ```json 404 theme={null} { "error": true, "status": 404, "message": "The requested resource could not be found." } ``` ```json 408 theme={null} { "error": true, "status": 408, "message": "The server timed out waiting for the request." } ``` ```json 429 theme={null} { "error": true, "status": 429, "message": "Too many requests in a given time period." } ``` ```json 441 theme={null} { "error": true, "status": 441, "message": "Invalid Password. Password protected document." } ``` ```json 442 theme={null} { "error": true, "status": 442, "message": "Input document is damaged or of incorrect type." } ``` ```json 443 theme={null} { "error": true, "status": 443, "message": "Permissions. The operation is prohibited by document security settings." } ``` ```json 444 theme={null} { "error": true, "status": 444, "message": "Profiles parsing error. Please ensure that the configuration is supported." } ``` ```json 445 theme={null} { "error": true, "status": 445, "message": "Timeout error. For large documents, use asynchronous mode (async=true) and check status via /job/check." } ``` ```json 446 theme={null} { "error": true, "status": 446, "message": "Some files required for conversion are missing." } ``` ```json 448 theme={null} { "error": true, "status": 448, "message": "Invalid URL or HTML. Ensure the provided URL is valid and accessible." } ``` ```json 449 theme={null} { "error": true, "status": 449, "message": "Invalid index range. Page index is out of range." } ``` ```json 450 theme={null} { "error": true, "status": 450, "message": "Invalid page range specified." } ``` ```json 452 theme={null} { "error": true, "status": 452, "message": "Invalid URL." } ``` ```json 454 theme={null} { "error": true, "status": 454, "message": "Invalid parameters." } ``` ```json 500 theme={null} { "error": true, "status": 500, "message": "Something went wrong. Please try again or contact support." } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.