**Sample request** ```bash cURL theme={null} curl --location --request POST 'https://api.pdf.co/v1/pdf/convert/from/html' \ --header 'x-api-key: add_your_api_key_here' \ --header 'Content-Type: application/json' \ --data-raw '{ "templateId": 2, "name": "newDocument.pdf", "margins": "40px 20px 20px 20px", "paperSize": "Letter", "orientation": "Portrait", "printBackground": true, "header": "", "footer": "", "async": false, "encrypt": false, "templateData": "{\"invoice_id\":\"1234567\",\"invoice_date\":\"April 30, 2016\",\"invoice_dateDue\":\"May 15, 2016\",\"paid\":false,\"issuer_name\":\"Acme Inc\",\"issuer_company\":\"Acme International\",\"issuer_address\":\"City, Street 3rd\",\"issuer_email\":\"support@example.com\",\"issuer_website\":\"http://example.com\",\"client_name\":\"Food Delivery Inc.\",\"client_company\":\"Food Delivery International\",\"client_address\":\"New York, Some Street, 42\",\"client_email\":\"client@example.com\",\"items\":[{\"name\":\"Setting up new web-site\",\"price\":250},{\"name\":\"Website Content Addition\",\"price\":700},{\"name\":\"Database Setup\",\"price\":200},{\"name\":\"Record Digitalization\",\"price\":1800},{\"name\":\"Cloud Storage\",\"price\":500},{\"name\":\"Short Messages\",\"price\":35},{\"name\":\"Search Engine Optimization\",\"price\":200},{\"name\":\"Priority Support\",\"price\":75},{\"name\":\"Configuring mail server and mailboxes\",\"price\":50}],\"tax\":0.065,\"discount\":0.01,\"note\":\"Thank You For Your Business!\"}" }' ``` ```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 = "***********************************"; // Data to fill the template const templateData = "./invoice_data.json"; // Destination PDF file name const DestinationFile = "./result.pdf"; /* Please follow below steps to create your own HTML Template and get "templateId". 1. Add new html template in app.pdf.co/templates/html 2. Copy paste your html template code into this new template. Sample HTML templates can be found at "https://github.com/pdfdotco/pdf-co-api-samples/tree/master/PDF%20from%20HTML%20template/TEMPLATES-SAMPLES" 3. Save this new template 4. Copy it’s ID to clipboard 5. Now set ID of the template into “templateId” parameter */ // HTML template using built-in template // see https://app.pdf.co/templates/html/2/edit const template_id = 2; // Prepare request to `HTML To PDF` API endpoint var queryPath = `/v1/pdf/convert/from/html?name=${path.basename(DestinationFile)}&async=True`; var reqOptions = { host: "api.pdf.co", path: encodeURI(queryPath), method: "POST", headers: { "x-api-key": API_KEY, "Content-Type": "application/json" } }; var requestBody = JSON.stringify({ "templateId": template_id, "templateData": fs.readFileSync(templateData, "utf8"), "async": true }); // Send request var postRequest = https.request(reqOptions, (response) => { response.on("data", (d) => { // Parse JSON response var data = JSON.parse(d); if (data.error == false) { console.log(`Job #${data.jobId} has been created!`); checkIfJobIsCompleted(data.jobId, data.url); } else { // Service reported error console.log(data.message); } }); }).on("error", (e) => { // Request error console.log(e); }); // Write request data postRequest.write(requestBody); postRequest.end(); function checkIfJobIsCompleted(jobId, resultFileUrl) { let queryPath = `/v1/job/check`; // JSON payload for api request let jsonPayload = JSON.stringify({ jobid: jobId }); let reqOptions = { host: "api.pdf.co", path: queryPath, 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) => { response.setEncoding("utf8"); // Parse JSON response let data = JSON.parse(d); console.log(`Checking Job #${jobId}, Status: ${data.status}, Time: ${new Date().toLocaleString()}`); if (data.status == "working") { // Check again after 3 seconds setTimeout(function(){ checkIfJobIsCompleted(jobId, resultFileUrl);}, 3000); } else if (data.status == "success") { // Download PDF file var file = fs.createWriteStream(DestinationFile); https.get(resultFileUrl, (response2) => { response2.pipe(file) .on("close", () => { console.log(`Generated PDF file saved as "${DestinationFile}" file.`); }); }); } else { console.log(`Operation ended with status: "${data.status}".`); } }) }); // 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" # --HTML Template ID-- # Please follow below steps to create your own HTML Template and get "templateId". # 1. Add new html template in app.pdf.co/templates/html # 2. Copy paste your html template code into this new template. Sample HTML templates can be found at "https://github.com/pdfdotco/pdf-co-api-samples/tree/master/PDF%20from%20HTML%20template/TEMPLATES-SAMPLES" # 3. Save this new template # 4. Copy it’s ID to clipboard # 5. Now set ID of the template into “templateId” parameter # HTML template using built-in template # see https://app.pdf.co/templates/html/2/edit template_id = 2 # Data to fill the template file_read = open(".\\invoice_data.json", mode='r') TemplateData = file_read.read() file_read.close() # Destination PDF file name DestinationFile = ".\\result.pdf" def main(args = None): GeneratePDFFromTemplate(template_id, TemplateData, DestinationFile) def GeneratePDFFromTemplate(template_id, templateData, destinationFile): """Converts HTML to PDF using PDF.co Web API""" data = { 'templateData': templateData, 'templateId': template_id } # Prepare URL for 'HTML To PDF' API request url = "{}/pdf/convert/from/html?name={}".format( BASE_URL, os.path.basename(destinationFile) ) # Execute request and get response as JSON response = requests.post(url, data=data, 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.Http; using System.Threading.Tasks; using Newtonsoft.Json; using Newtonsoft.Json.Linq; namespace PDFcoCodeSample { class Program { const String API_KEY = "***********************************"; const string DestinationFile = @".\newDocument.pdf"; const bool Async = true; // Enable asynchronous processing static async Task Main(string[] args) { using (HttpClient httpClient = new HttpClient()) { httpClient.DefaultRequestHeaders.Add("x-api-key", API_KEY); string url = "https://api.pdf.co/v1/pdf/convert/from/html"; // Prepare requests params as JSON Dictionary parameters = new Dictionary { { "templateId", 1 }, { "name", Path.GetFileName(DestinationFile) }, { "margins", "40px 20px 20px 20px" }, { "paperSize", "Letter" }, { "orientation", "Portrait" }, { "header", "" }, { "printBackground", true }, { "footer", "" }, { "async", Async }, // Enable asynchronous processing { "encrypt", false }, { "templateData", "{\"paid\": true,\"invoice_id\": \"0021\",\"invoice_date\": \"August 29, 2041\",\"invoice_dateDue\": \"September 29, 2041\",\"issuer_name\": \"Sarah Connor\",\"issuer_company\": \"T-800 Research Lab\",\"issuer_address\": \"435 South La Fayette Park Place, Los Angeles, CA 90057\",\"issuer_website\": \"www.example.com\",\"issuer_email\": \"info@example.com\",\"client_name\": \"Cyberdyne Systems\",\"client_company\": \"Cyberdyne Systems\",\"client_address\": \"18144 El Camino Real, Sunnyvale, California\",\"client_email\": \"sales@example.com\",\"items\": [ { \"name\": \"T-800 Prototype Research\", \"price\": 1000.00 }, { \"name\": \"T-800 Cloud Sync Setup\", \"price\": 300.00 } ],\"discount\": 100,\"tax\": 87,\"total\": 1287,\"note\": \"Thank you for your support of advanced robotics.\"}" } }; // Convert dictionary of params to JSON string jsonPayload = JsonConvert.SerializeObject(parameters); try { // Send POST request asynchronously var content = new StringContent(jsonPayload, System.Text.Encoding.UTF8, "application/json"); HttpResponseMessage response = await httpClient.PostAsync(url, content); // Read response asynchronously string responseBody = await response.Content.ReadAsStringAsync(); JObject json = JObject.Parse(responseBody); if (json["error"].ToObject() == false) { // Get Job ID for asynchronous processing string jobId = json["jobId"].ToString(); Console.WriteLine($"Job ID: {jobId}"); // Check job status in a loop bool isJobCompleted = false; while (!isJobCompleted) { string status = await CheckJobStatusAsync(httpClient, jobId); Console.WriteLine($"Job Status: {status}"); if (status == "success") { // Get URL of generated PDF file string resultFileUrl = json["url"].ToString(); // Download PDF file asynchronously byte[] fileBytes = await httpClient.GetByteArrayAsync(resultFileUrl); await File.WriteAllBytesAsync(DestinationFile, fileBytes); Console.WriteLine("Generated PDF file saved as \"{0}\" file.", DestinationFile); isJobCompleted = true; } else if (status == "working") { // Wait for a few seconds before checking again await Task.Delay(3000); } else { Console.WriteLine($"Job failed or aborted. Status: {status}"); isJobCompleted = true; } } } else { Console.WriteLine(json["message"].ToString()); } } catch (Exception e) { Console.WriteLine(e.ToString()); } } Console.WriteLine(); Console.WriteLine("Press any key..."); Console.ReadKey(); } static async Task CheckJobStatusAsync(HttpClient httpClient, string jobId) { string url = $"https://api.pdf.co/v1/job/check?jobid={jobId}"; // Send GET request to check job status HttpResponseMessage response = await httpClient.GetAsync(url); string responseBody = await response.Content.ReadAsStringAsync(); JObject json = JObject.Parse(responseBody); return json["status"].ToString(); } } } ``` ```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 { /* Please follow below steps to create your own HTML Template and get "templateId". 1. Add new html template in app.pdf.co/templates/html 2. Copy paste your html template code into this new template. Sample HTML templates can be found at "https://github.com/pdfdotco/pdf-co-api-samples/tree/master/PDF%20from%20HTML%20template/TEMPLATES-SAMPLES" 3. Save this new template 4. Copy it’s ID to clipboard 5. Now set ID of the template into “templateId” parameter */ // HTML template using built-in template // see https://app.pdf.co/templates/html/2/edit final String templateId = "2"; // Data to fill the template final String templateData = new String(Files.readAllBytes(Paths.get(".\\invoice_data.json"))); // 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 query = String.format( "https://api.pdf.co/v1/pdf/convert/from/html?name=%s", destinationFile.getFileName()); // Make correctly escaped (encoded) URL URL url = null; try { url = new URI(null, query, null).toURL(); } catch (URISyntaxException e) { e.printStackTrace(); } // Prepare request body in JSON format JsonObject jsonBody = new JsonObject(); jsonBody.add("templateId", new JsonPrimitive(templateId)); jsonBody.add("templateData", new JsonPrimitive(templateData)); 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, "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 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.