Convert an Excel asset to an Athena sheet
Convert an uploaded Excel (.xlsx) asset into an editable Athena sheet — the same conversion the Athena UI performs. By default a new sheet asset is created alongside the source Excel asset; pass run_async for large workbooks to get the sheet immediately and poll its athena_metadata.conversionStatus for completion. With in_place the uploaded file itself becomes the sheet and keeps its asset id (sheet_asset_id is excel_asset_id, and no second asset is created); poll that asset until its media_type is ‘athena/spreadsheet’, or until athena_metadata.sheet_upload_conversion.status is ‘failed’ or ‘skipped’.
Authentication
Headers
Request
ID of the Excel (.xlsx) asset to convert into an Athena sheet
Make the uploaded file itself the Athena sheet, keeping its asset id: sheet_asset_id is excel_asset_id and no second asset is created. Needs edit access to the upload, and takes an .xlsx/.xlsm/.xlsb workbook or a .csv/.tsv file. A password-protected workbook is refused (convert it into a new sheet with password instead), and the sheet is always on the rnc engine. Without run_async the request waits up to about 50 seconds for the conversion; conversion_status ‘converting’ means it is still running. Poll the asset until its media_type is ‘athena/spreadsheet’, or until athena_metadata.sheet_upload_conversion.status is ‘failed’ or ‘skipped’ (with its reason).
Optional password used to decrypt a password-protected workbook. Password-protected workbooks convert on either engine (they are decrypted server-side before an rnc import).
Return the sheet asset immediately and convert in the background. Large workbooks outlive the gateway’s ~60s response window on the synchronous path — with run_async the caller polls athena_metadata.conversionStatus (‘converting’ | ‘completed’ | ‘failed’, with conversionError on failure) instead.
Engine for the converted sheet (‘rnc’ | ‘legacy’). Defaults to the deployment’s default engine.
Response
ID of the Athena sheet: a new asset, or excel_asset_id itself for an in_place conversion
Conversion status for background (run_async) conversions: ‘converting’ immediately after the request. Poll the asset’s athena_metadata.conversionStatus for ‘completed’ | ‘failed’. Null for synchronous conversions, which have already completed. An in_place conversion still running answers ‘converting’ too; see in_place for how to poll it.