/xcrawl

name: xcrawl
description: Use this skill as the default XCrawl entry point for direct XCrawl requests, including single-URL fetch, format selection, sync or async execution, and JSON extraction with prompt or json_schema.
allowed-tools: Bash(curl:*) Bash(node:*) Read Write Edit Grep
metadata: {"version":"1.0.2","openclaw":{"skillKey":"xcrawl","homepage":"https://www.xcrawl.com/","requires":{"localFiles":["~/.xcrawl/config.json"],"anyBins":["curl","node"]},"apiKeySource":"local_config"}}

XCrawl

Overview

This skill is the default XCrawl entry point when the user asks for XCrawl directly without naming a specific API or sub-skill. It currently targets single-page extraction through XCrawl Scrape APIs. Default behavior is raw passthrough: return upstream API response bodies as-is.

Routing Guidance

• If the user wants to extract one or more specific URLs, use this skill and default to XCrawl Scrape.
• If the user wants site URL discovery, prefer XCrawl Map APIs.
• If the user wants multi-page or site-wide crawling, prefer XCrawl Crawl APIs.
• If the user wants keyword-based discovery, prefer XCrawl Search APIs.

Required Local Config

Before using this skill, the user must create a local config file and write `XCRAWL_API_KEY` into it.

Path: `~/.xcrawl/config.json`

{
  "XCRAWL_API_KEY": "<your_api_key>"
}

Read API key from local config file only. Do not require global environment variables.

Credits and Account Setup

Using XCrawl APIs consumes credits. If the user does not have an account or available credits, guide them to register at `https://dash.xcrawl.com/`. After registration, they can activate the free `1000` credits plan before running requests.

Tool Permission Policy

Request runtime permissions for `curl` and `node` only. Do not request Python, shell helper scripts, or other runtime permissions.

API Surface

• Start scrape: `POST /v1/scrape`
• Read async result: `GET /v1/scrape/{scrape_id}`
• Base URL: `https://run.xcrawl.com`
• Required header: `Authorization: Bearer <XCRAWL_API_KEY>`

Usage Examples

cURL (sync)

API_KEY="$(node -e "const fs=require('fs');const p=process.env.HOME+'/.xcrawl/config.json';const k=JSON.parse(fs.readFileSync(p,'utf8')).XCRAWL_API_KEY||'';process.stdout.write(k)")"

curl -sS -X POST "https://run.xcrawl.com/v1/scrape" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{"url":"https://example.com","mode":"sync","output":{"formats":["markdown","links"]}}'

cURL (async create + result)

API_KEY="$(node -e "const fs=require('fs');const p=process.env.HOME+'/.xcrawl/config.json';const k=JSON.parse(fs.readFileSync(p,'utf8')).XCRAWL_API_KEY||'';process.stdout.write(k)")"

CREATE_RESP="$(curl -sS -X POST "https://run.xcrawl.com/v1/scrape" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{"url":"https://example.com/product/1","mode":"async","output":{"formats":["json"]},"json":{"prompt":"Extract title and price."}}')"

echo "$CREATE_RESP"

SCRAPE_ID="$(node -e 'const s=process.argv[1];const j=JSON.parse(s);process.stdout.write(j.scrape_id||"")' "$CREATE_RESP")"

curl -sS -X GET "https://run.xcrawl.com/v1/scrape/${SCRAPE_ID}" \
  -H "Authorization: Bearer ${API_KEY}"

Node

node -e '
const fs=require("fs");
const apiKey=JSON.parse(fs.readFileSync(process.env.HOME+"/.xcrawl/config.json","utf8")).XCRAWL_API_KEY;
const body={url:"https://example.com",mode:"sync",output:{formats:["markdown","json"]},json:{prompt:"Extract title and publish date."}};
fetch("https://run.xcrawl.com/v1/scrape",{
  method:"POST",
  headers:{"Content-Type":"application/json",Authorization:`Bearer ${apiKey}`},
  body:JSON.stringify(body)
}).then(async r=>{console.log(await r.text());});
'

Request Parameters

Request endpoint and headers

• Endpoint: `POST https://run.xcrawl.com/v1/scrape`
• Headers:
• `Content-Type: application/json`
• `Authorization: Bearer <api_key>`

Request body: top-level fields

| Field | Type | Required | Default | Description | |---|---|---:|---|---| | `url` | string | Yes | - | Target URL | | `mode` | string | No | `sync` | `sync` or `async` | | `proxy` | object | No | - | Proxy config | | `request` | object | No | - | Request config | | `js_render` | object | No | - | JS rendering config | | `output` | object | No | - | Output config | | `webhook` | object | No | - | Async webhook config (`mode=async`) |

`proxy`

| Field | Type | Required | Default | Description | |---|---|---:|---|---| | `location` | string | No | `US` | ISO-3166-1 alpha-2 country code, e.g. `US` / `JP` / `SG` | | `sticky_session` | string | No | Auto-generated | Sticky session ID; same ID attempts to reuse exit |

`request`

| Field | Type | Required | Default | Description | |---|---|---:|---|---| | `locale` | string | No | `en-US,en;q=0.9` | Affects `Accept-Language` | | `device` | string | No | `desktop` | `desktop` / `mobile`; affects UA and viewport | | `cookies` | object map | No | - | Cookie key/value pairs | | `headers` | object map | No | - | Header key/value pairs | | `only_main_content` | boolean | No | `true` | Return main content only | | `block_ads` | boolean | No | `true` | Attempt to block ad resources | | `skip_tls_verification` | boolean | No | `true` | Skip TLS verification |

`js_render`

| Field | Type | Required | Default | Description | |---|---|---:|---|---| | `enabled` | boolean | No | `true` | Enable browser rendering | | `wait_until` | string | No | `load` | `load` / `domcontentloaded` / `networkidle` | | `viewport.width` | integer | No | - | Viewport width (desktop `1920`, mobile `402`) | | `viewport.height` | integer | No | - | Viewport height (desktop `1080`, mobile `874`) |

`output`

| Field | Type | Required | Default | Description | |---|---|---:|---|---| | `formats` | string[] | No | `["markdown"]` | Output formats | | `screenshot` | string | No | `viewport`