MeshifAI API Reference

Core API

Meshifai.GenerateModel

The primary method for generating 3D models from text descriptions.

public static object GenerateModel(
    string prompt,
    Action<GameObject> onComplete,
    Action<string> onError = null,
    Action<string, float> onStatus = null,
    float variance = 0.2f,
    bool applyDefaultMaterial = true
)

Parameters

Parameter
Type
Description

prompt

string

Text description of the model to generate

onComplete

Action<GameObject>

Callback when generation completes successfully

onError

Action<string>

(Optional) Callback when an error occurs

onStatus

Action<string, float>

(Optional) Callback for status updates (message and progress 0-1)

highRes

bool

(Optional) Controls the output quality of the genereted model

applyDefaultMaterial

bool

(Optional) Whether to apply a default material

Returns

  • object: A handle that can be used to cancel the generation

Example

Meshifai.CancelGeneration

Cancels an in-progress model generation.

Parameters

Parameter
Type
Description

handle

object

The handle returned by GenerateModel

Example

Meshifai.CloneModel

Creates a copy of an existing MeshifAI-generated model, preserving all metadata.

Parameters

Parameter
Type
Description

originalModel

GameObject

The original model to copy

Returns

  • GameObject: A new copy of the model with all generation data preserved

Example

ModelGenerationData Component

Each generated model has a ModelGenerationData component attached that contains information about how it was created.

Properties

Property
Type
Description

Prompt

string

The text description used to generate the model

highRes

bool

Controls the output quality of the genereted model

GenerationTime

DateTime

When the model was generated

Example

Need Support? Feel free to reach out to us over [email protected] or twitter on @0xretrodev

Last updated