HelloPDF's API enables developers to convert WebPage's/URL's, HTML, and MHTML to PDF's in real time.
\nYou can authenticate with the API by passing your API Token in the token query parameter.
The API only returns 200 SUCCESS, 400 INVALID PARAMETER, and 500 SERVER ERROR HTTP codes.\nIf you encounter an HTTP 500 Response please contact support@lynndigital.com.
We do not limit concurrent calls. Your \"Max Monthly Conversion Time\" is determined by your subscription. Please visit https://www.hellopdf.co/account for more information.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"12431215","collectionId":"e6248ef3-b30a-4243-a853-a31ea3118370","publishedId":"T1LTdinT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F55"},"publishDate":"2020-08-20T00:45:18.000Z"},"item":[{"name":"https://hellopdf.co/api/pdf","id":"5b834212-0137-4783-8fe0-dd66b0b78847","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hellopdf.co/api/pdf?token=api-token&url=url-to-convert&scale=1&landscape&pageRange&format=Letter&displayHeaderFooter&headerTemplate&footerTemplate&width&height&margin.top&margin.bottom&margin.right&margin.left&store&exportAs=pdf","description":"The headerTemplate and footerTemplate markup have the following limitations:
See the \"Store in S3\" page to view the API response when using the store field.
* = Optional Requirement
All query parameters prefixed by [PRO] are optional and require a Pro or Business subscription to use.
\n","urlObject":{"protocol":"https","path":["api","pdf"],"host":["hellopdf","co"],"query":[{"description":{"content":"API Token
\n","type":"text/plain"},"key":"token","value":"api-token"},{"description":{"content":"WebPage/URL To Convert
\n","type":"text/plain"},"key":"url","value":"url-to-convert"},{"description":{"content":"*PDF Scale: 0.1-1
\n","type":"text/plain"},"key":"scale","value":"1"},{"description":{"content":"*If passed then the PDF will be rendered in Landscape mode
\n","type":"text/plain"},"key":"landscape","value":null},{"description":{"content":"*Range of pages to convert. E.g 1-7
\n","type":"text/plain"},"key":"pageRange","value":null},{"description":{"content":"*PDF Format: Letter|Legal|Tabloid|Ledger|A0|A1|A2|A3|A4|A5|A6
\n","type":"text/plain"},"key":"format","value":"Letter"},{"description":{"content":"[PRO] If passed then the PDF will be rendered with a Header and a Footer
\n","type":"text/plain"},"key":"displayHeaderFooter","value":null},{"description":{"content":"[PRO] HTML Header Template For PDF
\n","type":"text/plain"},"key":"headerTemplate","value":null},{"description":{"content":"[PRO] HTML Footer Template For PDF
\n","type":"text/plain"},"key":"footerTemplate","value":null},{"description":{"content":"[PRO] PDF Width Suffixed With Unit
\n","type":"text/plain"},"key":"width","value":null},{"description":{"content":"[PRO] PDF Height Suffixed With Unit
\n","type":"text/plain"},"key":"height","value":null},{"description":{"content":"[PRO] PDF Top Margin
\n","type":"text/plain"},"key":"margin.top","value":null},{"description":{"content":"[PRO] PDF Bottom Margin
\n","type":"text/plain"},"key":"margin.bottom","value":null},{"description":{"content":"[PRO] PDF Right Margin
\n","type":"text/plain"},"key":"margin.right","value":null},{"description":{"content":"[PRO] PDF Left Margin
\n","type":"text/plain"},"key":"margin.left","value":null},{"description":{"content":"[PRO] If passed then document is stored in AWS. See the \"Store in S3\" page to view the API response.
\n","type":"text/plain"},"key":"store","value":null},{"description":{"content":"[PRO] File Type: pdf|png
\n","type":"text/plain"},"key":"exportAs","value":"pdf"}],"variable":[]}},"response":[{"id":"fb6aea9c-4225-4a5d-aa0f-a87d396835d4","name":"https://hellopdf.co/api/pdf","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hellopdf.co/api/pdf?token=api-token&url=url-to-convert","protocol":"https","host":["hellopdf","co"],"path":["api","pdf"],"query":[{"key":"token","value":"api-token","description":"API Token"},{"key":"url","value":"url-to-convert","description":"WebPage/URL To Convert"},{"key":"scale","value":"1","disabled":true},{"key":"landscape","value":null,"description":"If passed then the PDF will be rendered in Landscape mode","disabled":true},{"key":"pageRange","value":null,"description":"Range of pages to convert. E.g 1-7","disabled":true},{"key":"format","value":"Letter","description":"PDF Format: Letter|Legal|Tabloid|Ledger|A0|A1|A2|A3|A4|A5|A6","disabled":true},{"key":"displayHeaderFooter","value":null,"description":"[PRO] If passed then the PDF will be rendered with a Header and a Footer","disabled":true},{"key":"headerTemplate","value":null,"description":"[PRO] HTML Header Template For PDF","disabled":true},{"key":"footerTemplate","value":null,"description":"[PRO] HTML Footer Template For PDF","disabled":true},{"key":"width","value":null,"description":"[PRO] PDF Width Suffixed With Unit","disabled":true},{"key":"height","value":null,"description":"[PRO] PDF Height Suffixed With Unit","disabled":true},{"key":"margin.top","value":null,"description":"[PRO] PDF Top Margin","disabled":true},{"key":"margin.bottom","value":null,"description":"[PRO] PDF Bottom Margin","disabled":true},{"key":"margin.right","value":null,"description":"[PRO] PDF Right Margin","disabled":true},{"key":"margin.left","value":null,"description":"[PRO] PDF Left Margin","disabled":true},{"key":"store","value":null,"description":"[PRO] If passed then document is stored in AWS. See the \"Store in S3\" page to view the API response.","disabled":true},{"key":"exportAs","value":"pdf","description":"[PRO] File Type: pdf|png","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Unable to preview response. Content-Type: `application/pdf`."}],"_postman_id":"5b834212-0137-4783-8fe0-dd66b0b78847"},{"name":"https://hellopdf.co/api/pdf - (Store in S3)","id":"8cf2e099-caa8-448a-a353-b74e4290bddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hellopdf.co/api/pdf?token=your-api-token&url=url-to-convert&store=yes","description":"The headerTemplate and footerTemplate markup have the following limitations:
Any grey fields are optional. All query parameters prefixed by [PRO] require a Pro or Business subscription to use.
\n","urlObject":{"protocol":"https","path":["api","pdf"],"host":["hellopdf","co"],"query":[{"key":"token","value":"your-api-token"},{"key":"url","value":"url-to-convert"},{"key":"store","value":"yes"}],"variable":[]}},"response":[{"id":"b159f3e1-e4a7-4e34-b67a-9f97910c336e","name":"HelloPDF - Convert and save to AWS S3","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hellopdf.co/api/pdf?token=your-api-token&url=url-to-convert&store=yes","protocol":"https","host":["hellopdf","co"],"path":["api","pdf"],"query":[{"key":"token","value":"your-api-token"},{"key":"url","value":"url-to-convert"},{"key":"store","value":"yes"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 19 Aug 2020 23:32:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3-27=\":443\"; ma=86400, h3-28=\":443\"; ma=86400, h3-29=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"url\": \"https://hellopdf.s3.us-east-2.amazonaws.com/docs/8a3e25f80c093f4f173e3ae531c1b7cec9c37283/5f3db6927e828.pdf\"\n}"}],"_postman_id":"8cf2e099-caa8-448a-a353-b74e4290bddb"},{"name":"https://hellopdf.co/api/pdf/raw","id":"b84fed0b-360d-4ee7-8aca-583fdaf7cde3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n\r\n\tHTML to PDF
\n","urlObject":{"protocol":"https","path":["api","pdf","raw"],"host":["hellopdf","co"],"query":[{"description":{"content":"API Token
\n","type":"text/plain"},"key":"token","value":"api-token"}],"variable":[]}},"response":[{"id":"e6b3eb68-ea76-44d2-87f4-91cfd9d67cf2","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n\r\n\t[V2] MHTML to PDF
\n","urlObject":{"protocol":"https","path":["api","v2","mhtml"],"host":["hellopdf","co"],"query":[],"variable":[]}},"response":[{"id":"084151be-8fe4-468a-988f-419530fcc7da","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://hellopdf.co/api/v2/mhtml"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"321307ff-a5b9-45f2-99bd-a8065737c55c"}]}