mint:generate:start
Start Model Generation
start_model_generation
Starts generating a 3D model from a prompt, with an optional reference image.
Parameters
Input schema generated from the registry. Required parameters are tagged.
- prompt
string
- mode
"auto" | "review"
auto is the default and proceeds through final generation; review pauses at preview-ready when the user explicitly wants to inspect, revise, select, or approve previews first.
- display_name_hint
string
- chat_id
string
- image_url
string (URL)
Public direct image URL. Simple share pages with public image metadata may also work.
- source_url
string (URL)
Source-page metadata only. Mint does not fetch this URL; use image_url for reference images.
- riggable_character
object
Set when the user wants a humanoid character suitable for rigging or animation, or explicitly asks for an A-pose or T-pose. Use t_pose by default; use a_pose only when the user explicitly asks for an A-pose.
- contextrequired
string
Describe the user's goal and why this tool helps in 15-25 words. Do not include credentials, personal data, identifiers, URLs, emails, or account addresses.
Example request
{
"prompt": "A plush pink fluffy couch — soft rounded loveseat, pastel pink boucle upholstery, overstuffed cushions, short legs."
}Example response
{
"status": "queued",
"assetType": "model",
"assetId": "mn785pg330fdx30ty4achjv80985ne5z",
"chatId": "j572z3a4b5c6d7e8f9g0h1i2j3",
"chatUrl": "https://mint.gg/chat/j572z3a4b5c6d7e8f9g0h1i2j3",
"chatCreated": true,
"pollIntervalMs": 30000,
"summary": "Model run queued.",
"previewStrategy": "single_image",
"approvalRequiredForFinalGeneration": false,
"nextSteps": [
{
"tool": "wait_for_status",
"action": "wait_for_final",
"description": "Poll until Mint reports final output eligibility before trying to use files in a code project.",
"input": {
"asset_type": "model",
"asset_id": "mn785pg330fdx30ty4achjv80985ne5z",
"until_stage": "final"
}
},
{
"tool": "list_asset_artifacts",
"action": "list_downloadable_artifacts",
"description": "After the asset reaches final, list downloadable artifacts and choose a downloadable artifact_id.",
"input": {
"asset_type": "model",
"asset_id": "mn785pg330fdx30ty4achjv80985ne5z"
}
},
{
"tool": "get_asset_artifact_manifest",
"action": "fetch_artifact_manifest",
"description": "Fetch a ready-to-copy artifact manifest with durable downloadUrls, suggested project paths, and loader hints for code-project imports.",
"input": {
"asset_type": "model",
"asset_id": "mn785pg330fdx30ty4achjv80985ne5z"
}
},
{
"tool": "get_asset_artifact",
"action": "fetch_artifact_download_url",
"description": "Fetch the chosen artifact to receive mintUrl plus downloadUrl for curl, R3F loaders, browser audio, or game runtime code.",
"input": {
"asset_type": "model",
"asset_id": "mn785pg330fdx30ty4achjv80985ne5z",
"artifact_id": "<artifact_id>"
}
}
]
}Use cases
- Kick off a 3D model generation from a text prompt.
- Open the returned chatUrl so the user can watch progress or continue in Mint.
- For R3F templates, follow nextSteps through wait_for_status and get_asset_artifact_manifest, then load the returned downloadUrl with useGLTF(downloadUrl).
Related Mint workflow
AI 3D Model generation →