🔃 Compress

Learn how to compress assets with a query.

The Compress API is only available for the Enterprise plan.

post

https://console.echoAR.xyz/compress
This endpoint allows you to compress a 3D model.
Request
Response
Request
Form Data Parameters
key
required
string
Your API key.
hologramFileType
required
string
A type of hologram. Only 2 form MODEL_HOLOGRAM is supported.
ratio
optional
number
A value between 0 to 1 that represents the compression ration where 1 the original model and 0 is an empty model. For example, 0.3. Default is 1.
fileToCompress
required
string
The model file to compress. Supported formats include .obj, .fbx, .gltf, and .glb.
compressGlb
optional
boolean
True if the output file should also go through lossless compression which dramatically reduces file size but only supports a .glb output and selected 3D players. Default is false.
Response
200: OK
The compressed file will start downloading.
N/A