outline icon

outline

Interact with outline API

Actions107

Documents → Documents Export

AI-generated

Summary

Export a document from Outline.

Inputs

  • id (required) — Unique identifier for the document. Either the UUID or the urlId is acceptable.
  • paperSize — Paper size for PDF export (e.g., A4, Letter).
  • signedUrls — How long signed URLs should remain valid for attachment links (in seconds).
  • includeChildDocuments — Whether to include child documents in the export. Using this option will always return a zip file.
  • requestOptions — Advanced request configuration including batching, proxy, SSL validation, and timeout.

Output shape

Depends on export options; includesChildDocuments=true returns a zip file containing the document and any child documents.

The operation routes all specified parameters into the request body. If includeChildDocuments is true, the response is always a zip archive.

Examples

Example 1: Export a single document by UUID

{ id: '123e4567-e89b-12d3-a456-426614174000' }

Links

Discussion