Package Information
Documentation
@picsart/n8n-nodes-picsart-apis
Custom n8n nodes that integrate Picsart image APIs with AI-powered image processing capabilities:
- Picsart Enhance: Upscale images up to 16x with AI enhancement
- Picsart Remove Background: Remove backgrounds with advanced styling options
đ¨ Powered by Picsart API - Professional AI image editing tools
đĻ Installation
For n8n Users
Install directly in your n8n instance:
npm install @picsart/n8n-nodes-picsart-apis
Then restart your n8n instance. The Picsart nodes will appear in your node palette.
For n8n Cloud Users
- Go to Settings > Community Nodes
- Click Install
- Enter:
@picsart/n8n-nodes-picsart-apis - Click Install
Get Your Picsart API Key
- Sign up at Picsart.io
- Navigate to your dashboard and get your API key
- In n8n: Settings > Credentials > Add Picsart API
- Paste your API key
đ Quick Start
- Add Credentials: Settings â Credentials â Picsart API â paste your API key
- Create Workflow: Add a node and search for "Picsart"
- Choose Node:
- Picsart Enhance (for upscaling)
- Picsart Remove Background (for background removal)
- Configure & Execute: Set your parameters and run!
đ ī¸ Development Prerequisites
If you want to contribute or develop locally:
- git
- Node.js 20+ (install with nvm)
- pnpm:
npm install -g pnpm - n8n:
npm install n8n -g - Recommended: n8n development environment setup
đŗ Docker Quick Start (Development)
Perfect for testing and development:
# Build the image
docker build -t picsart-n8n-nodes .
# Run n8n with Picsart nodes
docker run -it --rm -p 5678:5678 picsart-n8n-nodes
Or use the quick rebuild script:
./rebuild.sh
Then:
- Open http://localhost:5678
- Add your Picsart API credentials
- Start creating workflows!
đ Node Documentation
đ¨ Picsart Enhance
Upscale and enhance images using AI technology.
Parameters:
- Image URL (required): Valid image URL (1-2083 chars)
- Supports: JPG, PNG, WEBP
- Upscale Factor: 2x, 4x, 6x, 8x, 16x
- â ī¸ Note: Output limited to 16MP. For 4x upscaling, input should be â¤2000x2000px
- Format: JPG | PNG | WEBP (default: JPG)
Output:
- Binary image data at
binary.data - JSON metadata with result URL and credit information
Example Use Cases:
- Enhance low-resolution product photos
- Upscale images for print
- Improve image quality for presentations
đŧī¸ Picsart Remove Background
AI-powered background removal with advanced styling options.
Parameters:
- Image URL (required): Source image URL
- Output Type: cutout | mask
- Background Options (choose one):
- Background Image URL
- Background Color (CSS color or hex)
- Effects:
- Blur: 0-100
- Stroke: size, color, opacity
- Shadow: custom or directional
- Dimensions: Width, Height, Scale (fit/fill)
- Format: JPG | PNG | WEBP
Output:
- Binary image data at
binary.data - JSON metadata with result and credits
Example Use Cases:
- E-commerce product photos
- Profile picture editing
- Marketing materials
- Social media content
đģ Local Development
Setup
# Clone repository
git clone https://gitlab.com/picsart/api-bu/plugins/n8n-nodes-picsart-apis/n8n-nodes-picsart-apis.git
cd n8n-nodes-picsart-apis
# Install dependencies
pnpm install
# Build
pnpm run build
# Run with Docker
./rebuild.sh
Development Workflow
# Watch mode (auto-rebuild on changes)
pnpm run dev
# Format code
pnpm run format
# Lint
pnpm run lint
# Fix linting issues
pnpm run lintfix
đ Releasing
Using the Release Script (Recommended)
# For bug fixes (0.1.1 â 0.1.2)
./release.sh patch
# For new features (0.1.0 â 0.2.0)
./release.sh minor
# For breaking changes (0.1.0 â 1.0.0)
./release.sh major
The script will:
- â Bump version in package.json
- â Run build and tests
- â Create git commit and tag
- âšī¸ Show commands to push
Then push to trigger CI/CD:
git push && git push --tags
GitLab CI/CD will automatically publish to NPM! đ
Manual Release
# Update version
npm version patch # or minor, major
# Build and test
pnpm run build
pnpm run lint
# Commit and tag
git commit -am "chore: bump version"
git tag v0.1.2
# Push
git push && git push --tags
đ CI/CD Pipeline
This project uses GitLab CI/CD for automated testing and publishing:
- On Push: Lint, build, and test
- On Tag: Automatically publish to NPM
- On Merge Request: Run all checks
Setup CI/CD
- NPM Token: Generate at npmjs.com
- Add to GitLab: Settings â CI/CD â Variables
- Key:
NPM_TOKEN - Value: Your token
- â Mask variable
- â Protect variable
- Key:
đ¤ Contributing
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Commit changes:
git commit -m 'feat: add amazing feature' - Push to branch:
git push origin feature/amazing-feature - Open a Merge Request
Commit Convention
We use Conventional Commits:
feat: add new feature
fix: bug fix
docs: documentation changes
chore: maintenance tasks
refactor: code refactoring
test: add tests
đ Resources
đ License
Made with â¤ī¸ by Picsart