Skip to navigation

Convert a file to PDF

View as Markdown

Turns a Word document, a spreadsheet, a presentation, an image or a plain-text file into a PDF, and stores the result as a new file next to the original.

{ref} is the file id or the file name. A file that is already a PDF answers 400 — there is nothing to convert.

The new file carries parentFileId pointing back at the original, and is never indexed for search: the original is the thing that gets indexed.

Learn more: Working with files

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

refstringRequired>=1 character
spaceIdstringRequired

Response

The converted file.
object"file"
idstring
namestring
mimeTypestring
statusenum
Allowed values:
createdAtstring
parentFileIdstringOptional
metadatamap from strings to stringsOptional
errorstringOptional
uploadUrlstringOptional
uploadExpiresAtstringOptional
urlsobjectOptional

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error