serving-the-api

Serve crawlberg engine operations via an HTTP API with Firecrawl v1 protocol.

26|2|Updated Jun 8, 2026
One-click install
npx skills add https://github.com/xberg-io/plugins --skill serving-the-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: serving-the-api
Source: https://github.com/xberg-io/plugins/tree/main/plugins/crawlberg/.cursor-plugin/skills/serving-the-api
Command: npx skills add https://github.com/xberg-io/plugins --skill serving-the-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill enables the crawlberg engine to operate as a persistent, HTTP-based REST API. This approach allows the crawler to be integrated with other applications or non-agent clients through network interfaces.

Core Features & Use Cases

  • HTTP API Server: Launch a long-running HTTP server to expose crawl functions.
  • Firecrawl Compatibility: Utilize Firecrawl v1-compatible endpoints for scraping, crawling, and mapping.
  • Use Case: For instance, developers can use this Skill to set up a custom service within a larger application that requires access to the crawlberg functionality over a RESTful API interface.

Quick Start

To start the API service and listen on localhost port 3000, use the following command:

  • crawlberg serve --host 127.0.0.1 --port 3000

Frequently Asked Questions about serving-the-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I expose a crawler service as a REST API for web scraping?

You can expose crawlberg as an HTTP API server using the command `crawlberg serve --host 127.0.0.1 --port 3000`. This launches a persistent REST API for scraping, crawling, and mapping operations over a network.

Is there a Firecrawl compatible API server for running scraping operations?

Yes, the crawlberg HTTP server implements the Firecrawl v1 protocol. This compatibility allows you to use various existing Firecrawl client implementations to perform scraping and crawling operations.

How do I start an HTTP server for web scraping on localhost?

Start the HTTP server for web scraping by running `crawlberg serve --host 127.0.0.1 --port 3000`. This initiates a long-running REST API service listening on your local machine.

Do I need a specific feature flag enabled to run the crawler service as an API?

Yes, running the crawler service as an API requires the `api` feature flag to be enabled during binary creation. Without this compile-time flag, the HTTP server interface is unavailable.

Can I integrate a crawling engine with non-agent applications over a network?

Yes, you can integrate the crawling engine with non-agent applications by serving it as a persistent HTTP REST API. This allows other software to access crawl functionality through standard network requests.