# Crawler API API

> Crawler API API on Apizie: 20 endpoints (List crawlers, Create a crawler, Retrieve crawler details, Replace crawler configuration, …) 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://apizie.tech/v1/search-tools:algolia-crawler/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `search-tools:algolia-crawler`
- Category: Search Tools
- Status: byok
- Source: https://algolia
- Page: https://apizie.tech/api/search-tools/algolia-crawler
- OpenAPI: https://apizie.tech/api/search-tools/algolia-crawler/openapi.json

## Base URL The base URL for making requests to the Crawler API is: - `https://crawler.algolia.com/api` **All requests must use HTTPS.** ## Availability and authentication To authenticate your API requests, use the…

## Endpoints

### List crawlers
`GET https://apizie.tech/v1/search-tools:algolia-crawler/list-crawlers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemsPerPage | integer | no | Number of items per page to retrieve. |
| page | integer | no | Page to retrieve. |
| name | string | no | Name of the crawler for filtering the API response. |
| appID | string | no | Algolia application ID for filtering the API response. |

### Create a crawler
`POST https://apizie.tech/v1/search-tools:algolia-crawler/create-crawler` (byok)

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

### Retrieve crawler details
`GET https://apizie.tech/v1/search-tools:algolia-crawler/get-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| withConfig | boolean | no | Whether the response should include the crawler's configuration. |

### Replace crawler configuration
`POST https://apizie.tech/v1/search-tools:algolia-crawler/patch-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| body | object | no | JSON request body |

### Delete a crawler
`POST https://apizie.tech/v1/search-tools:algolia-crawler/delete-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |

### Unpause a crawler
`POST https://apizie.tech/v1/search-tools:algolia-crawler/run-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |

### Pause a crawler
`POST https://apizie.tech/v1/search-tools:algolia-crawler/pause-crawler` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |

### Start a crawl
`POST https://apizie.tech/v1/search-tools:algolia-crawler/start-reindex` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |

### Test crawl a URL
`POST https://apizie.tech/v1/search-tools:algolia-crawler/test-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| body | object | no | JSON request body |

### Crawl URLs
`POST https://apizie.tech/v1/search-tools:algolia-crawler/crawl-urls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| body | object | no | JSON request body |

### Retrieve crawler stats
`GET https://apizie.tech/v1/search-tools:algolia-crawler/get-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |

### List crawler runs
`GET https://apizie.tech/v1/search-tools:algolia-crawler/list-crawl-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| from | string | no | Date 'from' filter. |
| until | string | no | Date 'until' filter. |
| status | string | no | Status to filter 'DONE', 'SKIPPED' or 'FAILED'. |
| limit | integer | no | Limit of the query results. |
| offset | integer | no | Offset of the query results. |
| order | string | no | Order of the query 'ASC' or 'DESC'. |

### Crawler run file
`GET https://apizie.tech/v1/search-tools:algolia-crawler/get-crawl-run-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| logId | string | yes | Crawler log ID. |

### Crawler run record deletion
`POST https://apizie.tech/v1/search-tools:algolia-crawler/delete-crawl-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| body | object | no | JSON request body |

### Update crawler configuration
`POST https://apizie.tech/v1/search-tools:algolia-crawler/patch-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| body | object | no | JSON request body |

### List configuration versions
`GET https://apizie.tech/v1/search-tools:algolia-crawler/list-config-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| itemsPerPage | integer | no | Number of items per page to retrieve. |
| page | integer | no | Page to retrieve. |

### Retrieve a configuration version
`GET https://apizie.tech/v1/search-tools:algolia-crawler/get-config-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| version | integer | yes | This crawler's version nmber. |

### Retrieve task status
`GET https://apizie.tech/v1/search-tools:algolia-crawler/get-task-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| taskID | string | yes | Task ID. |

### Cancel a blocking task
`POST https://apizie.tech/v1/search-tools:algolia-crawler/cancel-blocking-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Crawler ID. |
| taskID | string | yes | Task ID. |

### List registered domains
`GET https://apizie.tech/v1/search-tools:algolia-crawler/list-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| itemsPerPage | integer | no | Number of items per page to retrieve. |
| page | integer | no | Page to retrieve. |
| appID | string | no | Algolia application ID for filtering the API response. |

## Example
```
curl "https://apizie.tech/v1/search-tools:algolia-crawler/list-crawlers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Crawler API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/search-tools:algolia-crawler/list-crawlers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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