> ## Documentation Index
> Fetch the complete documentation index at: https://student-213fb9fc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Crawl 参数预览



## OpenAPI

````yaml zh/api-reference/v2-openapi.json post /crawl/params-preview
openapi: 3.0.0
info:
  title: Firecrawl API
  version: v2
  description: 用于与 Firecrawl 服务交互，执行网页抓取和爬取任务的 API。
  contact:
    name: Firecrawl Support
    url: https://firecrawl.dev/support
    email: support@firecrawl.dev
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /crawl/params-preview:
    post:
      tags:
        - Crawling
      summary: 预览由自然语言提示词生成的爬取参数
      operationId: crawlParamsPreview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: 要抓取的 URL
                prompt:
                  type: string
                  maxLength: 10000
                  description: 用自然语言编写的、描述你想爬取内容的提示词
              required:
                - url
                - prompt
      responses:
        '200':
          description: 成功响应（包含生成的爬取参数）
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      url:
                        type: string
                        format: uri
                        description: 要爬取的 URL
                      includePaths:
                        type: array
                        items:
                          type: string
                        description: 包含的 URL 模式
                      excludePaths:
                        type: array
                        items:
                          type: string
                        description: 排除的 URL 模式
                      maxDepth:
                        type: integer
                        description: 最大爬取深度
                      maxDiscoveryDepth:
                        type: integer
                        description: 最大探索深度
                      crawlEntireDomain:
                        type: boolean
                        description: 是否爬取整个域名
                      allowExternalLinks:
                        type: boolean
                        description: 是否允许外部链接
                      allowSubdomains:
                        type: boolean
                        description: 是否允许子域名
                      sitemap:
                        type: string
                        enum:
                          - skip
                          - include
                        description: 站点地图处理策略
                      ignoreQueryParameters:
                        type: boolean
                        description: 是否忽略查询参数
                      deduplicateSimilarURLs:
                        type: boolean
                        description: 是否对相似 URL 去重
                      delay:
                        type: number
                        description: 请求间隔（毫秒）
                      limit:
                        type: integer
                        description: 最大抓取页面数
        '400':
          description: 错误请求
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Invalid request parameters
        '401':
          description: 未授权
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Unauthorized
        '500':
          description: 服务器错误
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Failed to process natural language prompt
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````