echo3D
🌐 Back to website💻 Go to console📺 Watch workshop💬 Discuss on Slack
  • Introduction
  • Quickstart
    • 🔑Register
    • 💻Access the Console
    • 🎲Add a 3D Asset
    • 📤Share it with Others
    • ❔Troubleshooting
  • Web Console
    • 📦Load a Collection
    • 💼Manage Pages
      • Content Page
        • Assets and Targets
        • Add Content
        • Edit Content
        • Share Content
        • Access Permissions
        • Version Control
        • Asset Hierarchy
        • Bulk Actions on Assets
        • Asset Commenting
        • Activity Sidebar
      • Metadata & Tags Page
        • Collection Taxonomy and Asset Specific Metadata
        • How to Add and Edit Metadata
        • How to Add Associated Files and Text
      • Collections and Sharing Page
        • Users Tab
        • Groups Tab
        • Collections
        • Collection Sharing Tab
        • Asset Sharing Tab
        • Security Tab
      • Customizer Page
      • Model Editor Page
      • Scene Editor Page
    • 🚚Deliver Pages
      • Locations Page
      • Users Page
      • Insights Page
    • 🕛Optimize Pages
      • Convert & Compress Page
    • 🎓Learn Pages
      • Tutorials Page
    • 👤Account Page
      • Profile Tab
      • Email & Password
      • Plans Tab
      • Credit Usage Tab
      • Notifications Tab
      • Delete Account Tab
    • ❓Help Menu
    • ⏬Downloads
    • 🎨Themes
    • 🔎Search
  • API
    • 🧩Objects
    • 🗨️Queries
    • 📊Data
      • 📑What Metadata is Stored
    • 🔼Upload
    • 🔽Download
    • ❌Delete
    • 🌳Entry Hierarchy
    • 🔄Convert
    • 🔃Compress
    • 📁Organize
    • ⏪Version
    • ⏬Locate
    • 🔎Search
    • 🖼️Search by Image or Model
    • Share Content
  • Unity
    • 🔨Installation
    • 🧰Using the SDK
    • 🔧Script Settings
    • 📐Transforming Content
    • 👩‍💻Edit Code
    • 🤳Adding AR Capabilities
    • ❔Troubleshooting
  • Unreal 4
    • 🔨Installation
    • 🧰Using the SDK
    • 🔧Demo Project
  • Web
    • 🔨Installation
    • 🧰Using the Package
  • Scene Viewer
    • 📲Deploy Experience
    • 📐Transforming Content
    • 🔢Embed into Website or App
    • 👩‍💻Add Code
    • ❔Troubleshooting
  • AR.js
    • 📲Deploy Experience
    • 📐Transforming Content
    • 🔢Embed into Website or App
    • ❔Troubleshooting
  • FaceAR
    • 📲Deploy Experience
    • 📐Transforming Content
    • 🔢Embed into Website or App
    • ❔Troubleshooting
  • React Native
    • 📩Fetching Data
    • 👩‍💻Edit Code
    • 🤳Adding AR/VR Capabilities
    • 📐Transforming Content
  • Swift
    • 🔨Installation
    • 🔢Displaying a Model Asset
    • 🤳Adding AR Capabilities
    • 🧰Using the SDK
  • Flutter
    • 🔨Installation
    • 👩‍💻Edit Code
    • 🤳Adding AR Capabilities
  • JavaScript
    • 🔨Installation
    • 🧰Using the SDK
    • 📩Fetching Data
    • 👩‍💻Edit Code
  • Python
    • 🔨Installation
    • 🧰Using the SDK
    • 🔧Demo Project
  • NVIDIA Omniverse
    • 🔨Installation
  • Adobe Substance 3D Painter
    • 🔨Installation
  • 🧰Using the Plugin
  • Blender
    • 🔨Installation
    • 🧰Using the Add-on
  • eCommerce Sites
    • 🛒Shopify
    • 🌐Wix
  • 3D Content
    • 🎨Content Creation
    • 💎Google Poly
    • 📦Objaverse
    • 💫3D Capture Apps
      • MagiScan
      • Qlone
      • ARitize360
      • SCANN3D
      • 3D Scanner
      • Didimo Xperience
      • Scaniverse
      • Metascan3D
      • Polycam3D
      • RealityScan
Powered by GitBook
On this page
  • ​Compress a 3D asset
  • Action Descriptions and Priority
  • 1. Resizing
  • 2. Polygon Reduction
  • 3. echo3d Ultimate Compression
  • 4. Draco Compression
  • 5. gltfpack
  • 6. gltf-transform

Was this helpful?

  1. API

Compress

Learn how to compress assets with a query.

​Compress a 3D asset

POST https://api.echo3D.com/compress

This endpoint allows you to compress a 3D model.

Request Body

Name
Type
Description

key*

string

Your API key.

email*

string

Your email address

userKey*

string

Your authentication key

hologramFileType*

string

A type of hologram. Only 2 form MODEL_HOLOGRAM is supported.

ratio

number

A value between 0 to 1 that represents the compression ratio where 1 the original model and 0 is an empty model. For example, 0.3. Default is 1.

fileToCompress

string

The model file to compress. Supported formats include .obj, .fbx, .gltf, and .glb.

compressGlb

boolean

True if the output file should go through lossless compression which dramatically reduces file size but only supports a .glb output and selected 3D players. Default is false.

gltfpack

boolean

True if the output should include an optimize version of the file using glftpack. Default is false.

tags

string

Command-line parameters for gltfpack. Only cc (produce compressed output) and tc (compress textures) are supported. Use cc,tc to include both.

modelName

string

The name to set for the output file.

modelId

string

The entry ID of the model file to compress.

resize

boolean

True if the output file should be resized. Default is false.

gltftransform

string

secKey

string

ultimateCompress

boolean

True if the output should include an optimize version of the file using echo3D Ultimate Compression. Default is false.

N/A

Action Descriptions and Priority

1. Resizing

If a Compress API call is sent with resize=true,the model will be resized based on the ratio value given.

2. Polygon Reduction

If a Compress API call is sent with no resize parameter or with resize=false, the model will be decimated (poly reduced) based on the ratio value given.

3. echo3d Ultimate Compression

If a Compress API call is sent with no resize parameter or with resize=false and ultimateCompress=true, the model will go through extensive compression which dramatically reduces file size. When compressing a file directly (not an entry), only .gltf and .glb files are supported. Only supports a .glb output and works with selected 3D players. Note that this compression may be lossy.

4. Draco Compression

If a Compress API call is sent with no resize parameter or with resize=false and compressGlb=true, the model will go through lossless Draco compression which reduces file size. Only supports a .glb output and works with selected 3D players.

5. gltfpack

If a Compress API call is sent with no resize parameter or with resize=false, no compressGlb parameter or compressGlb=false, and gltfpack=true, the model will be optimized using the glftpack tool. You should send the file (in .gltf or .glb format) using the fileToCompress parameter, or the entry ID or the Poly model ID using the modelId parameter. You can also add command-line parameters for gltfpack:

  • cc to produce a compressed output.

  • tc to compress textures.

6. gltf-transform

  • gltftransform set to resize.

  • width set to 256.

  • height set to 256.

PreviousConvertNextOrganize

Last updated 3 months ago

Was this helpful?

The gltf-transform command to run (list of commands can be found ).

Your Secret key. Only if enabled through the .

If a Compress API call is sent with no resize parameter or with resize=false, no compressGlb parameter or compressGlb=false, and gltfpack=false, the model will be optimized using the gltf-transform tool. You should set the gltf-transform parameter as the command to run with gltftransform=<COMMAND> (list can be found ), and send the file (in .gltf or .glb format) using the fileToCompress parameter. You can also add command-line parameters for gltftransform, for example:

🔃
here
here
Security page