npm package: @prismosoft/n8n-nodes-adblast
Description: n8n node to connect with AdBlast
Author: AdBlast
Latest version: 1.1.12

# @prismosoft/n8n-nodes-adblast

![n8n logo](n8n.png)

n8n node for [**AdBlast**](https://adblast.ai/) - AI-powered video ad creation platform
using [**@prismosoft/n8n-openapi-node**](https://github.com/prismosoft/n8n-openapi-node)

Create, manage, and automate AI-generated video advertisements with characters, environments, scenes, voiceovers, and visual effects.

## Features

- **Flexible Authentication**: Choose between predefined credentials or dynamic API keys via expressions
- **Project Management**: Create and manage video ad projects
- **AI Characters**: Generate and customize AI characters for your ads
- **Environments & Scenes**: Design immersive settings and scenes
- **Visual Content**: Generate images, videos, and visual effects
- **Voiceover**: Add AI-generated voice narration
- **Video Production**: Render complete video advertisements

![screenshot](./images/screenshot.png)

<!-- toc -->

- [Installation](#installation)
- [Setup](#setup)
- [Available Operations](#available-operations)
- [Run AdBlast n8n node locally](#run-adblast-n8n-node-locally)
    - [NodeJS](#nodejs)
    - [Install n8n](#install-n8n)
    - [Start n8n](#start-n8n)
    - [Build and link the project](#build-and-link-the-project)
    - [Add node to n8n](#add-node-to-n8n)
    - [Start n8n again](#start-n8n-again)
    - [Add AdBlast Node to new workflow](#add-adblast-node-to-new-workflow)
- [Modify Project](#modify-project)
    - [Test Project Locally](#test-project-locally)
    - [Publish project](#publish-project)

<!-- tocstop -->

## Installation

Install the AdBlast node in your n8n instance:

```bash
npm install @prismosoft/n8n-nodes-adblast
```

## Setup

1. Sign up for an AdBlast account at [adblast.ai](https://adblast.ai)
2. Generate an API token from your [API Tokens settings](https://adblast.ai/settings/api-tokens)
3. In n8n, add the AdBlast node to your workflow
4. Choose your authentication method:
    - **Predefined Credentials**: Save your API token and URL in n8n's credential manager (recommended for most users)
    - **Dynamic API Key**: Enter your API key and URL directly using expressions like `{{ $node["webhook"].json.apiKey }}` and `{{ $node["webhook"].json.baseUrl }}` (for dynamic workflows)

## Available Operations

The AdBlast node provides access to the following API endpoints:

### Health

- **Health Check**: Verify API connectivity and authentication

### Projects

- **List Projects**: Retrieve list of projects
- **Create Project**: Start a new video ad project
- **Get Project**: Retrieve detailed project information
- **Update Project Title**: Modify project title
- **Delete Project**: Remove a project
- **Get Project Data Schema**: Get the JSON schema for project data
- **Get Project Data**: Retrieve project data
- **Update Project Data**: Modify project data
- **Get Project Versions**: List project version history
- **Revert Project to Version**: Restore project to previous version
- **Duplicate Project**: Create a copy of a project

### Score

- **Get Score Configuration**: Retrieve audio score settings
- **Update Score Configuration**: Modify audio score settings
- **Clear Score Configuration**: Reset audio score settings
- **Finalize Score Upload**: Complete audio score file upload
- **Set Score Processing Status**: Update audio processing status

### Characters

- **Get All Characters**: List all characters in a project
- **Create Character**: Add a new AI character
- **Get Character**: Retrieve specific character details
- **Update Character**: Modify character properties
- **Delete Character**: Remove a character
- **Finalize Character Image Upload**: Complete character image upload
- **Set Character Processing Status**: Update character processing status

### Environments

- **Get All Environments**: List all environments in a project
- **Create Environment**: Add a new visual environment
- **Get Environment**: Retrieve specific environment details
- **Update Environment**: Modify environment properties
- **Delete Environment**: Remove an environment
- **Finalize Environment Image Upload**: Complete environment image upload
- **Set Environment Processing Status**: Update environment processing status

### Scenes

- **Get All Scenes**: List all scenes in a project
- **Get Scene**: Retrieve specific scene details
- **Update Scene**: Modify scene properties
- **Get All Visuals for Scene**: List visuals in a scene
- **Create Visual in Scene**: Add a new visual element
- **Get Visual**: Retrieve specific visual details
- **Update Visual in Scene**: Modify visual properties
- **Delete Visual from Scene**: Remove a visual element

### Visual Voiceover

- **Update Voiceover for Scene Visual**: Add/modify voice narration
- **Finalize Scene Visual Voiceover Upload**: Complete voiceover upload
- **Finalize Scene Visual Uploaded Voiceover Upload**: Complete uploaded voiceover

### Visual Image

- **Update Text to Image for Scene Visual**: Generate image from text
- **Finalize Scene Visual Image Upload**: Complete image upload
- **Set Text to Image Processing Status**: Update image generation status

### Visual Video

- **Update Image to Video for Scene Visual**: Convert image to video
- **Finalize Scene Visual Video Upload**: Complete video upload
- **Set Image to Video Processing Status**: Update video generation status

### Visual Sound

- **Update Sound for Scene Visual**: Add/modify audio effects
- **Finalize Scene Visual Sound Upload**: Complete sound upload
- **Set Sound Processing Status**: Update sound processing status

### Video

- **Get Video Configuration**: Retrieve video rendering settings
- **Update Video Configuration**: Modify video settings
- **Clear Video Configuration**: Reset video settings
- **Finalize Video Upload**: Complete video file upload
- **Set Video Processing Status**: Update video processing status

# Run AdBlast n8n node locally

Before start modifying the project, we kindly recommend
to run the AdBlast node locally.

## NodeJS

Make sure you're using Node.js > 20 (we're using [nvm](https://github.com/nvm-sh/nvm)):

```bash
nvm install v22.8
nvm use v22.8
```

## Install n8n

```bash
npm install n8n -g
```

## Start n8n

```bash
n8n --version
n8n start
```

Open [http://localhost:5678](http://localhost:5678) in your browser and configure it

## Build and link the project

```bash
npm install
npm run test
npm run build
npm link
```

## Add node to n8n

```bash
cd ~/.n8n
mkdir -p custom
cd custom
npm init # press Enter for all questions
npm link @prismosoft/n8n-nodes-adblast
```

## Start n8n again

```bash
n8n start
```

## Add AdBlast Node to new workflow

Find `AdBlast` in the node list and add it to your workflow. Configure with your API token and select the desired operation.

![workflow](./images/workflow.png)
![screenshot](./images/screenshot.png)

# Modify Project

To customize this node for your needs:

1. Update the `openapi.json` in `nodes/AdBlast/` if the API changes
2. Replace the project logo in `nodes/AdBlast/logo.svg`
3. Modify credentials in `credentials/AdBlast.credentials.ts`
4. Update node configuration in `nodes/AdBlast/AdBlast.node.ts`

## Test Project Locally

```bash
npm install
npm run test
npm run build
npm link
```

Add node to n8n:

```bash
cd ~/.n8n
mkdir -p custom
cd custom
npm init # press Enter for all questions
npm link @prismosoft/n8n-nodes-adblast
```

Start n8n:

```bash
n8n start
```

## Publish project

1. Add your `NPM_TOKEN` in GitHub Actions
2. Push changes to GitHub
3. Create a new GitHub Release with version tag
4. Install your node in n8n: `npm install @prismosoft/n8n-nodes-adblast`