Skip to content

Download rendered artifact

GET/office/documents/{id}/download

Downloads a completed render artifact in the requested format. The format query parameter can be used to request a format other than the default output format if the render job produced multiple formats. Returns the binary document stream.

Request

Path parameters

NameTypeRequiredDescription
idintegerYes

The numeric ID of the document artifact to download.

Query parameters

NameTypeRequiredDescription
formatstringNo

Requested output format. Defaults to the primary format produced by the render job.

One of: "pdf", "docx", "odt", "xlsx", "ods", "pptx", "odp"

Responses

200 Document binary stream

Content type application/pdf, string (binary).

Content type application/vnd.openxmlformats-officedocument.wordprocessingml.document, string (binary).

404 Document artifact not found

422 Requested format not available for this document — it was not rendered in that format

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/office/documents/{id}/download" \
  -H "Accept: application/json"
Loading