Colourways
td_colourwaysGenerate 6–48 alternate colourways for a textile print, keep up to 8 source colours, and save options to disk to build pastel, deep, or dark ranges from one design.
Instructions
Colourways: generate colourway options for the design (6, 12, 24 or 48), optionally keeping up to 8 of its colours. grid true also makes a buyer sheet. Best for: a buyer wants the same print in other colours, or a range needs pastel, deep and dark stories from one bestseller. 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. | |
| grid | No | Also make a buyer sheet (every option on one page). Default true. | |
| wait | No | Wait for the job and save the outputs (default true). false returns the task_id right after submit. | |
| count | No | Options to make: 6, 12 (default), 24 or 48 (1-50 accepted). Large designs allow at most floor(600 / megapixels); more drops to the largest that fits. | |
| 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. | |
| prompt | No | Brief for the colourist (max 4000 characters), e.g. 'SS27 Europe high street', 'AW26 menswear', 'Kids' nursery', 'Bridal and occasion', 'Middle-East luxury', 'Scandinavian minimal'. | |
| harmony | No | Colour story: contrast (Bold contrast, Recommended): Motif and ground far apart. family (Close family): Everything within one arc of the wheel. mono (One colour, many shades): One hue, separated by light and dark. 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. | |
| tone_range | No | Mood: all (Surprise me, Recommended): Any tonal range. pastel (Fresh pastels): Light pastel tones. mid (Everyday mid tones): Mid tones. deep (Rich and deep): Deep, saturated tones. vivid (Bright and bold): Bright, vivid tones. dark (Dark grounds): Dark grounds. neutral (Quiet neutrals): Muted neutral tones. 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. | |
| fine_detail | No | Delicate print: thin lines or pale motifs on a light ground. Default false. | |
| estimate_only | No | Only return the credit estimate; nothing is uploaded or charged. | |
| locked_colors | No | Keep these colours: up to 8 hex colours from the design (e.g. the ground or a brand colour), snapped to the design's nearest dominant colour. td_color_matching_extract_colors lists the design's colours. | |
| 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). | |
| unlimited_bundle | No | Request the Unlimited bundle for this run (only has effect on Unlimited plans; the server decides). |