run_recipe
Run a Snowfakery recipe to generate fake data. Returns generated output and artifact URIs with options for output format, repetition, and preview control.
Instructions
Run a Snowfakery recipe and generate fake data.
Executes the recipe and returns generated output along with artifact URIs.
The complete output is always written to disk and available via the
returned resource URI regardless of capture_output - that setting
only controls how much of it also comes back inline in this response.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reps | No | Number of times to repeat the recipe | |
| options | No | User options (--option key=value equivalent) | |
| recipe_path | No | Path to recipe file (relative to workspace) | |
| recipe_text | No | Recipe YAML content as string | |
| strict_mode | No | Fail on undefined field references | |
| output_format | No | Output format (txt, json, csv, sql, dot, svg, etc.) | txt |
| target_number | No | Generate until table reaches count {"table": "X", "count": N} | |
| validate_only | No | Only validate, don't generate | |
| capture_output | No | How much generated output to include inline, in addition to the resource: "preview" (default) is a small preview plus output_bytes/record_count so you know how much data exists without paying to see all of it; "full" is the complete output inline, up to the server's max-capture-chars limit; "none" omits inline text entirely. | preview |
| plugin_options | No | Plugin configuration options | |
| generate_continuation | No | Create continuation file for resuming |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||