Image To 3D

This function generates a 3D model (GLB, FBX, USDZ) from an image. You can upload your own image or provide a URL to an image. To upload your own image, first call the assets/create endpoint to create an assetId for the image, then upload the image to our servers using the provided URL. Once you make this function request, make note of the returned requestId. Then call the status endpoint to get the current status of the request. Currently, requests can take ~1-2mins to complete.

API Reference:

POST /functions/imageto3d

Function Signature

client = Masterpiecex()
client.functions.imageto3d(**kwargs) -> GenerateResponseObject

client = Masterpiecex();
client.functions.imageto3d(body, options?): GenerateResponseObject

Parameters

Note that one of imageRequestId or imageUrl must be specified, but not both depending on whether you uploaded a local image, or used an image with a public url.

Python	Node	Description
image_request_id: Optional[str]	imageRequestId?: string	The requestId from the /assets/create endpoint that the image was uploaded to. Do not use this if you have an imageUrl.
image_url: Optional[str]	imageUrl?: string	The URL of the image to use for the generation. Use this instead of imageRequestId if you did not upload the image to our servers using the /assets/create endpoint.
seed: Optional[float]	seed?: number	Seed used to generate the 3D model. If none was specified, a random seed is chosen.
texture_size: Optional[float]	textureSize?: number	Size of the texture to use for the model. Higher values will result in more detailed models but will take longer to process. Must be one of 256, 512, 1024, 2048

Returns

GenerateResponseObject

Example

import os
from mpx_genai_sdk import Masterpiecex

client = Masterpiecex()
response = client.functions.imageto3d(
  image_url="https://.../image.png",
  seed=1,
  texture_size=1024
)
print(response.balance)

import Masterpiecex from 'mpx-genai-sdk';

const client = new Masterpiecex();

const response= await client.functions.imageto3d({
  imageUrl: 'https://.../image.png',
  seed: 1, 
  textureSize: 1024
});

console.log(response.balance);

Example Response

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.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

{
  "balance": 10550,
  "requestId": "xxxxxxxxxxxxx",
  "status": "pending"
}