Skip to main content

Enterprise: Image to 3D Endpoint

Overview

The Image to 3D API generates an 3D character from an image.

caution

Make sure you add your s3 details for realtime server, so you can receive image generated in your bucket. Images generated without s3 details being added will be delete after 24hours

Request

--request POST 'https://modelslab.com/api/v1/enterprise/3d/image_to_3d' \

Make a POST request to https://modelslab.com/api/v1/enterprise/3d/image_to_3d endpoint and pass the required parameters as a request body to the endpoint.

Body Attributes

ParameterDescription
keyYour API Key used for request authorization
foreground_ratioused when removing background is false. Default 0.85
remove_bgshould remoove background or not. false. Value true or false
resolutionresolution of the output. Default is 256
chunk_sizeDefault 8192, higher the better, max 12000
webhookSet an URL to get a POST API call once the image generation is complete.
track_idThis ID is returned in the response to the webhook API call. This will be used to identify the webhook request.

Example

Body

Body
{

"key": "",
"init_image": "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/0335d02b-958a-4a7f-b7e4-a5f1e61efbf1-0.png",
"foreground_ratio": 0.85,
"remove_bg": false,
"resolution": 256,
"chunk_size": 8192,
"webhook": null,
"track_id": null

}

Request

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
"key": "",
"init_image": "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/0335d02b-958a-4a7f-b7e4-a5f1e61efbf1-0.png",
"foreground_ratio": 0.85,
"remove_bg": false,
"resolution": 256,
"chunk_size": 8192,
"webhook": null,
"track_id": null
});

var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};

fetch("https://modelslab.com/api/v1/enterprise/3d/image_to_3d", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));

Response

Example Response
{
"status": "success",
"warning": "",
"id": null,
"generationTime": 10.97,
"output": [
"https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/out/924a461e-87dd-421a-936a-6d789f283d7e.obj"
],
"proxy_links": [
"https://cdn2.stablediffusionapi.com/out/924a461e-87dd-421a-936a-6d789f283d7e.obj"
],
"nsfw_content_detected": false,
"webhook_status": "",
"meta": {
"chunk_size": 8192,
"file_prefix": "924a461e-87dd-421a-936a-6d789f283d7e",
"foreground_ratio": ".85",
"image": "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/generations/0335d02b-958a-4a7f-b7e4-a5f1e61efbf1-0.png",
"remove_bg": true,
"render": false,
"resolution": 256,
"seed": 294618177,
"temp": "no"
}
}