Optimize a 3D Model

This function optionally reduces the polycount of your model and/or returns a different file format. eg. convert from GLB to USDZ.

API Reference:

POST /components/optimize

Function Signature

client = Masterpiecex()
client.components.optimize(**kwargs) -> CreateResponseObject

client = Masterpiecex();
client.components.optimize(body, options?): CreateResponseObject

Parameters

Python	Node	Description
asset_request_id: str	assetRequestId: string	The assetRequestId can be a requestId from a Generate request (eg. imageto3d) or an assetId from an assets/create request. If you are converting a model you uploaded, please ensure that the model has been uploaded before calling this endpoint.
object_type: str	objectType: string	The objectType is the type of model you are uploading. Currently, we support 'object', 'animal' and 'humanoid'.
output_file_format: str	outputFileFormat: string	The file format you want the model returned in. Currently, we support FBX, GLB and USDZ.
target_ratio: float	targetRatio: number	The ratio of the original polycount that you want to reduce to. eg. 0.5 will reduce the polycount by 50%.

Returns

CreateResponseObject

Example

import os
from mpx_genai_sdk import Masterpiecex

client = Masterpiecex()
response= client.components.optimize(
    asset_request_id="xxxxxxx",
    object_type="humanoid",
    output_file_format="FBX",
    target_ratio=0.5,
)
print(response.asset_url)

import Masterpiecex from 'mpx-genai-sdk';

const client = new Masterpiecex();

const response= await client.components.optimize({
  assetRequestId: 'xxxxxxx',
  objectType: 'humanoid',
  outputFileFormat: 'FBX',
  targetRatio: 0.5,
});

console.log(response.assetUrl);

Example Response

print(response.asset_url) # url of the asset
print(response.balance)  # remaining credits available associated with the account
print(response.request_id) # used to check the the status. Eg., client.status.retrieve(request_id)
print(response.status)  # current status of the request - typically pending on initial submission

console.log(response.assetUrl); // url of the asset
console.log(response.balance); // remaining credits available associated with the account
console.log(response.requestId); // used to check the the status. Eg., client.status.retrieve(requestId)
console.log(response.status); // current status of the request - typically pending on initial submission

{
  "assetUrl": "https://.../upload",
  "balance": 10550,
  "requestId": "xxxxxxxxxxxxx",
  "status": "pending"
}