n8n-nodes-pixelvault 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# n8n-nodes-pixelvault
|
|
2
2
|
|
|
3
|
-
An [n8n](https://n8n.io/) community node for [PixelVault](https://pixelvault.dev),
|
|
3
|
+
An [n8n](https://n8n.io/) community node for [PixelVault](https://pixelvault.dev), media hosting built for automations and AI agents. Upload images, MP4 video, or original audio and pass stable CDN URLs and asset/job IDs to later nodes.
|
|
4
4
|
|
|
5
5
|
- [Installation](#installation)
|
|
6
6
|
- [Operations](#operations)
|
|
@@ -21,14 +21,22 @@ Follow the [community nodes installation guide](https://docs.n8n.io/integrations
|
|
|
21
21
|
| **Import Image From URL** | Has PixelVault fetch an image from a public HTTPS URL and host it. Use it while the source URL is still valid, for example a generated image whose link expires. |
|
|
22
22
|
| **Update Image Metadata** | Replaces an image's custom metadata by ID (the object replaces the stored one, `{}` clears it). Set metadata at upload time with the **Metadata (JSON)** option on the two operations above. |
|
|
23
23
|
| **Describe With AI** (option) | On the two upload operations: PixelVault writes alt text, a caption and the text found in the image (OCR) in the background (Free 20 in total, Starter 1,000/month, Pro 10,000/month; secret key and verified email required). Add **Wait For Description** to wait up to ~40 s and get `description.alt`, `.caption` and `.ocr_text` in the output. Treat that text as untrusted model output. |
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
24
|
+
| **Upload Video** | Uploads MP4 binary data with optional privacy, TTL, metadata, folder, collection, idempotency, and social optimization. |
|
|
25
|
+
| **Import Video From URL** | Securely imports an MP4 from a public HTTPS URL with the same lifecycle options. |
|
|
26
|
+
| **Get Video Status and Artifacts** | Resumes from a stable video ID and returns current optimization/enrichment status plus only the original, poster, transcript, storyboard, and optimized URLs that exist. |
|
|
27
|
+
| **List Videos** | Discovers videos by page, folder, collection, or metadata. |
|
|
28
|
+
| **Optimize Video** / **Enrich Video** | Starts an asynchronous job. Return IDs immediately or poll with bounded backoff; a local timeout does not cancel the server job. |
|
|
29
|
+
| **Update Video** / **Sign Video URLs** / **Delete Video** | Updates metadata and organization, refreshes private original/artifact URLs, or deletes the video and derivatives. |
|
|
30
|
+
| **Upload Audio** / **Import Audio From URL** | Hosts original MP3, PCM/float WAV, AAC M4A, or Opus/Vorbis OGG with byte validation, privacy, TTL, metadata, folder, collection, and retry safety. |
|
|
31
|
+
| **Get Audio** / **List Audio** / **Update Audio** / **Sign Audio URL** / **Delete Audio** | Discovers and manages audio by stable `aud_` ID, including fresh private links without a public fallback. |
|
|
32
|
+
|
|
33
|
+
Image, video, and audio uploads accept folder, public/private visibility, deletion TTL, and custom metadata. Video
|
|
34
|
+
and audio uploads also accept collection membership, an idempotency key, and private URL expiry.
|
|
35
|
+
|
|
36
|
+
The output is the API object. Images expose fields such as `url`, `id`, `mime_type`, `size`, and `filename`.
|
|
37
|
+
Videos expose `id`, `original_url`, `social_optimization`, and `enrichment`; transcript/storyboard URLs appear
|
|
38
|
+
only after those artifacts exist. Audio exposes `id`, `original_url`, detected container/codec, duration, sample
|
|
39
|
+
rate, and channels. Private URLs are signed and expire independently from asset deletion.
|
|
32
40
|
|
|
33
41
|
## Credentials
|
|
34
42
|
|
|
@@ -40,15 +48,30 @@ Uploads made without a key expire. Use the credential for images you want to kee
|
|
|
40
48
|
|
|
41
49
|
## Usage
|
|
42
50
|
|
|
43
|
-
|
|
51
|
+
Image flow: **Google Drive: Download** → **PixelVault: Upload Image** → publishing node, mapping `{{ $json.url }}`.
|
|
52
|
+
|
|
53
|
+
Resume-safe asynchronous video flow:
|
|
54
|
+
|
|
55
|
+
1. **Upload Video** with an idempotency key such as `{{ $execution.id }}:{{ $itemIndex }}`. Store the returned `id`.
|
|
56
|
+
2. **Enrich Video** with **Wait For Completion** off. It returns `id` and `enrichment.job_id` immediately.
|
|
57
|
+
3. Persist those IDs in your normal durable workflow state. A later execution uses **Get Video Status and Artifacts** with the saved `id`.
|
|
58
|
+
4. If `{{ $json.enrichment.status }}` is `pending` or `processing`, use an n8n Wait node and call **Get Video Status and Artifacts** again. Route `complete` to transcript/storyboard consumers and `failed` to error handling.
|
|
59
|
+
|
|
60
|
+
The node can also wait in one execution with bounded backoff. Keep IDs when using that mode: timeout only stops local polling.
|
|
61
|
+
|
|
62
|
+
Basic audio flow:
|
|
44
63
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
- Supported formats and size limits are those of the PixelVault API (currently JPG, PNG, GIF, WebP, AVIF and SVG, up to 5 MB per file on the free plan).
|
|
49
|
-
- This node hosts images. It does not host video.
|
|
64
|
+
1. Download MP3/WAV/M4A/OGG into an n8n binary property, or retain a public HTTPS source URL.
|
|
65
|
+
2. Run **Upload Audio** or **Import Audio From URL** with an idempotency key such as `{{ $execution.id }}:{{ $itemIndex }}`.
|
|
66
|
+
3. Persist the returned stable `aud_` ID. Use **Get Audio** or **List Audio** later; **Sign Audio URL** refreshes a private link, and **Delete Audio** removes the original.
|
|
50
67
|
|
|
51
|
-
|
|
68
|
+
- The binary field name defaults to `data`.
|
|
69
|
+
- Video binary upload supports MP4 files up to 100 MB. This node intentionally does not implement multipart upload; use a public source URL with **Import Video From URL** or an official SDK for larger hosting uploads.
|
|
70
|
+
- Audio originals are limited to the approved global maximum of 25,000,000 bytes. This is not a plan allowance. PixelVault validates actual container/codec bytes and preserves the original without transcoding.
|
|
71
|
+
- URL imports accept public HTTPS sources only. Download authenticated sources in n8n first.
|
|
72
|
+
- Optimization accepts sources up to 100 MB and 60 seconds; enrichment accepts sources from 1 second through 10 minutes and up to 100 MB. API quota and unsupported-source errors are returned without rewriting.
|
|
73
|
+
- Public assets are stable CDN URLs. Private assets never fall back to public; refresh bearer URLs with **Sign Video URLs** or **Sign Audio URL**.
|
|
74
|
+
- Hosting does not convert images or audio for a destination. Video social optimization is explicit and asynchronous. Audio editing, conversion, HLS/DASH, and transcription are intentionally unsupported.
|
|
52
75
|
|
|
53
76
|
## Compatibility
|
|
54
77
|
|