Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.fetchfox.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Get your API key

First, you’ll need your API key. You can find it in the FetchFox app at https://fetchfox.ai/settings/api-keys.

​
Run a scrape

To run a scrape, use the /api/scrape endpoint with:
  • pattern for URL matching
  • template for the output shape
curl -X POST https://api.fetchfox.ai/api/scrape \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
  "pattern": "https://pokemondb.net/pokedex/*",
  "template": {
    "name": "Pokemon name",
    "number": "Pokemon number"
  },
  "maxVisits": 10,
  "maxExtracts": 10
}'
When the scrape finishes, the extracted items are in results.items.

​
Next Steps

Now that you’ve run a simple scrape:
  1. Learn how crawl and extract work together.
  2. Learn how to control crawl scope and cost.