{
  "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": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/n8n-api",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=n8n-api",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md",
      "assets/n8n-api-endpoints.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "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."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "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."
        },
        {
          "label": "Upgrade existing",
          "body": "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."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-07T17:22:31.273Z",
      "expiresAt": "2026-05-14T17:22:31.273Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=afrexai-annual-report",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=afrexai-annual-report",
        "contentDisposition": "attachment; filename=\"afrexai-annual-report-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "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."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/n8n-api",
    "agentPageUrl": "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"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "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."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "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."
      },
      {
        "label": "Upgrade existing",
        "body": "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."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "n8n Public REST API",
        "body": "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."
      },
      {
        "title": "Availability",
        "body": "The public API is unavailable during the free trial.\nUpgrade your plan to enable API access."
      },
      {
        "title": "Configuration",
        "body": "Recommended environment variables (or store in .n8n-api-config):\n\nexport N8N_API_BASE_URL=\"https://your-instance.app.n8n.cloud/api/v1\"  # or http://localhost:5678/api/v1\nexport N8N_API_KEY=\"your-api-key-here\"\n\nCreate the API key in: n8n Settings → n8n API → Create an API key."
      },
      {
        "title": "Auth header",
        "body": "All requests require this header:\n\nX-N8N-API-KEY: $N8N_API_KEY"
      },
      {
        "title": "Playground",
        "body": "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."
      },
      {
        "title": "Workflows: list",
        "body": "curl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \"$N8N_API_BASE_URL/workflows\" \\\n  | jq '.data[] | {id, name, active}'"
      },
      {
        "title": "Workflows: details",
        "body": "curl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \"$N8N_API_BASE_URL/workflows/{id}\""
      },
      {
        "title": "Workflows: activate or deactivate",
        "body": "# Activate (publish)\ncurl -s -X POST -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"versionId\":\"\",\"name\":\"\",\"description\":\"\"}' \\\n  \"$N8N_API_BASE_URL/workflows/{id}/activate\"\n\n# Deactivate\ncurl -s -X POST -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/workflows/{id}/deactivate\""
      },
      {
        "title": "Webhook trigger",
        "body": "# Production webhook\ncurl -s -X POST \"$N8N_API_BASE_URL/../webhook/{webhook-path}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"key\":\"value\"}'\n\n# Test webhook\ncurl -s -X POST \"$N8N_API_BASE_URL/../webhook-test/{webhook-path}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"key\":\"value\"}'"
      },
      {
        "title": "Executions: list",
        "body": "# Recent executions\ncurl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/executions?limit=10\" \\\n  | jq '.data[] | {id, workflowId, status, startedAt}'\n\n# Failed only\ncurl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/executions?status=error&limit=5\""
      },
      {
        "title": "Executions: retry",
        "body": "curl -s -X POST -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"loadWorkflow\":true}' \\\n  \"$N8N_API_BASE_URL/executions/{id}/retry\""
      },
      {
        "title": "Health check summary",
        "body": "Count active workflows and recent failures:\n\nACTIVE=$(curl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/workflows?active=true\" | jq '.data | length')\n\nFAILED=$(curl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/executions?status=error&limit=100\" \\\n  | jq '[.data[] | select(.startedAt > (now - 86400 | todate))] | length')\n\necho \"Active workflows: $ACTIVE | Failed (24h): $FAILED\""
      },
      {
        "title": "Debug a failed run",
        "body": "List failed executions to get the execution ID.\nFetch execution details and identify the failing node.\nReview node parameters and input data.\nSuggest a fix based on the error message."
      },
      {
        "title": "Endpoint index",
        "body": "See assets/n8n-api.endpoints.md for the full list of endpoints."
      },
      {
        "title": "REST basics (optional)",
        "body": "If you want a refresher, these are commonly recommended:\n\nKnowledgeOwl: working with APIs (intro)\nIBM Cloud Learn Hub: what is an API / REST API\nMDN: overview of HTTP"
      },
      {
        "title": "Notes and tips",
        "body": "The n8n API node can call the public API from inside workflows.\nWebhook URLs are not the same as API URLs and do not use the API key header.\nExecution records may be pruned based on instance retention settings."
      }
    ],
    "body": "n8n Public REST API\n\nUse 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.\n\nAvailability\nThe public API is unavailable during the free trial.\nUpgrade your plan to enable API access.\nConfiguration\n\nRecommended environment variables (or store in .n8n-api-config):\n\nexport N8N_API_BASE_URL=\"https://your-instance.app.n8n.cloud/api/v1\"  # or http://localhost:5678/api/v1\nexport N8N_API_KEY=\"your-api-key-here\"\n\n\nCreate the API key in: n8n Settings → n8n API → Create an API key.\n\nAuth header\n\nAll requests require this header:\n\nX-N8N-API-KEY: $N8N_API_KEY\n\nPlayground\n\nThe 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.\n\nQuick actions\nWorkflows: list\ncurl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \"$N8N_API_BASE_URL/workflows\" \\\n  | jq '.data[] | {id, name, active}'\n\nWorkflows: details\ncurl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \"$N8N_API_BASE_URL/workflows/{id}\"\n\nWorkflows: activate or deactivate\n# Activate (publish)\ncurl -s -X POST -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"versionId\":\"\",\"name\":\"\",\"description\":\"\"}' \\\n  \"$N8N_API_BASE_URL/workflows/{id}/activate\"\n\n# Deactivate\ncurl -s -X POST -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/workflows/{id}/deactivate\"\n\nWebhook trigger\n# Production webhook\ncurl -s -X POST \"$N8N_API_BASE_URL/../webhook/{webhook-path}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"key\":\"value\"}'\n\n# Test webhook\ncurl -s -X POST \"$N8N_API_BASE_URL/../webhook-test/{webhook-path}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"key\":\"value\"}'\n\nExecutions: list\n# Recent executions\ncurl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/executions?limit=10\" \\\n  | jq '.data[] | {id, workflowId, status, startedAt}'\n\n# Failed only\ncurl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/executions?status=error&limit=5\"\n\nExecutions: retry\ncurl -s -X POST -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"loadWorkflow\":true}' \\\n  \"$N8N_API_BASE_URL/executions/{id}/retry\"\n\nCommon flows\nHealth check summary\n\nCount active workflows and recent failures:\n\nACTIVE=$(curl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/workflows?active=true\" | jq '.data | length')\n\nFAILED=$(curl -s -H \"X-N8N-API-KEY: $N8N_API_KEY\" \\\n  \"$N8N_API_BASE_URL/executions?status=error&limit=100\" \\\n  | jq '[.data[] | select(.startedAt > (now - 86400 | todate))] | length')\n\necho \"Active workflows: $ACTIVE | Failed (24h): $FAILED\"\n\nDebug a failed run\nList failed executions to get the execution ID.\nFetch execution details and identify the failing node.\nReview node parameters and input data.\nSuggest a fix based on the error message.\nEndpoint index\n\nSee assets/n8n-api.endpoints.md for the full list of endpoints.\n\nREST basics (optional)\n\nIf you want a refresher, these are commonly recommended:\n\nKnowledgeOwl: working with APIs (intro)\nIBM Cloud Learn Hub: what is an API / REST API\nMDN: overview of HTTP\nNotes and tips\nThe n8n API node can call the public API from inside workflows.\nWebhook URLs are not the same as API URLs and do not use the API key header.\nExecution records may be pruned based on instance retention settings."
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/codedao12/n8n-api",
    "publisherUrl": "https://clawhub.ai/codedao12/n8n-api",
    "owner": "codedao12",
    "version": "1.0.1",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "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"
  }
}