Convert Office documents to PDF seamlessly
To convert an Office file to a PDF, send a request to the /api/build
endpoint(opens in a new tab), including both the Office file as input and the instructions
JSON(opens in a new tab).
The default output from the /api/build
endpoint is a PDF file. You can also specify other file types. Learn more about the output options in our API Reference(opens in a new tab).
- Ensure Document Engine is up and running.
- Send a multipart POST request(opens in a new tab) with instructions to Document Engine’s
/api/build
endpoint.
For more information, refer to the API reference to learn about the /api/build
endpoint and all the actions you can perform on PDFs with Document Engine.
For an overview of multipart requests, refer to the brief tour of multipart requests blog post.
Converting an Office File from Disk
Send a multipart request to the /api/build
endpoint(opens in a new tab) and attach an Office file:
curl -X POST http://localhost:5000/api/build \ -H "Authorization: Token token=<API token>" \ -F document=@/path/to/example-document.docx \ -F instructions='{ "parts": [ { "file": "document" } ]}' \ -o result.pdf
POST /api/build HTTP/1.1Content-Type: multipart/form-data; boundary=customboundaryAuthorization: Token token=<API token>
--customboundaryContent-Disposition: form-data; name="document"; filename="example-document.docx"Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
<DOCX data>--customboundaryContent-Disposition: form-data; name="instructions"Content-Type: application/json
{ "parts": [ { "file": "document" } ]}--customboundary--
Converting an Office File from URL
Send a multipart request to the /api/build
endpoint(opens in a new tab), attaching a URL pointing to the Office file:
curl -X POST http://localhost:5000/api/build \ -H "Authorization: Token token=<API token>" \ -F instructions='{ "parts": [ { "file": { "url": "https://pspdfkit.com/downloads/examples/paper.docx" } } ]}' \ -o result.pdf
POST /api/build HTTP/1.1Content-Type: multipart/form-data; boundary=customboundaryAuthorization: Token token=<API token>
--customboundaryContent-Disposition: form-data; name="instructions"Content-Type: application/json
{ "parts": [ { "file": { "url": "https://pspdfkit.com/downloads/examples/paper.docx" } } ]}--customboundary--