Assets

Individual files in the Asset Store. Every uploaded binary — image, PDF, archive, video — is an asset record. Assets can live inside a Folder or at the root level, and can be exposed externally via Shares.

Scopes

Scope	Reach
store:read	Listing, reading, downloading, viewing shares.
store:write	Uploading, updating, patching, deleting.

Endpoints

List Assets

GET /api/store/asset/

Returns a page of asset records.

Required scope: store:read · also accepts API key

Query parameters — standard pagination set; see Conventions › Pagination.

Name	Type	Default	Notes
cursor	string	—	Cursor token.
limit	integer	50	1–250.
sort_by	string	created	Any sortable field.
sort_order	string	desc	asc or desc.
hydrate	boolean	true	See Hydration.
include_total	boolean	true	Skip count for faster pages.

Response 200 — AssetInDbCursorPage

Get Asset Filter Metadata

GET /api/store/asset/filters

Returns the filter/operator/sort options accepted by List Assets. See Conventions › Filter Metadata.

Required scope: store:read

Response 200 — open metadata object.

Get Asset by ID

GET /api/store/asset/{id}

Returns a single asset by ID.

Required scope: store:read · also accepts API key

Path parameters

Name	Type	Required	Description
id	string	yes	Asset ID.

Response 200 — AssetRead

Get Asset Shares

GET /api/store/asset/{id}/shares

Lists every share record that targets a given asset.

Required scope: store:read

Path parameters

Name	Type	Required	Description
id	string	yes	Asset ID.

Response 200 — array of share records.

Download Assets

GET /api/store/asset/download?id=<id1>&id=<id2>…

Downloads one or more assets. Multiple id query parameters can be supplied to bundle several assets into a single archive download.

Required scope: store:read

Query parameters

Name	Type	Required	Description
id	string (repeated)	yes	One or more asset IDs. Repeat the parameter for each asset.

Response 200 — binary stream (single asset payload, or zip of multiple).

Upload Asset

POST /api/store/asset/upload

Uploads a new asset (file bytes via multipart/form-data).

Required scope: store:write

Query parameters

Name	Type	Description
folder	string	Optional folder ID to place the asset in. Defaults to the root level when omitted.

Request body — Body_Assets-Upload_Asset (multipart/form-data). Send the file bytes in the documented file field.

Max upload size: 100 MB per request — see Conventions › Uploads.

Response 201 — AssetRead

Update Asset by ID

PUT /api/store/asset/{id}

Replaces the asset metadata (the file payload is unchanged — re-upload is the only way to swap the bytes).

Required scope: store:write

Path parameters

Name	Type	Required	Description
id	string	yes	Asset ID.

Request body — AssetWriteReplace

Response 200 — AssetRead

Patch Asset

PATCH /api/store/asset/{id}

Partial metadata update — supply only the fields you want to change.

Required scope: store:write

Path parameters

Name	Type	Required	Description
id	string	yes	Asset ID.

Request body — AssetWriteUpdate

Response 200 — AssetRead

Delete Asset by ID

DELETE /api/store/asset/{id}

Removes the asset record and its underlying file.

Required scope: store:write

Path parameters

Name	Type	Required	Description
id	string	yes	Asset ID.

Response 204 — empty.

WARNING

Deletion is irreversible and cascades to active Shares that pointed at the asset. Existing share links 404 after the asset is gone.

See also

• Folders — containers for assets.
• Shares — external token-based access to assets.
• Asset Store › Workflow — end-to-end upload + share example.