Sign in

v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
Asset

Uploads a file to our system and returns the new file name used internally.

post/asset/file

Query parameters

compressboolean

When set, forces image compression on or off for this upload, overriding the configured default.

qualityinteger

WebP quality (1..100) to use when compression runs. Falls back to the configured default when null.

maxdiminteger

Maximum width or height in pixels when compression runs. Falls back to the configured default when null.

Response

OK

fileNamestring required

The generated file name used internally to reference the uploaded asset. This is not the original file name and should be used for all subsequent operations on this asset.

warningsstring[] required

Any warnings that might have occurred during the upload.

wasCompressedboolean required

Whether the uploaded file was compressed during processing.

originalSizeBytesinteger nullable

The original size of the uploaded file in bytes, if available. This may be null if the size could not be determined.

finalSizeBytesinteger nullable

The final size of the stored file in bytes after processing (e.g., compression), if available. This may be null if the size could not be determined. If compression was applied, this size may be smaller than the original size.