Embroidery Effect
td_embroidery_effectRender a design as embroidery with Indian craft and classic stitch styles; preview before sampling and get saved output paths.
Instructions
Embroidery Effect: render the design as embroidery. Stitch types: bandhani, kantha, chikankari, zardozi, phulkari, aari, satin, chain, cross, running, french_knot. 13 credits. Best for: previewing a design as realistic embroidery or Indian craftwork (e.g. Zardozi, Chikankari, Phulkari) before sampling. Result files are saved to disk and their paths returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dpi | No | Output resolution in ppi (72-500). Omit to keep the image's own resolution. | |
| wait | No | Wait for the job and save the outputs (default true). false returns the task_id right after submit. | |
| image | Yes | Source image: a local file path or an http(s) URL. PNG, JPEG or WebP, up to 80 MB and 5000 px per side. | |
| density | No | Stitch Density: sparse (Sparse): Open stitching with visible base fabric. moderate (Moderate, Recommended): Balanced coverage, standard hand-embroidery. dense (Dense): Tightly packed, full thread coverage. Required: pass the mode the user named. If the user did not name one, omit it and the tool returns the modes to show them; never choose for the user. | |
| output_dir | No | Folder to save results in. Default: the folder of the input image (or the current directory for URL inputs). Files are never overwritten. | |
| depth_level | No | Depth Level: low (Subtle Depth): Gently raised with minimal shadows. medium (Moderate Depth, Recommended): Standard embroidery height with natural shadows. high (Dramatic Depth): Heavily raised, sculptural stumpwork style. Required: pass the mode the user named. If the user did not name one, omit it and the tool returns the modes to show them; never choose for the user. | |
| stitch_type | No | Stitch Style: bandhani (Bandhani), kantha (Kantha), chikankari (Chikankari), zardozi (Zardozi), phulkari (Phulkari), aari (Aari / Kashida), satin (Satin Stitch, Recommended), chain (Chain Stitch), cross (Cross Stitch), running (Running Stitch), french_knot (French Knot). Required: pass the mode the user named. If the user did not name one, omit it and the tool returns the modes to show them; never choose for the user. Call describe_tool for what each option does. | |
| estimate_only | No | Only return the credit estimate; nothing is uploaded or charged. | |
| review_settings | No | Omit it and the tool first asks whether to use the recommended settings or adjust them (unless the call already sets some). true: ask each setting one by one. false: run with the given or recommended settings without asking; pass it only after the user chose that. | |
| timeout_seconds | No | How long to wait for the job before returning its task_id (default 240). | |
| thread_thickness | No | Thread Thickness: thin (Thin Thread): Fine, delicate stitching (1-2 strand). medium (Medium Thread, Recommended): Standard embroidery weight (3-4 strand). thick (Thick Thread): Bold, chunky stitching (6-strand or wool). Required: pass the mode the user named. If the user did not name one, omit it and the tool returns the modes to show them; never choose for the user. | |
| unlimited_bundle | No | Request the Unlimited bundle for this run (only has effect on Unlimited plans; the server decides). |