Image to 3D

Unlike TextTo3D, when using an Image you do not need to create a preview task first. The finished task will contain the final output.

Versions

There are two versions of this model available: basic-v1 and premium-v1. When using the Premium version, more options are available.

The Image to 3D Task object

The Image to 3D Task object.

Properties

Name
id
Type
string
Description
Unique identifier for the task.
Name
status
Type
string
Description
The task status. Can be either queued, in_progress, succeeded or failed.
Name
seed
Type
integer
Description
The seed used to create the task.
Name
prompt
Type
string
Description
The text prompt used when creating the task.
Name
negativePrompt
Type
string
Description
The negative text prompt uesd when creating the task.
Name
urls
Type
object
Description
An object containing links to the assets that have been created.
- Name
  albedo
  Type
  string
  Description
  Path to the albedo texture .png file.
- Name
  obj
  Type
  string
  Description
  Path to the .obj 3D model file.
- Name
  thumbnail
  Type
  string
  Description
  Path to the .png preview image for the 3D model.
Name
creditsUsed
Type
integer
Description
The amount of credits used by creating this task.
Name
finishedAt
Type
timestamp
Description
Timestamp of when the task finished processing. Will be null if the task is not yet processed.
Name
createdAt
Type
timestamp
Description
Timestamp of when the task was created.

POST/v1/image-to-3d

Create an Image to 3D task

This endpoint allows you to create a preview task.

Required attributes

Name
image
Type
image
Description
The source image, can be uploaded as multipart/form-data.
Name
prompt
Type
string
Description
Text prompt. 500 characters or less. Only available for basic-v1.

Optional attributes

Name
seed
Type
integer
Description
When you use the same prompt and seed, you will generate the same result. If null or omitted, the server chooses a random seed.
Name
negativePrompt
Type
string
Description
The model will avoid these key words. 500 characters or less.
Name
version
Type
string
Description
Model version, either subnet-v1 or premium-v1.
Name
faceLimit
Type
integer
Description
Constrain the output to a maximum number of faces. If unspecified the AI model will choose the optimal amount.
Name
pbr
Type
boolean
Description
Generate PBR textures for the model.

GET/v1/image-to-3d/:task

Retrieve a task

This endpoint allows you to check the status of a task.

Path parameters

Name
task
Type
uuid
Description
The ID of the task you are checking.

Response

{
    "id": "ab108b29-10f6-11ce-2148-501c69043c07",
    "status": "succeeded",
    "seed": 5823941,
    "prompt": "string",
    "negativePrompt": null,
    "urls": {
        "thumbnail": "string",
        "obj": "string",
        "albedo": "string"
    },
    "creditsUsed": 0,
    "finishedAt": "2024-07-20T18:10:12+00:00",
    "createdAt": "2024-07-20T18:09:23+00:00"
}