Convert documents
curl -H "X-Api-Key: $KEY" -F files=@report.docx \ http://localhost:9027/v1/convert -o report.pdfimport { openAsBlob } from 'node:fs';import { writeFile } from 'node:fs/promises';
const form = new FormData();form.append('files', await openAsBlob('report.docx'), 'report.docx');
const response = await fetch('http://localhost:9027/v1/convert', { method: 'POST', headers: { 'X-Api-Key': process.env.KEY }, body: form,});if (!response.ok) throw new Error(await response.text());await writeFile('report.pdf', Buffer.from(await response.arrayBuffer()));import osfrom pathlib import Path
import requests
response = requests.post( "http://localhost:9027/v1/convert", headers={"X-Api-Key": os.environ["KEY"]}, files=[("files", open("report.docx", "rb"))],)response.raise_for_status()Path("report.pdf").write_bytes(response.content)package main
import ( "bytes" "io" "log" "mime/multipart" "net/http" "os" "path/filepath")
func main() { var body bytes.Buffer form := multipart.NewWriter(&body) attach(form, "files", "report.docx") form.Close()
request, err := http.NewRequest("POST", "http://localhost:9027/v1/convert", &body) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY")) request.Header.Set("Content-Type", form.FormDataContentType())
response, err := http.DefaultClient.Do(request) if err != nil { log.Fatal(err) } defer response.Body.Close() if response.StatusCode >= 300 { message, _ := io.ReadAll(response.Body) log.Fatalf("%s: %s", response.Status, message) }
out, err := os.Create("report.pdf") if err != nil { log.Fatal(err) } defer out.Close() if _, err := io.Copy(out, response.Body); err != nil { log.Fatal(err) }}
// attach adds the file at path to the form as the named field.func attach(form *multipart.Writer, field, path string) { file, err := os.Open(path) if err != nil { log.Fatal(err) } defer file.Close() part, err := form.CreateFormFile(field, filepath.Base(path)) if err != nil { log.Fatal(err) } if _, err := io.Copy(part, file); err != nil { log.Fatal(err) }}curl -H "X-Api-Key: $KEY" -F files=@cover.docx -F files=@figures.xlsx \ -F merge=true -F pdfa=PDF/A-2b \ http://localhost:9027/v1/convert -o pack.pdfimport { openAsBlob } from 'node:fs';import { writeFile } from 'node:fs/promises';
const form = new FormData();form.append('files', await openAsBlob('cover.docx'), 'cover.docx');form.append('files', await openAsBlob('figures.xlsx'), 'figures.xlsx');form.append('merge', 'true');form.append('pdfa', 'PDF/A-2b');
const response = await fetch('http://localhost:9027/v1/convert', { method: 'POST', headers: { 'X-Api-Key': process.env.KEY }, body: form,});if (!response.ok) throw new Error(await response.text());await writeFile('pack.pdf', Buffer.from(await response.arrayBuffer()));import osfrom pathlib import Path
import requests
response = requests.post( "http://localhost:9027/v1/convert", headers={"X-Api-Key": os.environ["KEY"]}, files=[("files", open("cover.docx", "rb")), ("files", open("figures.xlsx", "rb"))], data={"merge": "true", "pdfa": "PDF/A-2b"},)response.raise_for_status()Path("pack.pdf").write_bytes(response.content)package main
import ( "bytes" "io" "log" "mime/multipart" "net/http" "os" "path/filepath")
func main() { var body bytes.Buffer form := multipart.NewWriter(&body) attach(form, "files", "cover.docx") attach(form, "files", "figures.xlsx") form.WriteField("merge", "true") form.WriteField("pdfa", "PDF/A-2b") form.Close()
request, err := http.NewRequest("POST", "http://localhost:9027/v1/convert", &body) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY")) request.Header.Set("Content-Type", form.FormDataContentType())
response, err := http.DefaultClient.Do(request) if err != nil { log.Fatal(err) } defer response.Body.Close() if response.StatusCode >= 300 { message, _ := io.ReadAll(response.Body) log.Fatalf("%s: %s", response.Status, message) }
out, err := os.Create("pack.pdf") if err != nil { log.Fatal(err) } defer out.Close() if _, err := io.Copy(out, response.Body); err != nil { log.Fatal(err) }}
// attach adds the file at path to the form as the named field.func attach(form *multipart.Writer, field, path string) { file, err := os.Open(path) if err != nil { log.Fatal(err) } defer file.Close() part, err := form.CreateFormFile(field, filepath.Base(path)) if err != nil { log.Fatal(err) } if _, err := io.Copy(part, file); err != nil { log.Fatal(err) }}Converts uploads and runs any post-processing fields. HTML goes to Fulgur
unless htmlEngine says libreoffice; everything else to LibreOffice.
Several files come back as a ZIP, or as one PDF with merge=true.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”The multipart form /v1/convert and /v1/pdf/convert accept.
LibreOffice options (landscape, nativePageRanges,
exportFormFields, singlePageSheets, password, …) and
post-processing fields (merge, splitMode, watermarkSource,
stampSource, rotateAngle, flatten, metadata, bookmarks,
embeds, facturxXml, userPassword, …) are accepted as well.
object
Images (PNG, JPEG, GIF, SVG), stylesheets and fonts an HTML page names
by file name, as in <img src="logo.png">. Every stylesheet applies to
the whole page. Nothing is fetched from anywhere else.
One or more documents.
What turns HTML into PDF: fulgur (default), a layout engine with
no browser and no network, or libreoffice.
Example
fulgurMerge several inputs into one PDF instead of returning a ZIP.
Example
1-3,5Opens a protected input.
PDF/A level: PDF/A-1b, PDF/A-2b, PDF/A-3b, PDF/A-4.
Export as PDF/UA.
Output format. Default pdf.
Responses
Section titled “Responses”The converted file, or a ZIP of them
The file, as bytes.
Accepted; the result goes to the webhook
The request is wrong
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}An engine is unavailable or the request timed out
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}