> ## 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.

# Prévia de Parâmetros de Crawler



## OpenAPI

````yaml pt-BR/api-reference/v2-openapi.json post /crawl/params-preview
openapi: 3.0.0
info:
  title: Firecrawl API
  version: v2
  description: >-
    API para interagir com os serviços do Firecrawl e executar tarefas de web
    scraping e crawling.
  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: >-
        Pré-visualizar parâmetros de rastreamento gerados a partir de um prompt
        em linguagem natural
      operationId: crawlParamsPreview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: URL a ser rastreada
                prompt:
                  type: string
                  maxLength: 10000
                  description: >-
                    Prompt em linguagem natural que descreve o que você deseja
                    rastrear
              required:
                - url
                - prompt
      responses:
        '200':
          description: Resposta bem-sucedida com parâmetros de rastreamento gerados
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      url:
                        type: string
                        format: uri
                        description: A URL que será rastreada
                      includePaths:
                        type: array
                        items:
                          type: string
                        description: Padrões de URL a serem incluídos
                      excludePaths:
                        type: array
                        items:
                          type: string
                        description: Padrões de URL a serem excluídos
                      maxDepth:
                        type: integer
                        description: Profundidade máxima de rastreamento
                      maxDiscoveryDepth:
                        type: integer
                        description: Profundidade máxima de descoberta
                      crawlEntireDomain:
                        type: boolean
                        description: Se deve rastrear todo o domínio
                      allowExternalLinks:
                        type: boolean
                        description: Define se links externos serão permitidos
                      allowSubdomains:
                        type: boolean
                        description: Permitir subdomínios
                      sitemap:
                        type: string
                        enum:
                          - skip
                          - include
                        description: Estratégia de tratamento de sitemaps
                      ignoreQueryParameters:
                        type: boolean
                        description: >-
                          Indica se os parâmetros de consulta devem ser
                          ignorados
                      deduplicateSimilarURLs:
                        type: boolean
                        description: Se URLs semelhantes devem ser deduplicadas
                      delay:
                        type: number
                        description: Intervalo entre requisições em milissegundos
                      limit:
                        type: integer
                        description: Número máximo de páginas para rastrear
        '400':
          description: Solicitação inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Invalid request parameters
        '401':
          description: Não autorizado
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Unauthorized
        '500':
          description: Erro do servidor
          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

````