Enterprise: Text to 3D Endpoint

• text-to-3d
• image-to-3d
• fetch
• clear cache
• restart server
• system details
• update server

Overview

This endpoint generates an 3d object from a text prompt.

caution

Make sure you add your s3 details for 3d 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/text_to_3d' \

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

Body Attributes

Parameter	Description
key	Your API Key used for request authorization.
prompt	Text prompt with description of the things you want in the image to be generated.
negative_prompt	Items you don't want in the image.
num_inference_steps	Number of denoising steps.
guidance_scale	Scale for classifier-free guidance (minimum: 1; maximum: 20)
foreground_ratio	used when removing background is false. Default 0.85
remove_bg	should remoove background or not. false. Value true or false
resolution	resolution of the output. Default is 256
chunk_size	Default 8192, higher the better, max 12000
webhook	Set an URL to get a POST API call once the image generation is complete.
track_id	This ID is returned in the response to the webhook API call. This will be used to identify the webhook request.

Example

Body

Body

{
    "key" : "",
    "prompt": "Image of a car",
    "negative_prompt" : "low quality",
    "guidance_scale" : 10,
    "num_inference_steps ":  10,
    "foreground_ratio": 0.85,
    "remove_bg": false,
    "resolution": 256,
    "chunk_size": 8192,
    "webhook": null,
    "track_id": null
}

Request

JS

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

var raw = JSON.stringify({
    "key" : "",
    "prompt": "Image of a car",
    "negative_prompt" : "low quality",
    "guidance_scale" : 10,
    "num_inference_steps ":  10,
    "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/text_to_3d", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PHP

<?php

$payload = [
    "key"  => "",
    "prompt" =>  "Image of a car",
    "negative_prompt"  => "low quality",
    "guidance_scale"  =>  10,
    "num_inference_steps " =>   10,
    "foreground_ratio" => 0.85,
    "remove_bg" => false,
    "resolution" => 256,
    "chunk_size" => 8192,
    "webhook" =>  null,
    "track_id" => null
];

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://modelslab.com/api/v1/enterprise/3d/text_to_3d',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NODE

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://modelslab.com/api/v1/enterprise/3d/text_to_3d',
  'headers': {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "key" : "",
    "prompt": "Image of a car",
    "negative_prompt" : "low quality",
    "guidance_scale" : 10,
    "num_inference_steps ":  10,
    "foreground_ratio": 0.85,
    "remove_bg": false,
    "resolution": 256,
    "chunk_size": 8192,
    "webhook": null,
    "track_id": null
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PYTHON

import requests
import json

url = "https://modelslab.com/api/v1/enterprise/3d/text_to_3d"

payload = json.dumps({
    "key" : "",
    "prompt": "Image of a car",
    "negative_prompt" : "low quality",
    "guidance_scale" : 10,
    "num_inference_steps ":  10,
    "foreground_ratio": 0.85,
    "remove_bg": False,
    "resolution": 256,
    "chunk_size": 8192,
    "webhook": None,
    "track_id": None
})

headers = {
  'Content-Type': 'application/json'
}

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

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"key\":\"\",\n  \"prompt\": \"Black african wearing a suit in a corporate meeting\",\n  \"negative_prompt\": \"bad quality\",\n  \"width\": \"512\",\n  \"height\": \"512\",\n   \"safety_checker\": false,\n  \"seed\": 2345,\n  \"sample\":1,\n  \"webhook\": \"\",\n  \"track_id\": 20\n}");
Request request = new Request.Builder()
  .url("https://modelslab.com/api/v1/enterprise/3d/text_to_3d")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Response

{
    "status": "success",
    "warning": "",
    "id": null,
    "generationTime": 20.85,
    "output": [
        "https://pub-3626123a908346a7a8be8d9295f44e26.r2.dev/out/3dfadd74-05e3-40cc-969a-96196d239162.obj"
    ],
    "proxy_links": [
        "https://cdn2.stablediffusionapi.com/out/3dfadd74-05e3-40cc-969a-96196d239162.obj"
    ],
    "nsfw_content_detected": false,
    "webhook_status": "",
    "meta": {
        "chunk_size": 8192,
        "file_prefix": "3dfadd74-05e3-40cc-969a-96196d239162",
        "foreground_ratio": ".85",
        "guidance_scale": 10,
        "negative_prompt": "low quality",
        "num_inference_steps": 10,
        "prompt": "Image of a car",
        "remove_bg": true,
        "render": false,
        "resolution": 256,
        "seed": 1782676780,
        "temp": "no"
    }
}