FigureCollection.download_original¶
Download original stored figure content as JSON, optionally writing to path.
H-14 has no dedicated download endpoint. Fetch the current figure or a
revision and serialize its stored data/layout/frames/config JSON. This
preserves the original content, including unsupported traces. It is not
a byte-for-byte S3 download: JSON storage can reorder nested object keys,
so these bytes cannot be checked against original_upload_hash.
Never renders HTML or executes code.
Signature¶
download_original(figure_id: str, *, revision: int | None=None, path: str | Path | None=None) -> bytes
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
figure_id |
str |
yes | - |
revision |
int \| None |
no | None |
path |
str \| Path \| None |
no | None |
Fields¶
| Field |
|---|
figure_id |
revision |
path |
Return shape¶
bytes
Permission¶
This is a local SDK helper. It does not call the CloudSprite HTTP API.
Usage¶
figure_collection.download_original(figure_id)