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 a request. Start here if you have not run it yet.

🛠️ Release Notes

What changed in v3.0.0, and how to move from the version before.

🔍 Core Concepts

What a dimension must be, fit against pack, and what each algorithm does.

📡 API

The endpoints and their shapes. V3 is stable; V4 is experimental and adds the Best algorithm.

🧰 Generate a Client

A typed client from the published OpenAPI documents - hey-api for TypeScript, Kiota for C#.

🔧 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, including one for running behind your own backend.

🗜️ ViPaq Protocol

The compact format the packing endpoints return. Stable from v3.0.0.

🔏 Verifying a Release

Check the signature and read the bill of materials of a published image.