Generate Visual and Wait
generate_and_waitGenerate a visual from text and wait for completion, combining creation and status polling into a single operation.
Instructions
Generate a visual and wait for completion. Combines generate_visual and polling check_status into a single operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| width | No | Width in pixels (PNG only) | |
| format | No | Output format: svg, png, or ppt (default: svg) | |
| height | No | Height in pixels (PNG only) | |
| content | Yes | Main text content to visualise | |
| context | No | Additional context for visual generation | |
| dry_run | No | Validate inputs without calling the API (default: false) | |
| language | No | BCP 47 language tag (e.g., en, en-GB). Default: en | |
| style_id | No | Style identifier from Napkin AI | |
| visual_id | No | Regenerate a specific visual layout with new content. Cannot be used with visual_ids, visual_query, or visual_queries. | |
| color_mode | No | Colour mode: light, dark, or both | |
| visual_ids | No | Array of visual IDs to regenerate specific layouts. Length must match number_of_visuals. | |
| orientation | No | Orientation: auto, horizontal, vertical, or square | |
| visual_query | No | Visual type query (e.g., mindmap, flowchart, timeline) | |
| sort_strategy | No | Sort strategy: relevance, random, or variation | |
| visual_queries | No | Array of visual type queries. Length must match number_of_visuals. | |
| number_of_visuals | No | Number of variations to generate (1-4) | |
| text_extraction_mode | No | Text extraction: auto, rewrite, or preserve | |
| transparent_background | No | Use transparent background |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| status | Yes | ||
| credits | No | Credit consumption for the request | |
| generated_files | Yes | Generated files with download URLs |