Docmost Octri Preview
POST/pdf-export/status

Check the status of a PDF export

Retrieves the status of a PDF export task. Supply its UUID in fileTaskId to check whether the export is ready. The response includes a download URL once the PDF is ready.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

The PDF export task to check.

fileTaskIdstringrequired
The UUID of the export task.

3 status codes
200Returns the export status and a download URL once the PDF is ready.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when access is forbidden or PDF export is not included in the current licence.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the export task cannot be found.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when access is forbidden or PDF export is not included in the current licence. A 404 is returned when the export task cannot be found. fileTaskId must be a UUID identifying the export task.