Generate model with image
Generate 3D models from one uploaded image. Supports model count, mesh quality, target face count, and mesh-only output. Existing defaults are preserved when the new options are omitted.
curl --request POST \
--url https://alb.neural4d.com:3000/api/generateModelWithImage \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'image=(binary)' \
--form modelCount=1 \
--form disablePbr=0 \
--form onlyGenerateMesh=false \
--form mesh_quality=high \
--form faceNum=1000000 \
--form 0.image='@example-file' \
--form 1.image='@example-file'const form = new FormData();
form.append('image', '(binary)');
form.append('modelCount', '1');
form.append('disablePbr', '0');
form.append('onlyGenerateMesh', 'false');
form.append('mesh_quality', 'high');
form.append('faceNum', '1000000');
form.append('0.image', '{
"fileName": "example-file"
}');
form.append('1.image', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://alb.neural4d.com:3000/api/generateModelWithImage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://alb.neural4d.com:3000/api/generateModelWithImage"
files = {
"0.image": ("example-file", open("example-file", "rb")),
"1.image": ("example-file", open("example-file", "rb"))
}
payload = {
"image": "(binary)",
"modelCount": "1",
"disablePbr": "0",
"onlyGenerateMesh": "false",
"mesh_quality": "high",
"faceNum": "1000000"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)import fs from 'fs';
const formData = new FormData();
formData.append('image', '(binary)');
formData.append('modelCount', '1');
formData.append('disablePbr', '0');
formData.append('onlyGenerateMesh', 'false');
formData.append('mesh_quality', 'high');
formData.append('faceNum', '1000000');
formData.append('0.image', await new Response(fs.createReadStream('example-file')).blob());
formData.append('1.image', await new Response(fs.createReadStream('example-file')).blob());
const url = 'https://alb.neural4d.com:3000/api/generateModelWithImage';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}, body: formData};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));const form = new FormData();
form.append('image', '(binary)');
form.append('modelCount', '1');
form.append('disablePbr', '0');
form.append('onlyGenerateMesh', 'false');
form.append('mesh_quality', 'high');
form.append('faceNum', '1000000');
form.append('0.image', '{
"fileName": "example-file"
}');
form.append('1.image', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://alb.neural4d.com:3000/api/generateModelWithImage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://alb.neural4d.com:3000/api/generateModelWithImage"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n(binary)\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modelCount\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"disablePbr\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"onlyGenerateMesh\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mesh_quality\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"faceNum\"\r\n\r\n1000000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://alb.neural4d.com:3000/api/generateModelWithImage")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n(binary)\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modelCount\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"disablePbr\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"onlyGenerateMesh\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mesh_quality\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"faceNum\"\r\n\r\n1000000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();using RestSharp;
var options = new RestClientOptions("https://alb.neural4d.com:3000/api/generateModelWithImage");
var client = new RestClient(options);
var request = new RestRequest("");
request.AlwaysMultipartFormData = true;
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("image", "(binary)");
request.AddParameter("modelCount", "1");
request.AddParameter("disablePbr", "0");
request.AddParameter("onlyGenerateMesh", "false");
request.AddParameter("mesh_quality", "high");
request.AddParameter("faceNum", "1000000");
request.AddFile("0.image", "example-file");
request.AddFile("1.image", "example-file");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "https://alb.neural4d.com:3000/api/generateModelWithImage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n(binary)\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modelCount\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"disablePbr\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"onlyGenerateMesh\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mesh_quality\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"faceNum\"\r\n\r\n1000000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"type": "sys",
"message": "Generating",
"uuids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"uploadedImageUrl": "https://s3.neural4d.com/example.png?sign=xxx.png",
"generationConfig": {
"faceNum": {
"default": 1000000,
"min": 500000,
"max": 1000000,
"value": 1000000
}
}
}Authorizations
Use the bearer token provided through the Neural4D website.
Body
- Option 1
- Option 2
Mesh quality level. Supported values are standard, high, and extra_high.
standard Required input file. The multipart part must use an image/* Content-Type and must not exceed 50 MB.
Target face count. standard accepts 100000 to 500000 and defaults to 500000; high and extra_high accept 500000 to 1000000 and default to 1000000.
100000 <= x <= 500000Number of models to generate.
1 <= x <= 4PBR toggle. Use 0 to enable PBR and 1 to disable it.
0, 1 Whether to generate only the mesh, without texture or PBR output.
Response
Generation job accepted, or the request was rejected by content moderation.
- Option 1
- Option 2
Response source or type marker.
sys "sys"
Generation status message.
Generating UUIDs that can be used to retrieve the generated models.
1 - 4 elementsSigned URL for the uploaded source image, or null when unavailable.
Credits deducted when the value is available.
Normalized face-count configuration applied to this generation request.
Show child attributes
Show child attributes
curl --request POST \
--url https://alb.neural4d.com:3000/api/generateModelWithImage \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'image=(binary)' \
--form modelCount=1 \
--form disablePbr=0 \
--form onlyGenerateMesh=false \
--form mesh_quality=high \
--form faceNum=1000000 \
--form 0.image='@example-file' \
--form 1.image='@example-file'const form = new FormData();
form.append('image', '(binary)');
form.append('modelCount', '1');
form.append('disablePbr', '0');
form.append('onlyGenerateMesh', 'false');
form.append('mesh_quality', 'high');
form.append('faceNum', '1000000');
form.append('0.image', '{
"fileName": "example-file"
}');
form.append('1.image', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://alb.neural4d.com:3000/api/generateModelWithImage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://alb.neural4d.com:3000/api/generateModelWithImage"
files = {
"0.image": ("example-file", open("example-file", "rb")),
"1.image": ("example-file", open("example-file", "rb"))
}
payload = {
"image": "(binary)",
"modelCount": "1",
"disablePbr": "0",
"onlyGenerateMesh": "false",
"mesh_quality": "high",
"faceNum": "1000000"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)import fs from 'fs';
const formData = new FormData();
formData.append('image', '(binary)');
formData.append('modelCount', '1');
formData.append('disablePbr', '0');
formData.append('onlyGenerateMesh', 'false');
formData.append('mesh_quality', 'high');
formData.append('faceNum', '1000000');
formData.append('0.image', await new Response(fs.createReadStream('example-file')).blob());
formData.append('1.image', await new Response(fs.createReadStream('example-file')).blob());
const url = 'https://alb.neural4d.com:3000/api/generateModelWithImage';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}, body: formData};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));const form = new FormData();
form.append('image', '(binary)');
form.append('modelCount', '1');
form.append('disablePbr', '0');
form.append('onlyGenerateMesh', 'false');
form.append('mesh_quality', 'high');
form.append('faceNum', '1000000');
form.append('0.image', '{
"fileName": "example-file"
}');
form.append('1.image', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://alb.neural4d.com:3000/api/generateModelWithImage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://alb.neural4d.com:3000/api/generateModelWithImage"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n(binary)\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modelCount\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"disablePbr\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"onlyGenerateMesh\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mesh_quality\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"faceNum\"\r\n\r\n1000000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://alb.neural4d.com:3000/api/generateModelWithImage")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n(binary)\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modelCount\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"disablePbr\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"onlyGenerateMesh\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mesh_quality\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"faceNum\"\r\n\r\n1000000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();using RestSharp;
var options = new RestClientOptions("https://alb.neural4d.com:3000/api/generateModelWithImage");
var client = new RestClient(options);
var request = new RestRequest("");
request.AlwaysMultipartFormData = true;
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("image", "(binary)");
request.AddParameter("modelCount", "1");
request.AddParameter("disablePbr", "0");
request.AddParameter("onlyGenerateMesh", "false");
request.AddParameter("mesh_quality", "high");
request.AddParameter("faceNum", "1000000");
request.AddFile("0.image", "example-file");
request.AddFile("1.image", "example-file");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "https://alb.neural4d.com:3000/api/generateModelWithImage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n(binary)\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modelCount\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"disablePbr\"\r\n\r\n0\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"onlyGenerateMesh\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mesh_quality\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"faceNum\"\r\n\r\n1000000\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"0.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"1.image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"type": "sys",
"message": "Generating",
"uuids": [
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
],
"uploadedImageUrl": "https://s3.neural4d.com/example.png?sign=xxx.png",
"generationConfig": {
"faceNum": {
"default": 1000000,
"min": 500000,
"max": 1000000,
"value": 1000000
}
}
}
