# n8n-nodes-wizpixel-flow

[n8n](https://n8n.io/) community node for [WizPixel Flow](https://flow.wizpixel.com) — the creative production engine that renders HTML5 banners and MP4 videos across every format and locale automatically.

## Features

- **Submit render jobs** — trigger a render with your template, variables, locales and output formats
- **Poll for completion** — optionally wait for the job to finish and get the download URL directly
- **List templates** — browse your Flow templates from within n8n
- **Get job status** — check any job by ID

## Installation

### In your n8n instance

Go to **Settings → Community Nodes → Install** and search for:

```
n8n-nodes-wizpixel-flow
```

### Docker / self-hosted

```bash
docker exec -it <your-n8n-container> npm install -g n8n-nodes-wizpixel-flow
docker restart <your-n8n-container>
```

## Credentials

1. Generate an API key in your [WizPixel Flow account](https://app.wizpixel.com)
2. In n8n, add a new credential of type **WizPixel Flow API**
3. Paste your API key and confirm the base URL (`https://api.wizpixel.com/v1`)

## Operations

| Operation | Description |
|-----------|-------------|
| **Render** | Submit a render job for a template across formats and locales |
| **Get Job** | Retrieve the status and download URL of a job |
| **List Templates** | Return your available Flow templates |

### Render parameters

| Parameter | Description |
|-----------|-------------|
| Template ID | The Flow template to render |
| Output Formats | Select from all 22 supported formats |
| Locales | Comma-separated locale codes, e.g. `en,it,fr` |
| Variables | JSON object of `{{variable}}` substitutions |
| Include Video | Also render MP4 versions |
| Wait for Completion | Poll until the job finishes and return the ZIP download URL |

## API contract

| Method | Endpoint | Description |
|--------|----------|-------------|
| GET | /v1/account | Credential test |
| GET | /v1/templates?limit=N | List templates |
| POST | /v1/render | Submit render job |
| GET | /v1/jobs/:id | Poll job status |

## Links

- [WizPixel Flow](https://flow.wizpixel.com)
- [Support](mailto:support@wizpixel.com)

## License

MIT