# Send n8n API to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "n8n-api",
    "name": "n8n API",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/codedao12/n8n-api",
    "canonicalUrl": "https://clawhub.ai/codedao12/n8n-api",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/n8n-api",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=n8n-api",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "SKILL.md",
      "assets/n8n-api-endpoints.md"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "n8n-api",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-12T09:57:57.273Z",
      "expiresAt": "2026-05-19T09:57:57.273Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=n8n-api",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=n8n-api",
        "contentDisposition": "attachment; filename=\"n8n-api-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "n8n-api"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/n8n-api"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/n8n-api",
    "downloadUrl": "https://openagent3.xyz/downloads/n8n-api",
    "agentUrl": "https://openagent3.xyz/skills/n8n-api/agent",
    "manifestUrl": "https://openagent3.xyz/skills/n8n-api/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/n8n-api/agent.md"
  }
}
```
## Documentation

### n8n Public REST API

Use this skill when you need to drive n8n programmatically. It covers the same core actions you use in the UI: workflows, executions, tags, credentials, projects, and more.

### Availability

The public API is unavailable during the free trial.
Upgrade your plan to enable API access.

### Configuration

Recommended environment variables (or store in .n8n-api-config):

export N8N_API_BASE_URL="https://your-instance.app.n8n.cloud/api/v1"  # or http://localhost:5678/api/v1
export N8N_API_KEY="your-api-key-here"

Create the API key in: n8n Settings → n8n API → Create an API key.

### Auth header

All requests require this header:

X-N8N-API-KEY: $N8N_API_KEY

### Playground

The API playground is only available on self-hosted n8n and operates on real data. For safe experiments, use a test workflow or a separate test instance.

### Workflows: list

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/workflows" \\
  | jq '.data[] | {id, name, active}'

### Workflows: details

curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" "$N8N_API_BASE_URL/workflows/{id}"

### Workflows: activate or deactivate

# Activate (publish)
curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{"versionId":"","name":"","description":""}' \\
  "$N8N_API_BASE_URL/workflows/{id}/activate"

# Deactivate
curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  "$N8N_API_BASE_URL/workflows/{id}/deactivate"

### Webhook trigger

# Production webhook
curl -s -X POST "$N8N_API_BASE_URL/../webhook/{webhook-path}" \\
  -H "Content-Type: application/json" \\
  -d '{"key":"value"}'

# Test webhook
curl -s -X POST "$N8N_API_BASE_URL/../webhook-test/{webhook-path}" \\
  -H "Content-Type: application/json" \\
  -d '{"key":"value"}'

### Executions: list

# Recent executions
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  "$N8N_API_BASE_URL/executions?limit=10" \\
  | jq '.data[] | {id, workflowId, status, startedAt}'

# Failed only
curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  "$N8N_API_BASE_URL/executions?status=error&limit=5"

### Executions: retry

curl -s -X POST -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{"loadWorkflow":true}' \\
  "$N8N_API_BASE_URL/executions/{id}/retry"

### Health check summary

Count active workflows and recent failures:

ACTIVE=$(curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  "$N8N_API_BASE_URL/workflows?active=true" | jq '.data | length')

FAILED=$(curl -s -H "X-N8N-API-KEY: $N8N_API_KEY" \\
  "$N8N_API_BASE_URL/executions?status=error&limit=100" \\
  | jq '[.data[] | select(.startedAt > (now - 86400 | todate))] | length')

echo "Active workflows: $ACTIVE | Failed (24h): $FAILED"

### Debug a failed run

List failed executions to get the execution ID.
Fetch execution details and identify the failing node.
Review node parameters and input data.
Suggest a fix based on the error message.

### Endpoint index

See assets/n8n-api.endpoints.md for the full list of endpoints.

### REST basics (optional)

If you want a refresher, these are commonly recommended:

KnowledgeOwl: working with APIs (intro)
IBM Cloud Learn Hub: what is an API / REST API
MDN: overview of HTTP

### Notes and tips

The n8n API node can call the public API from inside workflows.
Webhook URLs are not the same as API URLs and do not use the API key header.
Execution records may be pruned based on instance retention settings.
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: codedao12
- Version: 1.0.1
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-12T09:57:57.273Z
- Expires at: 2026-05-19T09:57:57.273Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/n8n-api)
- [Send to Agent page](https://openagent3.xyz/skills/n8n-api/agent)
- [JSON manifest](https://openagent3.xyz/skills/n8n-api/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/n8n-api/agent.md)
- [Download page](https://openagent3.xyz/downloads/n8n-api)