---
title: "Preview crawl parameters generated from natural language prompt"
method: POST
path: "/crawl/params-preview"
tags: ["Crawling"]
---

# Preview crawl parameters generated from natural language prompt

`POST /crawl/params-preview`

## Request body

- object
  - `url` string, uri, required — The URL to crawl
  - `prompt` string, required — Natural language prompt describing what you want to crawl

## Response `200`

Successful response with generated crawl parameters

- object
  - `success` boolean
  - `data` object
    - `url` string, uri — The URL to crawl
    - `includePaths` string[] — URL patterns to include
    - `excludePaths` string[] — URL patterns to exclude
    - `maxDepth` integer — Maximum crawl depth
    - `maxDiscoveryDepth` integer — Maximum discovery depth
    - `crawlEntireDomain` boolean — Whether to crawl the entire domain
    - `allowExternalLinks` boolean — Whether to allow external links
    - `allowSubdomains` boolean — Whether to allow subdomains
    - `sitemap` 'skip' | 'include' — Sitemap handling strategy
    - `ignoreQueryParameters` boolean — Whether to ignore query parameters
    - `ignoreRobotsTxt` boolean — Whether robots.txt rules are ignored
    - `robotsUserAgent` string — Custom User-Agent string used for robots.txt evaluation
    - `deduplicateSimilarURLs` boolean — Whether to deduplicate similar URLs
    - `delay` number — Delay between requests in milliseconds
    - `limit` integer — Maximum number of pages to crawl

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Server error

---

[API](https://skmtc.dev/firecrawl/apis/firecrawl-api.md) · [All operations](https://skmtc.dev/firecrawl/apis/firecrawl-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/firecrawl/firecrawl-api/revisions/e350fafb5a2a/schema)