Text to Image(s)

This function creates one to four images that you can use for further processing. You can use the generated image(s) as input for image to 3d. Use the status endpoint to check the status of the request. Download the image(s) from the outputUrl and then upload to the assets/create endpoint to use with other components/functions.

API Reference:

POST /components/text2image

Function Signature

client = Masterpiecex()
client.components.text2image(**kwargs) -> GenerateResponseObject

client = Masterpiecex();
client.components.text2image(body, options?): GenerateResponseObject

Parameters

Python	Node	Description
prompt: str	prompt: string	The prompt to use for the generation of the image
aspect_ratio: Optional[str]	aspectRatio?: string	The aspect ratio of the image to use for the generation. Allowed values are (1:1, 16:9, 4:3, 3:4, 9:16, 1:2, 2:1)
lora_id: Optional[str]	loraId?: string	The lora id to use for the generation (default is empty string). These selected loras are optimized for the image to 3d component. select from (mpx_plush, mpx_iso, mpx_game)
megapixels: Optional[float]	megapixels?: number	The rough number of megapixels of the image to use for the generation. Allowed values are (1, 2, 4)
num_images: Optional[float]	numImages?: number	The number of images to generate (default is 1, max is 4)
num_steps: Optional[float]	numSteps?: number	The number of steps to use for the generation (default is 4)
output_format: Optional[str]	outputFormat?: string	The format of the image to use for the generation. Allowed values are (png, jpg, webp)
seed: Optional[float]	seed?: number	The seed to use for the generation (default is random)

Returns

GenerateResponseObject

Example

import os
from mpx_genai_sdk import Masterpiecex

client = Masterpiecex()
response = client.components.text2image(
    prompt="cute cartoon dog",
)
print(response.balance)

import Masterpiecex from 'mpx-genai-sdk';

const client = new Masterpiecex();

const response = await client.components.text2image({ prompt: 'cute cartoon dog' });

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"
}