Starts the generation of a new 3D mesh from a text prompt and returns unique IDs used to track and retrieve the result. Must be called from server scripts. You can optionally receive intermediate results, such as the untextured mesh, by providing an intermediateResultCallback function.

After the generation is complete, use LoadGeneratedMeshAsync() to load and display the generated mesh.

Error Codes

Enables generation of multi-mesh geometries according to provided inputs and a schema.

Provide creative direction through inputs: a TextPrompt, an Image to condition on visually, or both. Control the output structure through schema, supplying either a built-in PredefinedSchema or a custom SchemaDefinition that names the parts to produce.

This method throws an error during the generation process for issues like prompt rejection, generation timeouts, schema mismatches, or backend service errors. It's recommended to wrap it in a pcall() to catch such errors.

See this guide for more detailed examples including usage of a Behaviors module to connect functional behaviors to generated models.

Retrieves and loads a mesh generated by GenerateMeshAsync() using the provided generationId. Must be called from client scripts.

The mesh can be returned as a MeshPart or Model. Because editable meshes are not replicated, the loaded mesh is not replicated to any other clients and can only be loaded once per generationId.