openbambuapi Documentation

The MakerWorld / Design Services API provides access to Bambu Lab's 3D model sharing platform. It manages 3D models (designs), print profiles (instances), social features, and downloads.

Base URLs:

• https://api.bambulab.com/v1
• https://makerworld.com/api/v1 (Note: This version is Cloudflare-protected)

Authentication: All endpoints require a Bearer JWT authentication token.

Bambu's network plugin surfaces off-LAN video access through a single bambu:///… URL scheme. If you are building a custom client to consume video without using the proprietary network plugin, you must recognize the URL prefix and implement the corresponding transport.

If you are re-implementing the bambu_network_get_camera_url callback, you can return these URL forms to allow the existing libBambuSource.so to handle the transport automatically.

bambu:///tutk?uid=<UID>&authkey=<KEY>&passwd=<PW>&region=<R>
bambu:///agora?app=<APP>&...
bambu:///local/<host>?...
bambu:///rtsps___<rtsps-url>
bambu:///rtsp___<rtsp-url>

The Bambu Handy app utilizes the ThroughTek Kalay (TUTK) protocol for P2P camera streaming to printers. Developers working with camera streaming should be aware of the following components and modes:

• SDK Libraries: libIOTCAPIs, libAVAPIs, libTUTKGlobalAPIs.
• Connection Methods: IOTC_Connect_ByUID_Parallel, IOTC_Connect_ByUIDEx.
• Authentication Modes: AV_AUTH_PASSWORD, AV_AUTH_TOKEN, AV_SECURITY_DTLS.
• Data Transmission Modes: IOTC_DATA_TRANSMIT_INTEGRITY_MODE, IOTC_DATA_TRANSMIT_COMPATIBILITY_MODE, IOTC_DATA_TRANSMIT_ADAPTATION_MODE.
• Region Configuration: Use TUTK_SDK_Set_Region to set the appropriate region.

The network plugin reports its own version independently of the BambuStudio slicer version. The version string follows the format bambu_network_agent/XX.XX.XX.XX (e.g., bambu_network_agent/02.07.00.50).

When correlating bug reports or log files, use the agent version string rather than the slicer's user-facing version to identify the network layer state.

The M620 and M621 commands are used to create conditional branches for AMS operations. If a condition (like "Enable AMS") is not met, the printer skips all commands until the matching M621 end-of-branch command is found.

AMS Commands:

• M620 C#: Calibrate AMS by index #.
• M620 R#: Refresh AMS by tray index #.
• M620 P#: Select AMS tray by index #.
• M620 S#: Starts a branch (e.g., for unloading filament).
• M621 S#: Ends a branch started by M620 S#.
• M620 S#A: Starts a branch specifically for filament changes during print.
• M621 S#A: Ends a branch started by M620 S#A.

To ensure the signature is valid, the payload must be canonicalized before signing. The signing input is constructed as:

bytes_to_sign = '{"<top-key>":' + canonical_json(envelope[<top-key>]) + '}'

Canonical JSON Rules:

• Keys must be sorted alphabetically (recursively at every depth).
• No whitespace allowed anywhere.
• Only , and : are used as separators.

In Python, use json.dumps(payload, sort_keys=True, separators=(',', ':')) to achieve this.

import json
# Example of canonicalization
json.dumps(payload, sort_keys=True, separators=(",", ":"))

All MQTT messages are JSON encoded. Communication follows a request/report pattern using a sequence_id to match responses to commands.

Request Structure

Requests include a sequence_id (which should be incremented by 1 for each new command) and the command name.

Report Structure

Reports include the same sequence_id used in the request, the command name, and a result field (case-insensitive, e.g., "success"). A reason field may be included if the command failed.

// Request
{
    "{TYPE}": {
        "sequence_id": "0",
        "command": "{COMMAND}"
    }
}

// Report
{
    "{TYPE}": {
        "sequence_id": "0",
        "command": "{COMMAND}",
        "result": "success",
        "reason": "",
        ...
    }
}

To ensure you are communicating with the correct printer and to avoid hostname mismatch errors (e.g., [ERR_TLS_CERT_ALTNAME_INVALID]), you must use Server Name Indication (SNI).

Because the printer's certificate contains the printer's serial number in the Common Name (CN) field, connecting via a raw IP address (like 192.168.0.5) will fail validation unless SNI is used to tell the server which hostname you are expecting.

If your library does not support SNI, you must manually verify the certificate's common name or disable hostname validation (not recommended).

The print.push_status report provides the current state of the printer. The behavior of this report differs by hardware series:

• X1 Series: Always responds with the full status object.
• P1 Series: To optimize performance, the P1P only responds with values that have changed since the last report. To retrieve the complete status object on a P1 series device, use the pushing.pushall request.