Skip to navigation

Download an asset's file

Beta

Download an asset’s file exactly as Athena stores or serves it — no type coercion, no pagination. Native collaborative assets are converted from live content to their canonical Office format: Athena documents download as .docx, spreadsheets as .xlsx (round-trip faithful — string identifiers, leading zeros, and number formats are preserved), PPTX Studio presentations and Word documents export their live studio content as .pptx/.docx. Uploaded files stream their original bytes. The response sets Content-Disposition with a filename derived from the asset title and media type. With live_sync=true, a spreadsheet’s .xlsx, a PPTX Studio presentation’s .pptx or a Word document’s .docx also carries the Athena for Office add-in’s link record, so opening it in Excel, PowerPoint or Word with the add-in installed starts syncing it with the asset; other asset types ignore the flag. A Word document’s live-sync copy requires EDIT. With read_only=true, a Word document downloads as a plain .docx that Word offers to open read-only (Read-only recommended) and that carries no live-sync link; it requires VIEW, like every download, and cannot be combined with live_sync.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
Unique identifier of the asset to download

Headers

X-Athena-Session-CredentialstringOptional

Query parameters

live_syncbooleanOptionalDefaults to false

Office live sync: when true and the asset is an Athena spreadsheet, a PPTX Studio presentation or a Word document, the downloaded .xlsx / .pptx / .docx carries the Athena for Office add-in’s link record and opens already syncing with this asset; a Word document’s requires EDIT access. Ignored for every other asset type.

read_onlybooleanOptionalDefaults to false

Read-only copy: when true and the asset is a Word document, the downloaded .docx carries no live-sync link and Word’s Read-only recommended setting, so Word offers to open it read-only. Cannot be combined with live_sync. Ignored for every other asset type.

addin_idstring or nullOptional

GUID of the installed add-in manifest the live-sync record should reference (defaults to this deployment’s Athena add-in). Only read together with live_sync; use it to target a preview-channel sideload.

Response

Stream the asset's authoritative file.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error