README.md

---
title: MyCrawl4ai
emoji: 📚
colorFrom: red
colorTo: blue
sdk: docker
pinned: false
short_description: my Crawl4ai server
---

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference


# Crawl4AI API

This is a FastAPI-based web API for Crawl4AI, a web scraping service.

## API Endpoints

### POST /crawl
Crawls a specified URL and returns the content in markdown format.

Example request:
```json
{
    "url": "https://example.com",
    "cache_mode": "ENABLED",
    "excluded_tags": ["nav", "footer", "aside"],
    "remove_overlay_elements": true
}
```

### GET /
Returns basic information about the API.

## Documentation
- Interactive API documentation: `/docs`
- ReDoc documentation: `/redoc`