Skip to content
Back to search

xcrawl-skills

Reusable Xcrawl skill definitions for multi-agent runtimes, focused on API-first web data workflows.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/xcrawl-api--xcrawl-skills/badge.svg)](/listings/xcrawl-api--xcrawl-skills)

HTML

<a href="/listings/xcrawl-api--xcrawl-skills"><img src="/api/listings/xcrawl-api--xcrawl-skills/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

1. Prerequisites

- An XCrawl API key - Register at `https://dash.xcrawl.com/` and activate the free `1000` credits plan - Runtime binaries: `curl` and `node` - Access to this repository

2. Configure Local API Key

Create local config file:

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

{
  "XCRAWL_API_KEY": "<your_api_key>"
}

Skills in this repo are designed to read `XCRAWL_API_KEY` from this local file.

3. Choose a Skill

Open one of:

- `skills/xcrawl/SKILL.md` - `skills/xcrawl-scrape/SKILL.md` - `skills/xcrawl-map/SKILL.md` - `skills/xcrawl-crawl/SKILL.md` - `skills/xcrawl-search/SKILL.md`

Each skill includes:

- Applicable scenarios - Request parameters - Response parameters - cURL / Node examples

4. Run Requests

Use the examples in each `SKILL.md` directly, then adapt request payloads for your business scenario.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 103 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # XCrawl Skills
  2. Reusable XCrawl skill definitions for multi-agent runtimes, focused on API-first web data workflows.
  3. Canonical repository: `https://github.com/xcrawl-api/xcrawl-skills`
  4. English | [中文](README.zh-CN.md)
  5. ## What Is XCrawl
  6. XCrawl is a web data infrastructure product for search, scraping, URL mapping, and site crawling.
  7. This repository provides production-oriented skill definitions that help agents call XCrawl APIs consistently.
  8. ## What This Repository Provides
  9. - Ready-to-use skills for common XCrawl workflows
  10. - API-oriented instructions with request/response parameter documentation
  11. - cURL and Node examples suitable for runtime execution
  12. - A consistent contract for multi-agent orchestration
  13. ## Skill Catalog
  14. - `xcrawl`: Default XCrawl entry skill for direct lookup and single-URL extraction
  15. - `xcrawl-scrape`: Single-URL extraction and structured data workflows
  16. - `xcrawl-map`: Site URL discovery and scope planning workflows
  17. - `xcrawl-crawl`: Bulk site crawling and async result handling workflows
  18. - `xcrawl-search`: Query-based discovery with location/language controls
  19. ## Quick Start
  20. ### 1. Prerequisites
  21. - An XCrawl API key
  22. - Register at `https://dash.xcrawl.com/` and activate the free `1000` credits plan
  23. - Runtime binaries: `curl` and `node`
  24. - Access to this repository
  25. ### 2. Configure Local API Key
  26. Create local config file:
  27. Path: `~/.xcrawl/config.json`
  28. ```json
  29. {
  30. "XCRAWL_API_KEY": "<your_api_key>"
  31. }
  32. ```
  33. Skills in this repo are designed to read `XCRAWL_API_KEY` from this local file.
  34. ### 3. Choose a Skill
  35. Open one of:
  36. - `skills/xcrawl/SKILL.md`
  37. - `skills/xcrawl-scrape/SKILL.md`
  38. - `skills/xcrawl-map/SKILL.md`
  39. - `skills/xcrawl-crawl/SKILL.md`
  40. - `skills/xcrawl-search/SKILL.md`
  41. Each skill includes:
  42. - Applicable scenarios
  43. - Request parameters
  44. - Response parameters
  45. - cURL / Node examples
  46. ### 4. Run Requests
  47. Use the examples in each `SKILL.md` directly, then adapt request payloads for your business scenario.
  48. ## Example User Intents
  49. - "Scrape this page in sync mode and return markdown + links."
  50. - "Map only `/docs/` URLs under this domain with a limit of 2000."
  51. - "Start a bounded crawl (depth 2, limit 100) and poll until completed."
  52. - "Search in US English and return top 20 results for this query."
  53. ## Cross-Agent Contract
  54. Each skill can be executed through a runtime adapter layer.
  55. - Input normalization: `goal`, `inputs`, `constraints`, `credentials_ref`, `runtime_context`
  56. - Output normalization: `status`, `request_payload`, `raw_response` or async pair, `task_ids`, `error`
  57. Default behavior is raw passthrough: return upstream API response bodies as-is.
  58. ## Shared XCrawl Conventions
  59. - Base URL: `https://run.xcrawl.com`
  60. - Local config file: `~/.xcrawl/config.json`
  61. - API key field in local config: `XCRAWL_API_KEY`
  62. - Auth header: `Authorization: Bearer <XCRAWL_API_KEY>`
  63. - Main endpoints:
  64. - `POST /v1/scrape` and `GET /v1/scrape/{scrape_id}`
  65. - `POST /v1/map`
  66. - `POST /v1/crawl` and `GET /v1/crawl/{crawl_id}`
  67. - `POST /v1/search`
  68. ## Support
  69. - [XCrawl Homepage](https://www.xcrawl.com/)
  70. - [XCrawl Documentation](https://docs.xcrawl.com/)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.