> ## Documentation Index
> Fetch the complete documentation index at: https://firecrawl-noaa-mar-900-create-self-partnership-provisioning.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Parse

Envie um documento local ou não público e converta-o em dados limpos, prontos para LLM. O `/parse` aceita os bytes do arquivo via `multipart/form-data` e retorna Markdown, JSON, HTML, links, imagens ou um resumo — com a ordem de leitura e as tabelas preservadas.

* Converta PDF, DOCX, XLSX, HTML e outros formatos em Markdown ou JSON estruturado
* Análise até **5x mais rápida** com um mecanismo baseado em Rust
* Arquivos de até **50 MB** por solicitação
* Suporte a Zero Data Retention

<div id="when-to-use-parse">
  ## Quando usar `/parse`
</div>

Use `/parse` quando o documento de origem for **um arquivo local** ou **não estiver acessível publicamente por URL**. Se você tiver uma URL pública que aponte para um documento, prefira [`/scrape`](/pt-BR/api-reference/endpoint/scrape) — ele detecta automaticamente o tipo de arquivo pela extensão ou pelo tipo de conteúdo e faz o parsing da mesma forma.

| Origem                                                                        | Endpoint                                               |
| ----------------------------------------------------------------------------- | ------------------------------------------------------ |
| URL pública para um documento (por exemplo, `https://example.com/report.pdf`) | [`POST /scrape`](/pt-BR/api-reference/endpoint/scrape) |
| Arquivo local ou bytes não públicos (PDF, DOCX, XLSX, HTML, …)                | `POST /parse` (este endpoint)                          |


## OpenAPI

````yaml /pt-BR/api-reference/v2-openapi.json POST /parse
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:
  /parse:
    post:
      tags:
        - Scraping
      summary: Envie e analise um arquivo
      operationId: parseFile
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    Os bytes do arquivo a serem analisados. Extensões
                    compatíveis: .html, .htm, .pdf, .docx, .doc, .odt, .rtf,
                    .xlsx, .xls.
                options:
                  $ref: '#/components/schemas/ParseOptions'
              required:
                - file
            encoding:
              options:
                contentType: application/json
      responses:
        '200':
          description: Resposta bem-sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScrapeResponse'
        '400':
          description: Solicitação inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  code:
                    type: string
                    example: BAD_REQUEST
                  error:
                    type: string
                    example: Invalid multipart form-data request.
        '402':
          description: Pagamento necessário
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Payment required to access this resource.
        '429':
          description: Solicitações demais
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Request rate limit exceeded. Please wait and try again
                      later.
        '500':
          description: Erro no servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  code:
                    type: string
                    example: UNKNOWN_ERROR
                  error:
                    type: string
                    example: An unexpected error occurred on the server.
      security:
        - bearerAuth: []
components:
  schemas:
    ParseOptions:
      type: object
      description: >-
        Opções opcionais de análise enviadas como JSON no campo multipart
        `options`.
      properties:
        formats:
          $ref: '#/components/schemas/ParseFormats'
        onlyMainContent:
          type: boolean
          description: >-
            Retorne apenas o conteúdo principal da página, excluindo cabeçalhos,
            navegação, rodapés etc.
          default: true
        includeTags:
          type: array
          items:
            type: string
          description: Tags a serem incluídas no resultado.
        excludeTags:
          type: array
          items:
            type: string
          description: Tags a serem excluídas do resultado.
        headers:
          type: object
          description: >-
            Cabeçalhos a serem enviados quando forem necessárias requisições de
            rede adicionais.
        timeout:
          type: integer
          description: >-
            Tempo limite em milissegundos para a solicitação. O padrão é 30000
            (30 segundos). O máximo é 300000 (300 segundos).
          default: 30000
          maximum: 300000
        parsers:
          type: array
          description: >-
            Controla o comportamento do analisador de arquivos quando aplicável,
            por exemplo, o modo do analisador de PDF.
          items:
            oneOf:
              - type: object
                properties:
                  type:
                    type: string
                    enum:
                      - pdf
                  mode:
                    type: string
                    enum:
                      - fast
                      - auto
                      - ocr
                    default: auto
                    description: >-
                      Modo de análise de PDF. "fast": extração somente de texto.
                      "auto": prioriza texto, com fallback para OCR. "ocr": OCR
                      em todas as páginas.
                  maxPages:
                    type: integer
                    minimum: 1
                    maximum: 10000
                    description: Número máximo de páginas a serem analisadas do PDF.
                required:
                  - type
                additionalProperties: false
          default:
            - pdf
        skipTlsVerification:
          type: boolean
          description: Ignora a verificação do certificado TLS ao fazer requisições.
          default: true
        removeBase64Images:
          type: boolean
          description: >-
            Remove imagens codificadas em base64 do resultado e mantém os
            marcadores de texto alternativo.
          default: true
        blockAds:
          type: boolean
          description: Ativa o bloqueio de anúncios e pop-ups de cookies.
          default: true
        proxy:
          type: string
          enum:
            - basic
            - auto
          description: >-
            Modo de proxy para uploads em `/parse`. `/parse` aceita apenas
            `basic` e `auto`.
        origin:
          type: string
          description: Identificador de origem para analytics e logs.
          default: api
        integration:
          type: string
          nullable: true
          description: Identificador opcional de integração.
        zeroDataRetention:
          type: boolean
          default: false
          description: >-
            Se verdadeiro, ativa a retenção zero de dados para esta análise.
            Para ativar esse recurso, entre em contato com help@firecrawl.dev
    ScrapeResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            markdown:
              type: string
            summary:
              type: string
              nullable: true
              description: Resumo da página se `summary` constar em `formats`
            html:
              type: string
              nullable: true
              description: >-
                HTML limpo da página, se `html` estiver incluído em `formatos`.
                Remove as tags `<script>`, `<style>`, `<noscript>`, `<meta>` e
                `<head>`; converte URLs relativas em absolutas; resolve o
                `srcset` de imagens responsivas para a versão de maior
                resolução. Respeita os filtros `onlyMainContent`, `includeTags`
                e `excludeTags`.
            rawHtml:
              type: string
              nullable: true
              description: >-
                O HTML exato, sem modificações, recebido da página quando
                `rawHtml` está em `formats`. Nenhuma limpeza ou filtragem é
                realizada.
            screenshot:
              type: string
              nullable: true
              description: >-
                Captura de tela da página se `screenshot` estiver incluído em
                `formats`. As capturas de tela expiram após 24 horas e não
                poderão mais ser baixadas.
            audio:
              type: string
              nullable: true
              description: >-
                URL assinada para o arquivo de áudio MP3 extraído, se `audio`
                estiver em `formatos`. A URL assinada expira em 1 hora.
            video:
              type: string
              nullable: true
              description: >-
                URL assinada para o arquivo de vídeo extraído, se `video`
                estiver em `formatos`. A URL assinada expira após 1 hora.
            answer:
              type: string
              nullable: true
              description: >-
                Resposta em linguagem natural à pergunta fornecida pelo formato
                `question`. Presente apenas se um objeto de formato `question`
                tiver sido incluído em `formats`.
            highlights:
              type: string
              nullable: true
              description: >-
                Texto-fonte relevante selecionado pelo formato `highlights`.
                Presente apenas se um objeto de formato `highlights` tiver sido
                incluído em `formats`.
            links:
              type: array
              items:
                type: string
              description: Lista de links da página se `links` estiver em `formatos`
            actions:
              type: object
              nullable: true
              description: >-
                Resultados das ações especificadas no parâmetro `actions`. Só
                estará presente se o parâmetro `actions` tiver sido fornecido na
                requisição
              properties:
                screenshots:
                  type: array
                  description: >-
                    URLs das capturas de tela, na mesma ordem das ações de
                    captura de tela fornecidas.
                  items:
                    type: string
                    format: url
                scrapes:
                  type: array
                  description: >-
                    Extraia o conteúdo na mesma ordem das ações de scraping
                    fornecidas.
                  items:
                    type: object
                    properties:
                      url:
                        type: string
                      html:
                        type: string
                javascriptReturns:
                  type: array
                  description: >-
                    Valores de retorno em JavaScript, na mesma ordem das ações
                    executeJavascript fornecidas.
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                      value: {}
                pdfs:
                  type: array
                  description: PDFs gerados, na mesma ordem das ações de PDF especificadas.
                  items:
                    type: string
            metadata:
              type: object
              properties:
                title:
                  oneOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                  description: >-
                    Título extraído da página; pode ser uma string ou um array
                    de strings
                description:
                  oneOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                  description: >-
                    Descrição extraída da página, que pode ser uma string ou um
                    array de strings
                language:
                  oneOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                  nullable: true
                  description: >-
                    Idioma detectado na página; pode ser uma string ou um array
                    de strings
                sourceURL:
                  type: string
                  format: uri
                  description: >-
                    A URL original solicitada. Pode ser diferente da URL final
                    da página se houver redirecionamentos.
                url:
                  type: string
                  format: uri
                  description: >-
                    A URL final da página após seguir todos os
                    redirecionamentos.
                keywords:
                  oneOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                  description: >-
                    Palavras-chave extraídas da página; pode ser uma string ou
                    um array de strings
                ogLocaleAlternate:
                  type: array
                  items:
                    type: string
                  description: Localidades alternativas para a página
                '<any other metadata> ':
                  oneOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                  description: >-
                    Outros metadados extraídos do HTML. Pode ser uma string ou
                    um array de strings
                statusCode:
                  type: integer
                  description: O código de status da página
                contentType:
                  type: string
                  description: >-
                    O tipo de conteúdo (MIME) da página, por exemplo, text/html,
                    application/pdf
                error:
                  type: string
                  nullable: true
                  description: Mensagem de erro da página
                concurrencyLimited:
                  type: boolean
                  description: >-
                    Se este scraping foi limitado devido aos limites de
                    concorrência da equipe
                concurrencyQueueDurationMs:
                  type: number
                  description: >-
                    Tempo, em milissegundos, que a solicitação aguardou na fila
                    de concorrência. Presente apenas quando concurrencyLimited é
                    true.
            warning:
              type: string
              nullable: true
              description: >-
                Pode ser exibida ao usar Extração com LLM. A mensagem de alerta
                informará sobre quaisquer problemas na extração.
            changeTracking:
              type: object
              nullable: true
              description: >-
                Informações de rastreamento de alterações se `changeTracking`
                estiver em `formats`. Somente presente quando o formato
                `changeTracking` for solicitado.
              properties:
                previousScrapeAt:
                  type: string
                  format: date-time
                  nullable: true
                  description: >-
                    O timestamp da raspagem anterior em relação à qual a página
                    atual está sendo comparada. Nulo se não houver raspagem
                    anterior.
                changeStatus:
                  type: string
                  enum:
                    - new
                    - same
                    - changed
                    - removed
                  description: >-
                    O resultado da comparação entre as duas versões da página:
                    'new' indica que esta página não existia antes, 'same'
                    indica que o conteúdo não mudou, 'changed' indica que o
                    conteúdo foi alterado e 'removed' indica que a página foi
                    removida.
                visibility:
                  type: string
                  enum:
                    - visible
                    - hidden
                  description: >-
                    A visibilidade da página/URL atual. "visible" significa que
                    a URL foi descoberta por meio de uma rota orgânica (links ou
                    sitemap); "hidden" significa que a URL foi descoberta a
                    partir da memória de rastreamentos anteriores.
                diff:
                  type: string
                  nullable: true
                  description: >-
                    Diff das alterações no estilo do Git ao usar o modo
                    `git-diff`. Só é retornado quando o modo está definido como
                    `git-diff`.
                json:
                  type: object
                  nullable: true
                  description: >-
                    Resultados da comparação em JSON ao usar o modo `json`.
                    Disponível apenas quando o modo está definido como `json`.
                    Isso gera uma lista de todas as chaves e seus valores das
                    coletas `previous` e `current`, com base no tipo definido no
                    `schema`. Exemplo [aqui](/features/change-tracking)
            branding:
              type: object
              nullable: true
              description: >-
                Informações de branding extraídas da página quando `branding`
                estiver em `formatos`. Inclui cores, fontes, tipografia,
                espaçamento, componentes e muito mais.
              properties:
                colorScheme:
                  type: string
                  enum:
                    - light
                    - dark
                  description: Esquema de cores detectado da página.
                logo:
                  type: string
                  nullable: true
                  description: URL do logotipo principal.
                colors:
                  type: object
                  nullable: true
                  description: Cores da marca extraídas da página.
                  properties:
                    primary:
                      type: string
                      description: Cor principal da marca (hex).
                    secondary:
                      type: string
                      description: Cor secundária da marca (hex).
                    accent:
                      type: string
                      description: Cor de destaque (hex).
                    background:
                      type: string
                      description: Cor de fundo (hex).
                    textPrimary:
                      type: string
                      description: Cor principal do texto (hex).
                    textSecondary:
                      type: string
                      description: Cor secundária do texto (hex).
                    link:
                      type: string
                      description: Cor dos links (hex).
                    success:
                      type: string
                      description: Cor de sucesso/estado positivo (hex).
                    warning:
                      type: string
                      description: Cor de aviso/alerta (hex).
                    error:
                      type: string
                      description: Cor de erro/perigo (hex).
                fonts:
                  type: array
                  nullable: true
                  description: Array de famílias de fontes usadas na página.
                  items:
                    type: object
                    properties:
                      family:
                        type: string
                        description: Nome da família de fontes.
                typography:
                  type: object
                  nullable: true
                  description: Informações detalhadas de tipografia.
                  properties:
                    fontFamilies:
                      type: object
                      description: Famílias de fontes por função.
                      properties:
                        primary:
                          type: string
                          description: Família de fontes primária.
                        heading:
                          type: string
                          description: Família de fontes para títulos (headings).
                        code:
                          type: string
                          description: Família de fontes para código/monoespaçada.
                    fontSizes:
                      type: object
                      description: Tamanhos de fonte para diferentes níveis tipográficos.
                      properties:
                        h1:
                          type: string
                        h2:
                          type: string
                        h3:
                          type: string
                        body:
                          type: string
                    fontWeights:
                      type: object
                      description: Definições de peso da fonte.
                      properties:
                        light:
                          type: integer
                        regular:
                          type: integer
                        medium:
                          type: integer
                        bold:
                          type: integer
                    lineHeights:
                      type: object
                      description: >-
                        Valores de altura de linha para diferentes tipos de
                        texto.
                      properties:
                        heading:
                          type: string
                        body:
                          type: string
                spacing:
                  type: object
                  nullable: true
                  description: Informações de espaçamento e layout.
                  properties:
                    baseUnit:
                      type: integer
                      description: Unidade base de espaçamento (em pixels).
                    borderRadius:
                      type: string
                      description: Raio de borda padrão.
                    padding:
                      type: object
                      description: Valores de padding.
                    margins:
                      type: object
                      description: Valores de margem.
                components:
                  type: object
                  nullable: true
                  description: Estilos de componentes de UI.
                  properties:
                    buttonPrimary:
                      type: object
                      description: Estilos do botão primário.
                      properties:
                        background:
                          type: string
                        textColor:
                          type: string
                        borderRadius:
                          type: string
                    buttonSecondary:
                      type: object
                      description: Estilos de botões secundários.
                      properties:
                        background:
                          type: string
                        textColor:
                          type: string
                        borderColor:
                          type: string
                        borderRadius:
                          type: string
                    input:
                      type: object
                      description: Estilos de campos de input.
                icons:
                  type: object
                  nullable: true
                  description: Estilos de ícones.
                images:
                  type: object
                  nullable: true
                  description: Imagens da marca.
                  properties:
                    logo:
                      type: string
                      description: URL da imagem do logotipo.
                    favicon:
                      type: string
                      description: URL do favicon.
                    ogImage:
                      type: string
                      description: URL da imagem Open Graph.
                animations:
                  type: object
                  nullable: true
                  description: Configurações de animação e transição.
                layout:
                  type: object
                  nullable: true
                  description: Configuração de layout (grid, alturas de cabeçalho/rodapé).
                personality:
                  type: object
                  nullable: true
                  description: >-
                    Traços de personalidade da marca (tom, energia,
                    público-alvo).
    ParseFormats:
      type: array
      items:
        oneOf:
          - type: object
            title: Markdown
            properties:
              type:
                type: string
                enum:
                  - markdown
            required:
              - type
          - type: object
            title: Summary
            properties:
              type:
                type: string
                enum:
                  - summary
            required:
              - type
          - type: object
            title: HTML
            properties:
              type:
                type: string
                enum:
                  - html
            required:
              - type
          - type: object
            title: Raw HTML
            properties:
              type:
                type: string
                enum:
                  - rawHtml
            required:
              - type
          - type: object
            title: Links
            properties:
              type:
                type: string
                enum:
                  - links
            required:
              - type
          - type: object
            title: Images
            properties:
              type:
                type: string
                enum:
                  - images
            required:
              - type
          - type: object
            title: JSON
            properties:
              type:
                type: string
                enum:
                  - json
              schema:
                type: object
                description: >-
                  O schema a ser usado para o resultado JSON. Deve estar em
                  conformidade com o [JSON Schema](https://json-schema.org/).
              prompt:
                type: string
                description: O prompt a ser usado para o resultado JSON
            required:
              - type
      description: >-
        Formatos de resultado compatíveis para uploads em `/parse`. Formatos com
        renderização no navegador e acompanhamento de alterações não são
        compatíveis.
      default:
        - markdown
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````