convert.url
Render a public web page to a PDF (hosted integration; private addresses are refused).
POST /v1/convert/url
| Input | one file, sent as multipart/form-data; the optional options part is a JSON object |
| Output | one PDF |
| Credits | 1 credit per page |
| Limits | [size, page and time limits: no claim ID yet] |
| Reads or changes the document | reads only |
| Error statuses | 400, 413, 422, 500, 501, 504 (see Errors) |
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
url |
string | yes | A public http or https URL (ports 80 and 443), with no credentials in it. Private, loopback, link-local and metadata addresses are refused before the page is requested, and again through redirects and sub-resources. |
Example
Section titled “Example”curl -sS -f -X POST "$PDFLUENT_API_URL/v1/convert/url" \ -H "x-api-key: $PDFLUENT_API_KEY" \ -F 'options={"url":"https://example.com/"}' \ -o result.pdfimport jsonimport os
import requests
options = {"url": "https://example.com/"}
parts = [ ("options", (None, json.dumps(options))),]
response = requests.post( os.environ["PDFLUENT_API_URL"] + "/v1/convert/url", headers={"x-api-key": os.environ["PDFLUENT_API_KEY"]}, files=parts,)response.raise_for_status()
with open("result.pdf", "wb") as out: out.write(response.content)import { openAsBlob } from 'node:fs';import { writeFile } from 'node:fs/promises';
const form = new FormData();form.append('options', JSON.stringify({"url":"https://example.com/"}));
const response = await fetch(process.env.PDFLUENT_API_URL + "/v1/convert/url", { method: 'POST', headers: { 'x-api-key': process.env.PDFLUENT_API_KEY }, body: form,});if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
await writeFile("result.pdf", Buffer.from(await response.arrayBuffer()));The key goes in the x-api-key header; see Authentication. Every response carries x-pdfluent-pages and x-pdfluent-credits.