API ReferenceAssets

Convert an Excel asset to an Athena sheet

Beta

Convert an uploaded Excel (.xlsx) asset into a new, editable Athena sheet asset — the same conversion the Athena UI performs. The new sheet is created alongside the source Excel asset. Pass run_async for large workbooks to get the sheet immediately and poll athena_metadata.conversionStatus for completion.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
excel_asset_idstringRequired

ID of the Excel (.xlsx) asset to convert into an Athena sheet

passwordstring or nullOptional

Optional password used to decrypt a password-protected workbook. Password-protected workbooks always convert on the ‘legacy’ engine.

run_asyncbooleanOptionalDefaults to false

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.

spreadsheet_enginestring or nullOptional

Engine for the converted sheet (‘rnc’ | ‘legacy’). Defaults to the deployment’s default engine.

Response

Excel asset converted successfully
asset_typestring
Type of the created sheet asset
excel_asset_idstring
ID of the source Excel asset
sheet_asset_idstring
ID of the newly created Athena sheet asset
titlestring
Title of the created sheet asset
conversion_statusstring or null

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.

parent_folder_idstring or null
ID of the sheet asset's parent folder
workspace_idstring or null
ID of the workspace that owns the sheet asset

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error