Uploading Assets

This function creates an asset ID for a model that you want to upload. Use the returned URL to upload your model to our servers. Once you have uploaded your model, you can use the asset ID with our Optimize endpoint to reduce the polycount of your model or return a different file format. eg. convert from GLB to USDZ.

Please ensure that the file name of your uploaded model matches the name field in the request body and that the file type is the correct mime type.

Note that there is no charge for creating an asset ID.

API Reference:

POST /assets/create

Function Signature

client = Masterpiecex()
client.assets.create(**kwargs) -> CreateResponseObject

client = Masterpiecex();
client.assets.create(body, options?): CreateResponseObject

Parameters

Python	Node	Description
description: str	description: string	The description of the asset. eg. "cute dog"
name: str	name: string	The name of the asset
type: str	type: string	The mime type of the asset (eg. model/gltf-binary for GLB files, image/png for PNG files)

Returns

CreateResponseObject

Example

import os
from mpx_genai_sdk import Masterpiecex

response_obj = client.assets.create(
    description="my robot",
    name="robot.png",
    type="image/png",
)
url = response_obj.asset_url
print(url)

payload = "<file contents here>"
headers = {
  'Content-Type': 'image/png',
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

import Masterpiecex from 'mpx-genai-sdk';
import axios from 'axios';

const client = new Masterpiecex();
const response_obj = await client.assets.create({
  description: 'my robot',
  name: 'robot.png',
  type: 'image/png',
});

let data = '<file contents here>';

let config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: response_obj .assetUrl,
  headers: { 
    'Content-Type': 'image/png', 
  },
  data : data
};

async function makeRequest() {
  try {
    const response = await axios.request(config);
    console.log(JSON.stringify(response.data));
  }
  catch (error) {
    console.log(error);
  }
}

makeRequest();

Example Response

print(response.asset_url) # url to PUT the asset file to
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 to PUT the asset file to
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"
}

Use the requestId (node) or request_id(python) when using this with another function. eg. imageto3d

Image mime types might be image/png or image/jpg

3D model mime types might be model/gltf-binary

📘
Note that the return status will always be pending because the assets.create() does not do any processing. There is no need to check the status of this request Id, just use the request Id in any of the other functions that take assets as inputs and use the assetUrl to PUT the asset file to the server.