Use CoreClaw API v2 in n8n to discover workers, run workers and saved tasks, manage worker runs, fetch results, export data, inspect account state, and receive run callbacks.
n8n is a workflow automation platform. This package provides:
- CoreClaw: an action node for CoreClaw API v2 workers, worker runs, worker tasks, store workers, proxy regions, and account data.
- CoreClaw Trigger: a webhook trigger node for CoreClaw
callback_urlrun events.
- Installation
- Credentials
- CoreClaw Node
- One-step: Run and Get Results
- Running Workers
- CoreClaw Trigger
- Workflows
- Error Handling
- Troubleshooting
- Live Tests
- Endpoint Scope
- Compatibility
Follow the n8n community nodes installation guide.
On self-hosted n8n:
- Go to Settings > Community Nodes.
- Install
n8n-nodes-coreclaw. - Reload the editor. The CoreClaw and CoreClaw Trigger nodes will appear in the node panel.
- Create a CoreClaw API key in the CoreClaw console.
- In n8n, create a credential of type CoreClaw API.
| Field | Value |
|---|---|
| API Key | Your CoreClaw API v2 key. |
| Base URL | https://openapi.coreclaw.com by default. Change only for private deployments. |
Requests send both api-key: <key> and Authorization: Bearer <key>. The credential test calls GET /api/v2/users/account.
The action node exposes 39 CoreClaw API v2 operations.
- List: list public store workers, with keyword search and pagination.
- List
- Get
- Get Input Schema
- Run
- Run and Get Results (run → wait → return result rows in one step)
- Get Last Run
- Abort Last Run
- Export Last Run Results
- Get Last Run Log
- Rerun Last Run
- List Last Run Results
- List — supports optional
start_timeandend_timeUnix-second filters oncreated_at. Supply both together within the same calendar month; when omitted, CoreClaw returns the current month's runs. - Get Last
- Abort Last
- Export Last Results
- Get Last Log
- Rerun Last
- List Last Results
- Get
- Abort
- Get Log
- Rerun
- Rerun and Get Results (rerun → wait → return result rows in one step)
- List Results
- Export Results
- List
- Create — save a worker config as a reusable, optionally scheduled task. Input JSON is sent as
input.parameters.custom. - Get
- Update — update title, description, or schedule (partial).
- Delete
- Get Input — read a saved task's input payload.
- Update Input — replace a saved task's input (wrapped as
input.parameters.custom). - Run
- Run and Get Results (run → wait → return result rows in one step)
- Queue Run — queue a worker run for later activation. Input JSON is sent as
input.parameters.custom. Returns aqueue_ref. - List Items — list run queue items, optionally filtered by status (
waiting,inactive). - Activate Items — activate one or more queued items so they start executing. Body:
{"queue_refs":["22","23"]}. - Release Items — release (discard) one or more queued items in bulk. Body:
{"queue_refs":["22","23"],"reason":"optional"}. - Release One Item — release a single queued item by
queueId. Body:{"reason":"optional"}.
- List Regions
- Get Info
Worker, worker task, and worker run fields use resource locators where useful. You can pick from CoreClaw lists or paste an ID/path manually.
The Run and Get Results operations (on Worker, Worker Task, and Worker Run) run a worker in one node and return the result rows directly — no need to wire separate Run → Get → List Results nodes.
The node:
- Submits the run asynchronously.
- Polls
GET /api/v2/worker-runs/{runId}until the run reaches a terminal status (succeeded,failed, oraborted). - Fetches the result rows from
GET /api/v2/worker-runs/{runId}/resultand returns each row as an n8n item.
Use Return All to page through every result (capped at 10,000 rows for safety), or set Offset / Limit for a single page.
If the run finishes unsuccessfully, the node throws an error that includes the run status, err_msg, and the run log when available — so you can see why it failed without a separate Get Log step.
Polling runs client-side for up to ~4 minutes (120 attempts × 2s). For longer jobs, keep Worker > Run asynchronous and use CoreClaw Trigger with
callback_urlinstead.
Worker > Run supports two input modes:
- Input JSON: worker business input. The node sends it as
input.parameters.custom. - Raw Input JSON: advanced full CoreClaw
inputobject.
Use one input mode per run. If both are set, the node fails before making a request.
Run, rerun, and worker task run operations support callback_url, is_async, offset, and limit where the CoreClaw API supports them.
Enable Wait for Finish to poll the returned run through Get Worker Run Detail until it reaches a terminal status. For long jobs or event-driven workflows, keep asynchronous mode and use CoreClaw Trigger with callback_url.
CoreClaw does not currently provide a documented webhook registration API. The CoreClaw Trigger node is a local n8n webhook receiver.
Use it by copying the trigger webhook URL into callback_url on Worker > Run, Worker Task > Run, or rerun operations.
The trigger:
- Accepts
POSTcallback payloads. - Can validate
run_idandrun_status. - Can filter events by status: Any, Succeeded, Failed, Running, or Aborted.
- Can include request headers under
_headers.
Expected callback payload fields include run_id, run_status, error_message, execution_start_timestamp, execution_end_timestamp, running_duration, result_count, and result_message.
- CoreClaw: Worker > Run and Get Results — run, wait, and return result rows in a single node.
- Pipe the result items straight into your downstream step (spreadsheet, AI, database…).
- CoreClaw: Store Worker > List
- CoreClaw: Worker > Get Input Schema
- CoreClaw: Worker > Run
- CoreClaw: Worker Run > Get
- CoreClaw: Worker Run > List Results
- CoreClaw: Worker Task > Run and Get Results — or, to export a file instead of rows:
- CoreClaw: Worker Task > Run
- CoreClaw: Worker Run > Export Results
- Add CoreClaw Trigger to a workflow.
- Copy its webhook URL.
- Paste that URL into
callback_urlon Worker > Run, Worker Task > Run, or rerun. - Use the trigger output in downstream workflow steps.
CoreClaw API v2 responses use an envelope with code, message, data, and sometimes request_id or details.
The node:
- Returns
datawhencodeis0. - Throws an n8n API error for non-zero CoreClaw codes.
- Includes CoreClaw messages, details, and request IDs when available.
- Retries only safe GET requests on retryable failures.
- Does not retry run, rerun, or abort POST requests.
Enable Continue On Fail in n8n to emit an item containing error and errorDescription instead of stopping the workflow.
| Symptom | Cause / Fix |
|---|---|
Credential test fails with CoreClaw error 12001/12002 |
Invalid API key. Regenerate the key in the CoreClaw console and paste it into the credential. |
Resource not found (CoreClaw error 11004/50001/70001)` |
Wrong ID. Use the resource locator's From List mode to pick a valid worker/task/run, or verify the slug/owner path format (owner~demo-worker). |
Insufficient balance (CoreClaw error 30001) |
Top up the CoreClaw account before running workers. |
PLAN_CONCURRENCY_LIMITED (CoreClaw error 30003) |
The plan's concurrent run limit has been reached. Wait for existing runs to finish before starting or activating more. |
| Run and Get Results never returns | The run may exceed the ~4-minute polling budget. Switch to asynchronous Worker > Run + CoreClaw Trigger with callback_url for long jobs. |
Run and Get Results returns a failed/aborted error |
The node attaches the run log to the error description. Open the node's error output or check Continue On Fail output for the errorDescription containing the log. |
| Empty result rows on a succeeded run | The worker produced no results. Inspect the run with Worker Run > Get Log and validate the input against Worker > Get Input Schema. |
| Webhook trigger never fires | CoreClaw cannot reach n8n. Set a public WEBHOOK_URL (or tunnel) and paste the trigger URL into callback_url on the run operation. |
Live smoke tests are opt-in:
$env:CORECLAW_LIVE_TESTS='1'
$env:CORECLAW_API_KEY='<your key>'
npm test -- nodes/CoreClaw/__tests__/e2e.live.test.ts
Remove-Item Env:\CORECLAW_API_KEY
Remove-Item Env:\CORECLAW_LIVE_TESTSWithout both environment variables, the live suite is skipped.
This package intentionally does not expose POST /api/v2/workers/{workerId}/versions, PUT /api/v2/workers/{workerId}/versions/{version}, GET /api/v2/workers/{workerId}/internal, or GET /api/v2/queued-worker-runs. The remaining 39 public API v2 operations are exposed, including the five Run Queue operations (POST /workers/{workerId}/queued-runs, GET /run-queue/items, POST /run-queue/items/activate, POST /run-queue/items/release, POST /run-queue/items/{queueId}/release).
- n8n community node API version 1.
- Node.js
>=20.15.
See CHANGELOG.md.