Bang!

The all in one API for generating Rodin.

post

The API for Bang a Rodin-generated Asset.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

asset_idstringOptional

strengthnumberOptionalDefault: 5

geometry_file_formatstring · enumOptionalDefault: glbPossible values:

materialstring · enumOptionalDefault: PBRPossible values:

resolutionstring · enumOptionalDefault: BasicPossible values:

requiredanyOptional

Responses

201Success

application/json

post

/api/v2/bang

CLI

curl https://api.hyper3d.com/api/v2/bang \
--request POST \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--file 'asset_id=YOUR_UUID' \
--file "strength=5" \ 
--file "geometry_file_format=glb" \
--file "material=PBR" \
--file "resolution=Basic" \
...

201Success

{
  "error": "text",
  "message": "text",
  "uuid": "text",
  "jobs": {
    "uuids": [
      "text"
    ],
    "subscription_key": "text"
  }
}

Rodin BANG!

Use this API to split a Rodin-generated Asset into multiple submodels.

Note: Only the models generated by Rodin Gen-2 can be used at this node.

Pricing

• Base Cost: 0.5 credit per BANG.

Request

Authentication

This API uses bearer key for authentication. You need to include a valid token in the Authorization header for all requests.

Authorization: Bearer RODIN_API_KEY

Body

Parameter	Type	Description
asset_id	string	Required. UUID of the Rodin Gen-2 Generation Task.
strength	number	Optional, default: 5, range from 2 - 12. This parameter controls the strength of the splitting of the model. The larger the value, the more pieces there will be.
geometry_file_format	string	Required. File format for the generated geometry files. Supported formats: glb, obj, fbx, stl, usdz. Default: glb.
material	string	Optional. The material type. Possible values are PBR, Shaded, None and All. Default is PBR. PBR: Physically Based Materials, including base color texture, metallicness texture, normal texture and roughness texture, providing high realism and physically accurate over dynamic lighting. Shaded: Only base color texture with baked lighting, providing stylized visuals. None: Asset without material. All: Both PBR and Shaded will be delivered.
resolution	string	Optional. The resolution of the generated texture assets. Possible values are Basic and High. Default is Basic. Basic: 2K resolution. High: 4K resolution.

Response

Use the uuid field instead of the jobs.uuids field for your requests to Check Status and Download Results API endpoints.

Property	Type	Description
error	string	Error message, if any.
message	string	Success message or detailed error information.
uuid	string	Unique identifier for the generated task.
jobs	object	A job object, containing details of individual jobs executed as part of the generation process.
jobs.uuids	array of strings	UUIDs of the sub-jobs.
jobs.subscription_key	string	Subscription key associated with these jobs.

Examples

Request with cURL

export RODIN_API_KEY="your api key"
curl https://api.hyper3d.com/api/v2/bang \
  -H "Authorization: Bearer ${RODIN_API_KEY}" \
  -F "asset_id=YOUR_UUID" \
  -F "strength=5" \
  -F "geometry_file_format=glb" \
  -F "material=PBR" \
  -F "resolution=Basic" \
unset RODIN_API_KEY

Request with Python 3

Response