Run the API
From the repository root:http://127.0.0.1:8000 by default.
For browser-first rendering, start Bee Engine in another terminal:
Get started
Quickstart
Run BeeCrawl locally and make your first API request.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Run BeeCrawl locally and make your first API request.
make api
http://127.0.0.1:8000 by default.
For browser-first rendering, start Bee Engine in another terminal:
make install
make playwright-install
make bee-engine
curl http://127.0.0.1:8000/scrape \
-H 'Content-Type: application/json' \
-d '{
"url": "https://example.com",
"formats": ["markdown", "links"],
"use_browser": "auto"
}'
make db-up
export BEECRAWL_DATABASE_URL=postgres://postgres:postgres@127.0.0.1:55432/beecrawl
make migrate-up
make api
make worker
curl http://127.0.0.1:8000/crawl \
-H 'Content-Type: application/json' \
-d '{"url":"https://example.com","limit":100,"maxDepth":2}'
curl 'http://127.0.0.1:8000/crawl/CRAWL_ID?offset=0&limit=20'