Skip to navigation
API ReferenceAssets

Turn an uploaded HTML file into a user interface

Beta

Turn an uploaded HTML file into a user interface (an app) under its own id — the conversion the Athena app’s Convert to user interface performs. The asset keeps its id, folder, links and sharing (its title drops the .html extension), and no second asset is created. An uploaded HTML file stays a file until a request like this one asks: nothing converts on its own. The switch is one-way; the original upload stays downloadable from the asset’s Versions pane. Requires edit access to the file. Idempotent: an asset that already is a user interface is answered as it is, with converted false. A refused conversion answers with a detail object: code CONVERSION_REFUSED, the reason, and a message saying why.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired
ID of the uploaded HTML file to turn into a user interface

Headers

X-Athena-Session-CredentialstringOptional

Response

The asset is a user interface under its own id
asset_idstring

ID of the user interface: the HTML file’s own id, which it keeps (no second asset is created)

asset_typestring

Type of the asset after the request: user_interface

convertedboolean

True when this request converted the file; false when the asset already was a user interface, in which case nothing changed

titlestring
Title of the user interface
parent_folder_idstring or nullOptional
ID of the asset's parent folder, which the conversion keeps
workspace_idstring or nullOptional
ID of the workspace that owns the asset

Errors

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