Get Generation Status

Use this endpoint to poll the status of a generation request. Replace the requestId with the request from the generation. If the request is still in progress, you will only see the status and progress. If the request is complete, you will see the status, processingTime_s, outputUrl and outputs.

Quotas: This endpoint is subject to request quotas, but are much less strict than the generation endpoints. Try to keep you retries to 10s or greater and you should be fine.

Note that if the request fails, you will be refunded the credits for that request.

API Reference:

GET /status/{requestId}

Function Signature

client = Masterpiecex()
client.status.retrieve(request_id) -> StatusResponseObject

client = Masterpiecex();
client.status.retrieve(requestId): StatusResponseObject

Parameters

Python	Node	Description
request_id: str	requestId: string	The requestId that you want to know the status of.

Returns

StatusResponseObject

Example

import os
from mpx_genai_sdk import Masterpiecex

client = Masterpiecex()
response = client.status.retrieve(
    "request_id",
)
print(response.outputs)

import Masterpiecex from 'mpx-genai-sdk';

const client = new Masterpiecex();
const response = await client.status.retrieve('requestId');

console.log(response.outputs);

Example Response

# Note that these variables are only available when status = complete
print(response.outputs.fbx) # url of fbx version of the generated model
print(response.outputs.glb) # url of glb version of the generated model
print(response.outputs.usdz) # url of usdz version of the generated model
print(response.outputs.thumbnail) # url of the thumbnail image of the model
print(response.output_url) # typically the url of the glb version of the model
print(response.processing_time_s) # time taken to generate the model in seconds
print(response.progress) # approximate progress of the generation in %
print(response.request_id) # the request id assigned to the generation request
print(response.status) # current status of the generation request one of | pending | dispatching | processing | complete | failed

console.log(response.outputs.fbx); // url of fbx version of the generated model
console.log(response.outputs.glb); // url of glb version of the generated model
console.log(response.outputs.usdz); // url of usdz version of the generated model
console.log(response.outputs.thumbnail); // url of the thumbnail image of the model
console.log(response.outputUrl); // typically the url of the glb version of the model
console.log(response.processingTime_s); // time taken to generate the model in seconds
console.log(response.progress); // approximate progress of the generation in %
console.log(response.requestId); // the request id assigned to the generation request
console.log(response.status); // current status of the generation request one of | pending | dispatching | processing | complete | failed

{
  "outputs": {
    "fbx": "https://.../exports/output.fbx",
    "glb": "https://.../exports/output.glb",
    "thumbnail": "https://.../exports/output.png",
    "usdz": "https://.../exports/output.usdz"
  },
  "outputUrl": "https://.../exports/output.glb",
  "processingTime_s": 270.495,
  "progress": 70.495,
  "requestId": "xxxxxxxxxx",
  "status": "pending | dispatching | processing | complete | failed"
}

If the request is still in progress, you will only see the status and progress. If the request is complete, you will see the status, processingTime_s, outputUrl and outputs. Note that for text2image, the outputs will be a list of image urls.