**Sample request** ```bash cURL theme={null} curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/from/html' \ --header 'x-api-key: *******************' \ --header 'Content-Type: application/json' \ --data-raw '{ "html": "

Hello World!

Go to PDF.co", "name": "result.pdf", "margins": "5px 5px 5px 5px", "paperSize": "Letter", "orientation": "Portrait", "printBackground": true, "header": "", "footer": "", "mediaType": "print", "async": false }' ``` ```javascript JavaScript/Node.js theme={null} var https = require("https"); var path = require("path"); var fs = require("fs"); // The authentication key (API Key). // Get your own by registering at https://app.pdf.co const API_KEY = "***************************"; // HTML Input const inputHtml = "./sample.html"; // Destination PDF file name const DestinationFile = "./result.pdf"; // Prepare requests params as JSON var parameters = {}; // Input HTML code to be converted. Required. parameters["html"] = fs.readFileSync(inputHtml, "utf8"); // Name of resulting file parameters["name"] = path.basename(DestinationFile); // Set to css style margins like 10 px or 5px 5px 5px 5px. parameters["margins"] = "5px 5px 5px 5px"; // Can be Letter, A4, A5, A6 or custom size like 200x200 parameters["paperSize"] = "Letter"; // Set to Portrait or Landscape. Portrait by default. parameters["orientation"] = "Portrait"; // true by default. Set to false to disbale printing of background. parameters["printBackground"] = true; // If large input document, process in async mode by passing true parameters["async"] = false; // Set to HTML for header to be applied on every page at the header. parameters["header"] = ""; // Set to HTML for footer to be applied on every page at the bottom. parameters["footer"] = ""; // Convert JSON object to string var jsonPayload = JSON.stringify(parameters); // Prepare request to `HTML To PDF` API endpoint var url = '/v1/pdf/convert/from/html'; var reqOptions = { host: "api.pdf.co", path: url, method: "POST", 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) => { // Parse JSON response var data = JSON.parse(d); if (data.error == false) { // Download PDF file var file = fs.createWriteStream(DestinationFile); https.get(data.url, (response2) => { response2.pipe(file) .on("close", () => { console.log(`Generated PDF file saved as "${DestinationFile}" file.`); }); }); } else { // Service reported error console.log(data.message); } }); }).on("error", (e) => { // Request error console.log(e); }); // Write request data postRequest.write(jsonPayload); postRequest.end(); ``` ```python Python theme={null} import os import json 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" # HTML template file_read = open(".\\sample.html", mode='r', encoding= 'utf-8') SampleHtml = file_read.read() file_read.close() # Destination PDF file name DestinationFile = ".\\result.pdf" def main(args = None): GeneratePDFFromHtml(SampleHtml, DestinationFile) def GeneratePDFFromHtml(SampleHtml, destinationFile): """Converts HTML to PDF using PDF.co Web API""" # Prepare requests params as JSON parameters = {} # Input HTML code to be converted. Required. parameters["html"] = SampleHtml # Name of resulting file parameters["name"] = os.path.basename(destinationFile) # Set to css style margins like 10 px or 5px 5px 5px 5px. parameters["margins"] = "5px 5px 5px 5px" # Can be Letter, A4, A5, A6 or custom size like 200x200 parameters["paperSize"] = "Letter" # Set to Portrait or Landscape. Portrait by default. parameters["orientation"] = "Portrait" # true by default. Set to false to disable printing of background. parameters["printBackground"] = "true" # If large input document, process in async mode by passing true parameters["async"] = "false" # Set to HTML for header to be applied on every page at the header. parameters["header"] = "" # Set to HTML for footer to be applied on every page at the bottom. parameters["footer"] = "" # Prepare URL for 'HTML To PDF' API request url = "{}/pdf/convert/from/html".format( BASE_URL ) # 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: # Get URL of result file resultFileUrl = json["url"] # Download result file r = requests.get(resultFileUrl, stream=True) if (r.status_code == 200): with open(destinationFile, 'wb') as file: for chunk in r: file.write(chunk) print(f"Result file saved as \"{destinationFile}\" file.") else: print(f"Request error: {response.status_code} {response.reason}") else: # Show service reported error print(json["message"]) else: print(f"Request error: {response.status_code} {response.reason}") 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 = "******************************"; static void Main(string[] args) { // HTML input string inputSample = File.ReadAllText(@".\sample.html"); // Destination PDF file name string destinationFile = @".\result.pdf"; // Create standard .NET web client instance WebClient webClient = new WebClient(); // Set API Key webClient.Headers.Add("x-api-key", API_KEY); // Set JSON content type webClient.Headers.Add("Content-Type", "application/json"); try { // Prepare requests params as JSON Dictionary parameters = new Dictionary(); // Input HTML code to be converted. Required. parameters.Add("html", inputSample); // Name of resulting file parameters.Add("name", Path.GetFileName(destinationFile)); // Set to css style margins like 10 px or 5px 5px 5px 5px. parameters.Add("margins", "5px 5px 5px 5px"); // Can be Letter, A4, A5, A6 or custom size like 200x200 parameters.Add("paperSize", "Letter"); // Set to Portrait or Landscape. Portrait by default. parameters.Add("orientation", "Portrait"); // true by default. Set to false to disbale printing of background. parameters.Add("printBackground", true); // If large input document, process in async mode by passing true parameters.Add("async", false); // Set to HTML for header to be applied on every page at the header. parameters.Add("header", ""); // Set to HTML for footer to be applied on every page at the bottom. parameters.Add("footer", ""); // Convert dictionary of params to JSON string jsonPayload = JsonConvert.SerializeObject(parameters); // Prepare URL for `HTML to PDF` API call string url = "https://api.pdf.co/v1/pdf/convert/from/html"; // Execute POST request with JSON payload string response = webClient.UploadString(url, jsonPayload); // Parse JSON response JObject json = JObject.Parse(response); if (json["error"].ToObject() == false) { // Get URL of generated PDF file string resultFileUrl = json["url"].ToString(); webClient.Headers.Remove("Content-Type"); // remove the header required for only the previous request // Download the PDF file webClient.DownloadFile(resultFileUrl, destinationFile); Console.WriteLine("Generated PDF document saved as \"{0}\" file.", destinationFile); } else { Console.WriteLine(json["message"].ToString()); } } catch (WebException e) { Console.WriteLine(e.ToString()); } webClient.Dispose(); Console.WriteLine(); Console.WriteLine("Press any key to exit..."); Console.ReadKey(); } } } ``` ```java Java theme={null} package com.company; import com.google.gson.JsonObject; import com.google.gson.JsonParser; import com.google.gson.JsonPrimitive; import okhttp3.*; import java.io.*; import java.net.*; import java.nio.file.Files; 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 = "***********************************"; public static void main(String[] args) throws IOException { // HTML input final String inputSample = new String(Files.readAllBytes(Paths.get(".\\sample.html"))); // Destination PDF file name final Path destinationFile = Paths.get(".\\result.pdf"); // Create HTTP client instance OkHttpClient webClient = new OkHttpClient(); // Prepare URL for `HTML to PDF` API call String apiUrl = "https://api.pdf.co/v1/pdf/convert/from/html"; // Make correctly escaped (encoded) URL URL url = null; try { url = new URI(null, apiUrl, null).toURL(); } catch (URISyntaxException e) { e.printStackTrace(); } // Prepare request body in JSON format JsonObject jsonBody = new JsonObject(); // Input HTML code to be converted. Required. jsonBody.add("html", new JsonPrimitive(inputSample)); // Name of resulting file jsonBody.add("name", new JsonPrimitive(destinationFile.getFileName().toString())); // Set to css style margins like 10 px or 5px 5px 5px 5px. jsonBody.add("margins", new JsonPrimitive("5px 5px 5px 5px")); // Can be Letter, A4, A5, A6 or custom size like 200x200 jsonBody.add("paperSize", new JsonPrimitive("Letter")); // Set to Portrait or Landscape. Portrait by default. jsonBody.add("orientation", new JsonPrimitive("Portrait")); // true by default. Set to false to disable printing of background. jsonBody.add("printBackground", new JsonPrimitive(true)); // If large input document, process in async mode by passing true jsonBody.add("async", new JsonPrimitive(false)); // Set to HTML for header to be applied on every page at the header. jsonBody.add("header", new JsonPrimitive("")); // Set to HTML for footer to be applied on every page at the bottom. jsonBody.add("footer", new JsonPrimitive("")); RequestBody body = RequestBody.create(MediaType.parse("application/json"), jsonBody.toString()); // 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) { // Get URL of generated PDF file String resultFileUrl = json.get("url").getAsString(); // Download PDF file downloadFile(webClient, resultFileUrl, destinationFile.toFile()); System.out.printf("Generated PDF file saved as \"%s\" file.", destinationFile.toString()); } 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 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} { "url": "https://pdf-temp-files.s3.amazonaws.com/97dc323f32794eae8fa6602f5bd981c1/result.pdf", "pageCount": 1, "error": false, "status": 200, "name": "result.pdf", "remainingCredits": 60646 } ``` ```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, "message": "Too many requests. Your current limit is requests per minute. Please try again later" } ``` ```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 447 theme={null} { "error": true, "status": 447, "message": "Invalid template." } ``` ```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.