API Documentation for Servers

Important: Server API is primarily intended for developers of server plugins and custom integrations. There are no official plugins for this API.

Response structure

Main response fields
Main fields
  • content.version is the data format version.
  • content.type is the type of exported content.
  • content.project_id is the source project identifier, if available.
  • content.passengers is the visual part of the model.
  • content.datapack.anim_keyframes is the animation keyframe data.
  • content.datapack.sound_keyframes is the sound keyframe data.
  • content.hitbox contains hitbox creation data.

The exact interpretation of these fields depends on your server-side implementation. The API does not enforce a specific way of processing the data.

The content.project_id field is optional:

  • if the export was made from a user's cloud project, this field contains the cloud project ID;
  • if the export was made from the catalog, this field contains the catalog publication ID;
  • if the export was made in BDEngine without saving, this field is omitted.
Sign up to create and share content.Sign up