You are reading the documentation for v2.1.1, which is not the current version. It describes that release and is kept for reference. It is not updated.Go to v3.1.0 →
Welcome to Binacle.Net Docs!
Binacle.Net answers which box an order goes in, in milliseconds. Give it your box sizes and a list of items and it returns the smallest box that holds them, and where every item sits. It is a free and open source 3D bin packing API that you run yourself, shipped as a Docker image.
These docs cover the HTTP API, configuration, deployment, and the ViPaq result format. If you just want to see it work, start with the quick start.
🚀 Quick Start
One docker run, then the URLs to open. Start here if you have not run it yet.
🛠️ Release Notes
What changed in each v2 release, and how to move from v1.
🔍 Core Concepts
What a dimension must be, fit against pack, and what each algorithm does.
📡 API
The endpoints and their shapes. V2 has a fixed algorithm; V3 lets you choose one.
🔧 Configuration
The files under /app/Config_Files, how to override a setting, and one page per module.
📦 Samples
Docker Compose and Kubernetes setups to copy.
🗜️ ViPaq Protocol
The compact format the V3 packing endpoint returns. Experimental in this line.