Overview:

The Artefacts API enables you to integrate Artefacts' Image-to-3D, Text-to-3D, Refine a Mesh, and Triangular Mesh-to-Quad capabilities into your application. This section provides all the information you need to get started with the API. Task model represents a work unit that Artefacts tracks to generate a 3D model from an image, text, or 3D model input. The model has the following properties:

Endpoints

Image to 3D

https://api.aeonlabs.xyz/api/tasks/image_to_model

• image_url (string): The URL of the input image file used to generate the model.

• callback_url (string): The URL where notifications about the task status will be sent.

Text to Model

https://api.aeonlabs.xyz/api/tasks/image_to_model

• prompt (string): The input text prompt used to generate the 3D model.

• callback_url (string): The URL where notifications about the task status will be sent.

Task Detail

https://api.aeonlabs.xyz/api/tasks/detail

• task_id (string): The task ID for the model.

POST /CallbackURL

Callback Response

After a task is completed, the API will send a callback to the specified URL with the task results.

Callback Response Example

Enum Status

• queued The task is awaiting its turn for processing.

• running: The task is currently ongoing.

• success: The task has been completed successfully. The output values can be used as the final result.

• failed: The task has failed, often due to issues on our end. Please report this along with the task_id for support.

• cancelled: The task has been cancelled.

• unknown: The task’s current status cannot be determined, potentially indicating a problem at the system level. For assistance, please contact our support team with the task_id.