Generate Visual
generate_visualCreate infographics, diagrams, and charts from text via Napkin AI. Returns a request ID for tracking generation progress.
Instructions
Submit a visual generation request to Napkin AI. Returns a request ID for tracking. Use check_status to poll for completion.
Input Schema
TableJSON 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Request ID for tracking | |
| status | Yes | Initial status (usually 'pending') | |
| warning | No | Any warnings from the API |