# Firecrawl API API

> Firecrawl API API on Apizie: 20 endpoints (Scrape a single URL and optionally extract information using an LLM, Scrape multiple URLs and optionally extract information using an LLM, Get the status of a batch scrape job, Cancel a batch scrape job, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/search-tools:firecrawl/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `search-tools:firecrawl`
- Category: Search Tools
- Status: byok
- Source: https://firecrawl.dev/support
- Page: https://zieapi.vercel.app/api/search-tools/firecrawl
- OpenAPI: https://zieapi.vercel.app/api/search-tools/firecrawl/openapi.json

API for interacting with Firecrawl services to perform web scraping and crawling tasks.

## Endpoints

### Scrape a single URL and optionally extract information using an LLM
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/scrape-and-extract-from-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Scrape multiple URLs and optionally extract information using an LLM
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/scrape-and-extract-from-urls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the status of a batch scrape job
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-batch-scrape-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the batch scrape job |

### Cancel a batch scrape job
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/cancel-batch-scrape` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the batch scrape job |

### Get the errors of a batch scrape job
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-batch-scrape-errors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the batch scrape job |

### Get the status of a crawl job
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-crawl-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the crawl job |

### Cancel a crawl job
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/cancel-crawl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the crawl job |

### Get the errors of a crawl job
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-crawl-errors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the crawl job |

### Crawl multiple URLs based on options
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/crawl-urls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Map multiple URLs based on options
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/map-urls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Extract structured data from pages using LLMs
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/extract-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the status of an extract job
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-extract-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the extract job |

### Get all active crawls for the authenticated team
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-active-crawls` (byok)

### Start a deep research operation on a query
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/start-deep-research` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the status and results of a deep research operation
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-deep-research-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the research job |

### Get remaining credits for the authenticated team
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-credit-usage` (byok)

### Get remaining tokens for the authenticated team (Extract only)
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-token-usage` (byok)

### Search and optionally scrape search results
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/search-and-scrape` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Generate LLMs.txt for a website
`POST https://zieapi.vercel.app/v1/search-tools:firecrawl/generate-llms-txt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get the status and results of an LLMs.txt generation job
`GET https://zieapi.vercel.app/v1/search-tools:firecrawl/get-llms-txt-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the LLMs.txt generation job |

## Example
```
curl "https://zieapi.vercel.app/v1/search-tools:firecrawl/scrape-and-extract-from-url" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Firecrawl API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/search-tools:firecrawl/scrape-and-extract-from-url with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Firecrawl API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Firecrawl API itself also needs your own key from firecrawl.

### Can AI agents use the Firecrawl API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key search-tools:firecrawl.

### What is the status of the Firecrawl API API?
Needs your own provider key (bring your own key)