Text to 3D

Use model_generate_fromprompt when you want to generate a 3D model from a text description.

When To Use

  • idea exploration from prompt-only inputs
  • rapid concept generation
  • no source image or source model available

Expected outcome: one or more GLB outputs retrievable by asset_id after completion.

Inputs

  • required input data type: text prompt string
  • recommended: concrete subject, style, and constraints in one prompt

Minimal input object:

{
  "data": "A modern office chair with armrests"
}

Parameters

NameTypeDefaultAllowed valuesPractical guidance
qualitystringhighlow, highUse high for better geometry; use low for faster experiments.
seedinteger-1integerUse fixed value for reproducibility; use -1 for random runs.
texturebooleantruetrue, falseSet true to include textures.

Minimal Runnable Payload

payload = {
    "template": "model_generate_fromprompt",
    "parameters": {
        "quality": "high",
        "texture": True,
        "seed": -1
    },
    "inputs": [
        {
            "data": "A modern office chair with armrests"
        }
    ]
}

Polling And Output Retrieval

  1. Create flow with POST /flows.
  2. Poll GET /flows/{flow_id} until terminal state.
  3. If completed, list outputs via GET /flows/{flow_id}/outputs.
  4. Fetch asset with GET /flows/{flow_id}/outputs/{asset_id}?include_data=true.

For reusable polling/download code, use Template Helpers.

Common Failure Modes

  • empty or vague prompt resulting in poor output quality
  • invalid template field or malformed payload
  • output fetch before completion

Recovery:

  1. strengthen prompt specificity
  2. validate payload shape
  3. retry output retrieval only after completed

See Troubleshooting for HTTP and flow-state error patterns.