Model management
Retrieve model
Retrieve a generated model by UUID.
POST
/
api
/
retrieveModel
Retrieve model
curl --request POST \
--url https://alb.neural4d.com:3000/api/retrieveModel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'})
};
fetch('https://alb.neural4d.com:3000/api/retrieveModel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://alb.neural4d.com:3000/api/retrieveModel"
payload = { "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const url = 'https://alb.neural4d.com:3000/api/retrieveModel';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'})
};
fetch('https://alb.neural4d.com:3000/api/retrieveModel', 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/retrieveModel"
payload := strings.NewReader("{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/retrieveModel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://alb.neural4d.com:3000/api/retrieveModel");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}", false);
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/retrieveModel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uuid' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"codeStatus": 0,
"message": "Generate model success",
"modelUrl": "https://cos.zmkj.com/afsafr24.glb?AWSAccessKeyId=AKIDodI2mK61Xsfasfsfsa",
"imageUrl": "https://cos.zmkj.com/afsafr24.jpg?AWSAccessKeyId=AKIDodI2mK61Xsfasfsfsa",
"prompts": "a cute bird",
"createdAt": "2024-11-07T05:59:40.000Z",
"sourcePage": "createModel"
}Authorizations
Use the bearer token provided through the Neural4D website.
Body
application/json
Unique job or model identifier returned by a previous create endpoint.
Example:
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
Response
200 - application/json
Model retrieval result
Result status. 0 means completed, 1 means generating, -1 means the token is invalid or expired, -2 means the UUID does not exist, and -3 means generation failed.
Available options:
-3, -2, -1, 0, 1 Retrieval status message.
Download URL for the generated model when available.
Preview image URL for the generated model when available.
Prompt content associated with the generated model.
Model creation timestamp.
Source page marker returned by the service.
Previous
Convert model formatConvert a generated model into a target format and return the download URL. This operation consumes 10 points.
Next
⌘I
Retrieve model
curl --request POST \
--url https://alb.neural4d.com:3000/api/retrieveModel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'})
};
fetch('https://alb.neural4d.com:3000/api/retrieveModel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://alb.neural4d.com:3000/api/retrieveModel"
payload = { "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const url = 'https://alb.neural4d.com:3000/api/retrieveModel';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({uuid: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'})
};
fetch('https://alb.neural4d.com:3000/api/retrieveModel', 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/retrieveModel"
payload := strings.NewReader("{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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/retrieveModel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://alb.neural4d.com:3000/api/retrieveModel");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"uuid\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n}", false);
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/retrieveModel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uuid' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"codeStatus": 0,
"message": "Generate model success",
"modelUrl": "https://cos.zmkj.com/afsafr24.glb?AWSAccessKeyId=AKIDodI2mK61Xsfasfsfsa",
"imageUrl": "https://cos.zmkj.com/afsafr24.jpg?AWSAccessKeyId=AKIDodI2mK61Xsfasfsfsa",
"prompts": "a cute bird",
"createdAt": "2024-11-07T05:59:40.000Z",
"sourcePage": "createModel"
}
