You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/developer-guide/worker-definition/input-schema.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -327,3 +327,4 @@ Developers can logically group multiple configuration items by using specific fi
327
327
1.**Write clear descriptions**: Make sure `description` is clear and accurate. This helps your script get discovered by more target users.
328
328
2.**Set sensible defaults**: A reasonable `default` value lets users run the script immediately and greatly lowers the barrier to entry.
329
329
3.**Validate required fields**: For parameters without which the script cannot run, such as login cookies or the main URL, be sure to set `"required": true`.
330
+
4.**Max results naming**: If your Worker accepts a maximum-results parameter, use the field name `max_results`. This is the conventional name recognized by the platform and downstream integrations.
@@ -9,12 +9,12 @@ Use [n8n](https://n8n.io/) to build automated workflows that trigger CoreClaw Wo
9
9
10
10
## How it works
11
11
12
-
The CoreClaw n8n integration provides a dedicated community node (`n8n-nodes-coreclaw`) with built-in actions for common operations:
12
+
The CoreClaw n8n integration provides a dedicated community node (`n8n-nodes-coreclaw`) with four resources and built-in actions for common operations:
13
13
14
-
-**Start a Worker** — Run any Worker from the CoreClaw Store
15
-
-**Check run status** — Poll execution progress
16
-
-**Get results** — Retrieve output data
17
-
-**Abort a run** — Cancel an in-progress execution
14
+
-**Scraper** — Search the marketplace, get scraper details, and run a scraper
15
+
-**Run** — Get status, get results, export results, get logs, abort, or rerun an execution
16
+
-**Task** — Run a pre-configured saved task
17
+
-**Account** — Get account info (balance, traffic, plan)
18
18
19
19
You can also use the **HTTP Request** node to call the CoreClaw REST API directly for advanced use cases.
20
20
@@ -36,15 +36,15 @@ For n8n Cloud users, installation is straightforward — search and add the node
36
36
2. Open the **nodes panel** (click the **+** button on the canvas).
37
37
3. Search for **CoreClaw** in the community node registry.
38
38
39
-
Search for CoreClaw node in n8n
39
+

40
40
41
-
1. Click **Install node** to add the CoreClaw node to your instance.
41
+
4. Click **Install node** to add the CoreClaw node to your instance.
|**Worker Slug**| The unique identifier of the Worker (e.g., `01KNXSHE0Y7DZKF1N8B1EMFX35`)|
100
-
|**Version**|The Worker version to run (leave empty for latest) |
101
-
|**Input Parameters**| Worker-specific input fields (varies by Worker) |
102
-
|**Proxy Region**| Optional proxy region for the run |
117
+
|**Scraper**| Pick from the marketplace list, or paste a slug directly |
118
+
|**Version**|Scraper version string (required). Obtain from **Get Details** → version|
119
+
|**Custom Parameters**| Scraper-specific input parameters as JSON (schema from Get Details)|
120
+
|**System Parameters**| Optional JSON overrides for cpus, memory, timeout, max charge, traffic|
103
121
|**Callback URL**| Optional webhook URL for async notifications |
104
122
123
+
:::caution
124
+
**Version is required.** The node does not support "leave empty for latest". Always obtain the correct version string from **Get Details** first.
125
+
:::
105
126
106
127
Get the `scraper_slug` (Worker Slug) from the Worker page in the [CoreClaw Console](https://console.coreclaw.com/store) or from the API (`GET /api/scraper?slug=<scraper_slug>`).
107
128
108
-
### Check Run Status
129
+
### Run resource
109
130
110
-
Poll the status of a running or completed Worker execution.
131
+
#### Get
111
132
133
+
Get the current execution status of a run (status, started_at, duration, cost).
0 commit comments