@mixpeek/n8n-nodes-mixpeek 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +90 -66
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,48 @@
1
1
  # @mixpeek/n8n-nodes-mixpeek
2
2
 
3
- n8n community node for [Mixpeek](https://mixpeek.com) - multimodal data processing and semantic search API.
3
+ Turn URLs, text, images, and video into structured signals inside n8n.
4
4
 
5
- **[View all Mixpeek connectors →](https://mixpeek.com/connectors)**
5
+ Mixpeek is a multimodal processing API that lets you classify, search, cluster, and run ML inference on unstructured data — directly from n8n workflows.
6
+
7
+ ```
8
+ Input → Mixpeek → Structured signals → Any system
9
+ ```
10
+
11
+ **[Full docs & examples → mixpeek.com/connectors](https://mixpeek.com/connectors)**
12
+
13
+ ---
14
+
15
+ ## What you can build in minutes
16
+
17
+ - Auto-tag content from URLs or files
18
+ - Semantic search across documents, images, or video
19
+ - Content moderation & safety signals
20
+ - Dataset enrichment before indexing
21
+ - Trigger workflows based on semantic similarity
22
+
23
+ ## Supported modalities
24
+
25
+ - Text
26
+ - Web pages (HTML)
27
+ - Images
28
+ - Video
29
+ - Files (via upload)
30
+
31
+ ## Quick example
32
+
33
+ **Input:** A URL or file
34
+
35
+ **Output:**
36
+ ```json
37
+ {
38
+ "categories": ["technology", "ai"],
39
+ "keywords": ["machine learning", "automation"],
40
+ "sentiment": 0.72,
41
+ "embeddings": [0.023, -0.041, ...]
42
+ }
43
+ ```
44
+
45
+ ---
6
46
 
7
47
  ## Installation
8
48
 
@@ -13,7 +53,7 @@ n8n community node for [Mixpeek](https://mixpeek.com) - multimodal data processi
13
53
  3. Enter `@mixpeek/n8n-nodes-mixpeek`
14
54
  4. Click **Install**
15
55
 
16
- ### Manual Installation
56
+ ### Manual
17
57
 
18
58
  ```bash
19
59
  npm install @mixpeek/n8n-nodes-mixpeek
@@ -21,21 +61,25 @@ npm install @mixpeek/n8n-nodes-mixpeek
21
61
 
22
62
  ## Credentials
23
63
 
24
- You need a Mixpeek API key to use this node. Get your API key from [app.mixpeek.com](https://app.mixpeek.com).
64
+ Get your API key from [app.mixpeek.com](https://app.mixpeek.com).
25
65
 
26
- 1. In n8n, go to **Credentials** > **Add Credential**
27
- 2. Search for "Mixpeek API"
66
+ 1. In n8n: **Credentials** > **Add Credential**
67
+ 2. Search "Mixpeek API"
28
68
  3. Enter your API key
29
69
 
30
- ## Supported Resources & Operations
70
+ ---
31
71
 
32
- ### Namespace
33
- Manage tenant isolation and environments.
34
- - Create, Get, List, Update, Delete
72
+ ## All Resources & Operations
35
73
 
36
- ### Bucket
37
- Schema-backed containers for objects/blobs.
74
+ ### Retriever
75
+ Multi-stage search pipelines with auto-optimization.
38
76
  - Create, Get, List, Update, Delete
77
+ - **Execute** - Run a semantic search query
78
+ - **Explain** - Get execution plan
79
+
80
+ ### Inference
81
+ Direct ML model execution.
82
+ - **Execute** - Run inference with OpenAI, Anthropic, Google, or custom models
39
83
 
40
84
  ### Collection
41
85
  Transform objects into searchable documents using ML extractors.
@@ -45,25 +89,18 @@ Transform objects into searchable documents using ML extractors.
45
89
  Query-ready outputs with full lifecycle management.
46
90
  - Create, Get, List, Update, Delete
47
91
 
48
- ### Retriever
49
- Multi-stage search pipelines with auto-optimization.
50
- - Create, Get, List, Update, Delete
51
- - **Execute** - Run a semantic search query
52
- - **Explain** - Get execution plan for a query
53
-
54
92
  ### Upload
55
93
  File upload management with presigned URLs.
56
- - Create Presigned URL
57
- - Get, List, Delete
94
+ - Create Presigned URL, Get, List, Delete
58
95
  - **Confirm** - Verify upload completion
59
96
 
60
- ### Task
61
- Async job tracking and monitoring.
62
- - Get, List
97
+ ### Bucket
98
+ Schema-backed containers for objects/blobs.
99
+ - Create, Get, List, Update, Delete
63
100
 
64
- ### Inference
65
- Direct ML model execution.
66
- - **Execute** - Run inference with OpenAI, Anthropic, Google, or custom models
101
+ ### Namespace
102
+ Manage tenant isolation and environments.
103
+ - Create, Get, List, Update, Delete
67
104
 
68
105
  ### Taxonomy
69
106
  Similarity-based document classification.
@@ -74,86 +111,73 @@ Semantic grouping with triggers.
74
111
  - Create, Get, List, Delete
75
112
  - **Execute** - Run clustering
76
113
 
114
+ ### Task
115
+ Async job tracking and monitoring.
116
+ - Get, List
117
+
77
118
  ### Webhook
78
119
  Event-driven automation.
79
120
  - Create, Get, List, Update, Delete
80
121
 
81
- ## Example Usage
122
+ ---
123
+
124
+ ## Example Workflows
82
125
 
83
126
  ### Semantic Search
84
127
 
85
128
  1. Add a **Mixpeek** node
86
- 2. Select **Retriever** as the resource
87
- 3. Select **Execute** as the operation
88
- 4. Enter the Retriever ID
89
- 5. Enter your search query
90
- 6. Optionally add filters and limits
129
+ 2. Resource: **Retriever** → Operation: **Execute**
130
+ 3. Enter Retriever ID and query
131
+ 4. Connect to any downstream node
91
132
 
92
- ### Upload a File
133
+ ### Upload & Process a File
93
134
 
94
- 1. Add a **Mixpeek** node
95
- 2. Select **Upload** as the resource
96
- 3. Select **Create Presigned URL** as the operation
97
- 4. Enter the Bucket ID and filename
98
- 5. Use the returned presigned URL to upload your file
99
- 6. Add another **Mixpeek** node to confirm the upload
135
+ 1. **Mixpeek** node → Upload → Create Presigned URL
136
+ 2. HTTP node → PUT file to presigned URL
137
+ 3. **Mixpeek** node → Upload → Confirm
100
138
 
101
139
  ### Run Inference
102
140
 
103
- 1. Add a **Mixpeek** node
104
- 2. Select **Inference** as the resource
105
- 3. Select **Execute** as the operation
106
- 4. Enter the model (e.g., `openai/gpt-4`, `anthropic/claude-3`)
107
- 5. Enter the input as JSON
108
-
109
- ## Development
141
+ 1. **Mixpeek** node → Inference → Execute
142
+ 2. Model: `openai/gpt-4` or `anthropic/claude-3`
143
+ 3. Input: your JSON payload
110
144
 
111
- ### Prerequisites
145
+ ---
112
146
 
113
- - Node.js 18+
114
- - npm
147
+ ## Development
115
148
 
116
149
  ### Setup
117
150
 
118
151
  ```bash
119
152
  cd n8n
120
153
  npm install
121
- ```
122
-
123
- ### Build
124
-
125
- ```bash
126
154
  npm run build
127
155
  ```
128
156
 
129
157
  ### Test
130
158
 
131
159
  ```bash
132
- # Unit tests
133
160
  npm test
134
161
 
135
- # Integration tests (requires MIXPEEK_API_KEY)
162
+ # Integration tests
136
163
  MIXPEEK_API_KEY=your_key npm run test:integration
137
164
  ```
138
165
 
139
- ### Local Development with n8n
166
+ ### Local dev with n8n
140
167
 
141
168
  ```bash
142
- # Link the package
143
169
  npm link
144
-
145
- # In your n8n custom nodes directory (~/.n8n/custom)
146
- npm link @mixpeek/n8n-nodes-mixpeek
147
-
148
- # Start n8n
170
+ cd ~/.n8n/custom && npm link @mixpeek/n8n-nodes-mixpeek
149
171
  n8n start
150
172
  ```
151
173
 
174
+ ---
175
+
152
176
  ## Resources
153
177
 
154
178
  - [Mixpeek Documentation](https://docs.mixpeek.com)
155
- - [Mixpeek API Reference](https://docs.mixpeek.com/api-reference)
156
- - [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
179
+ - [API Reference](https://docs.mixpeek.com/api-reference)
180
+ - [n8n Community Nodes](https://docs.n8n.io/integrations/community-nodes/)
157
181
 
158
182
  ## License
159
183
 
@@ -162,4 +186,4 @@ MIT
162
186
  ## Support
163
187
 
164
188
  - [GitHub Issues](https://github.com/mixpeek/connectors/issues)
165
- - [Mixpeek Support](mailto:support@mixpeek.com)
189
+ - [support@mixpeek.com](mailto:support@mixpeek.com)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mixpeek/n8n-nodes-mixpeek",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "n8n community node for Mixpeek - multimodal data processing and semantic search API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/mixpeek/connectors/tree/main/n8n#readme",