Alpha APIActions

Export Workbook

View as Markdown

Build a styled multi-sheet Excel workbook (.xlsx) from rows you provide, store it in this vault, and return a url plus an artifactId that send_email can attach. Use it when the answer is a table someone will sort, filter or forward. Formatting, freezing and the provenance sheet are automatic. Requires a manager API key, since it stores a file.

Authentication

AuthorizationBearer
Create a personal key in Alpha settings, or use an access token issued to an approved OAuth client.

Request

This endpoint expects an object.
titlestringRequired
What the workbook is about
sheetslist of objectsRequired

One entry per tab: {name, columns:[{header,key,numFmt?}], rows:[{<key>: value}]}

vaultstringOptional

Exact vault id or name from list_vaults. Required whenever the key can reach more than one vault; never guess or use one client’s vault for another.

sourcesstringOptional

Where the numbers came from; goes on the provenance sheet

Response headers

X-Request-IdstringOptional
Stable identifier for tracing this request in Alpha logs.

Response

Export Workbook completed.
datamap from strings to any or list of maps from strings to any
The result returned by the selected Alpha tool.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error