> ## 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. # Extrair ## OpenAPI ````yaml pt-BR/api-reference/v2-openapi.json post /extract 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: /extract: post: tags: - Extraction summary: Extraia dados estruturados de páginas da web usando LLMs operationId: extractData requestBody: required: true content: application/json: schema: type: object properties: urls: type: array items: type: string format: uri description: >- As URLs das quais os dados serão extraídos. As URLs devem estar no formato glob. prompt: type: string description: Prompt para guiar o processo de extração schema: type: object description: >- Esquema que define a estrutura dos dados extraídos. Deve estar em conformidade com o [JSON Schema](https://json-schema.org/). enableWebSearch: type: boolean description: >- Quando definido como true, a extração usará busca na web para encontrar dados adicionais default: false ignoreSitemap: type: boolean description: >- Quando definido como `true`, arquivos sitemap.xml serão ignorados durante a varredura do site default: false includeSubdomains: type: boolean description: >- Quando definido como true, os subdomínios das URLs fornecidas também serão rastreados default: true showSources: type: boolean description: >- Quando definido como true, as fontes usadas para extrair os dados serão incluídas na resposta sob a chave `sources` default: false scrapeOptions: $ref: '#/components/schemas/ScrapeOptions' ignoreInvalidURLs: type: boolean default: true description: >- Se URLs inválidas forem especificadas no array urls, elas serão ignoradas. Em vez de fazer com que a requisição inteira falhe, será feita uma extração usando as URLs válidas restantes, e as URLs inválidas serão retornadas no campo invalidURLs da resposta. required: - urls responses: '200': description: Extração bem-sucedida content: application/json: schema: $ref: '#/components/schemas/ExtractResponse' '400': description: Solicitação inválida content: application/json: schema: type: object properties: error: type: string example: Invalid input data. '500': description: Erro no servidor content: application/json: schema: type: object properties: error: type: string example: An unexpected error occurred on the server. security: - bearerAuth: [] components: schemas: ScrapeOptions: type: object properties: formats: $ref: '#/components/schemas/Formats' onlyMainContent: type: boolean description: >- Retorne somente o conteúdo principal da página, excluindo cabeçalhos, elementos de 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 da saída. maxAge: type: integer description: >- Retorna uma versão em cache da página se ela for mais recente do que essa idade em milissegundos. Se a versão em cache da página for mais antiga do que esse valor, a página será novamente coletada. Se você não precisa de dados extremamente atualizados, ativar isso pode acelerar suas coletas em até 500%. O padrão é 2 dias. default: 172800000 headers: type: object description: >- Cabeçalhos a serem enviados na requisição. Podem ser usados para enviar cookies, user-agent etc. waitFor: type: integer description: >- Defina um atraso, em milissegundos, antes de buscar o conteúdo, permitindo que a página tenha tempo suficiente para carregar. Esse tempo de espera é somado ao recurso de espera inteligente do Firecrawl. default: 0 mobile: type: boolean description: >- Defina como true se quiser emular a extração a partir de um dispositivo móvel. Útil para testar páginas responsivas e capturar screenshots da versão mobile. default: false skipTlsVerification: type: boolean description: Ignorar a verificação de certificado TLS ao realizar requisições. default: true timeout: type: integer description: >- Tempo limite da requisição, em milissegundos. O valor padrão é 30000 (30 segundos). O valor máximo é 300000 (300 segundos). default: 30000 maximum: 300000 parsers: type: array description: >- Controla como os arquivos são processados durante o scraping. Quando "pdf" é incluído (padrão), o conteúdo do PDF é extraído e convertido em markdown, com cobrança baseada no número de páginas (1 crédito por página). Quando um array vazio é fornecido, o arquivo PDF é retornado em codificação base64 com uma taxa fixa de 1 crédito para todo o PDF. items: oneOf: - type: object properties: type: type: string enum: - pdf mode: type: string enum: - fast - auto - ocr default: auto description: >- Modo de processamento de PDFs. "fast": extração apenas baseada em texto (usa o texto embutido, mais rápido). "auto" (padrão): tenta primeiro a extração rápida e, se necessário, recorre ao OCR. "ocr": força o processamento via OCR em todas as páginas. maxPages: type: integer minimum: 1 maximum: 10000 description: >- Número máximo de páginas do PDF a serem processadas. Deve ser um inteiro positivo de até 10.000. required: - type additionalProperties: false default: - pdf actions: type: array description: Ações a serem executadas na página antes de extrair o conteúdo items: oneOf: - title: Wait oneOf: - type: object title: Wait by Duration properties: type: type: string enum: - wait description: Esperar um número específico de milissegundos milliseconds: type: integer minimum: 1 description: Número de milissegundos a esperar required: - type - milliseconds additionalProperties: false - type: object title: Wait for Element properties: type: type: string enum: - wait description: Esperar até que um elemento específico apareça selector: type: string description: Seletor CSS do elemento a esperar example: '#my-element' required: - type - selector additionalProperties: false - type: object title: Screenshot properties: type: type: string enum: - screenshot description: >- Faça uma captura de tela. Os links estarão no array `actions.screenshots` da resposta. fullPage: type: boolean description: >- Define se a captura de tela deve abranger a página inteira (ignorando viewport.height) ou se deve ser limitada à viewport atual. default: false quality: type: integer description: >- A qualidade da captura de tela, de 1 a 100, onde 100 é a mais alta qualidade. viewport: type: object properties: width: type: integer description: Largura da viewport em pixels height: type: integer description: A altura da viewport, em pixels required: - width - height required: - type - type: object title: Click properties: type: type: string enum: - click description: Clique em um elemento selector: type: string description: Seletor para encontrar o elemento por example: '#load-more-button' all: type: boolean description: >- Clica em todos os elementos que correspondem ao seletor, não apenas no primeiro. Não lança um erro se nenhum elemento corresponder ao seletor. default: false required: - type - selector - type: object title: Write text properties: type: type: string enum: - write description: >- Digite o texto em um campo de entrada, área de texto ou elemento com conteúdo editável. Observação: primeiro é preciso colocar o foco no elemento usando uma ação de “clique” antes de escrever. O texto será digitado caractere por caractere para simular a entrada pelo teclado. text: type: string description: Texto a ser digitado example: Hello, world! required: - type - text - type: object title: Press a key description: >- Pressione qualquer tecla na página. Consulte https://asawicki.info/nosense/doc/devices/keyboard/key_codes.html para ver os códigos de tecla. properties: type: type: string enum: - press description: Pressione qualquer tecla na página key: type: string description: Tecla para pressionar example: Enter required: - type - key - type: object title: Scroll properties: type: type: string enum: - scroll description: Rolar a página ou um elemento específico direction: type: string enum: - up - down description: Sentido da rolagem default: down selector: type: string description: Seletor (query selector) do elemento a ser rolado example: '#my-element' required: - type - type: object title: Scrape properties: type: type: string enum: - scrape description: Raspa o conteúdo da página atual e retorna a URL e o HTML. required: - type - type: object title: Execute JavaScript properties: type: type: string enum: - executeJavascript description: Executar código JavaScript na página script: type: string description: Código JavaScript para executar example: document.querySelector('.button').click(); required: - type - script - type: object title: Generate PDF properties: type: type: string enum: - pdf description: >- Gerar um PDF da página atual. O PDF será retornado no array `actions.pdfs` da resposta. format: type: string enum: - A0 - A1 - A2 - A3 - A4 - A5 - A6 - Letter - Legal - Tabloid - Ledger description: O tamanho da página do PDF gerado default: Letter landscape: type: boolean description: Se o PDF deve ser gerado em orientação horizontal default: false scale: type: number description: O fator de escala do PDF gerado default: 1 required: - type location: type: object description: >- Configurações de localização da requisição. Quando definidas, será usado um proxy apropriado, se disponível, e serão emuladas as configurações correspondentes de idioma e fuso horário. O padrão é "US" se não for especificado. properties: country: type: string description: >- Código de país ISO 3166-1 alpha-2 (por exemplo, "US", "AU", "DE", "JP") pattern: ^[A-Z]{2}$ default: US languages: type: array description: >- Idiomas e localidades preferidos para a requisição, em ordem de prioridade. Por padrão, usa o idioma da localização especificada. Consulte https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language items: type: string example: en-US removeBase64Images: type: boolean description: >- Remove todas as imagens em base64 da saída, que podem ser extremamente longas. O texto alternativo da imagem é mantido na saída, mas a URL é substituída por um valor de placeholder. default: true blockAds: type: boolean description: Habilita o bloqueio de anúncios e de pop-ups de cookies. default: true proxy: type: string enum: - basic - enhanced - auto description: |- Especifica o tipo de proxy a ser utilizado. - **basic**: Proxies para scraping de sites sem soluções anti‑bot ou apenas com soluções anti‑bot básicas. Rápido e geralmente funciona. - **enhanced**: Proxies avançados para scraping de sites com soluções anti‑bot avançadas. Mais lento, porém mais confiável em alguns sites. Pode custar até 5 créditos por requisição. - **auto**: O Firecrawl tentará automaticamente refazer o scraping com proxies enhanced se o proxy basic falhar. Se a nova tentativa com enhanced for bem-sucedida, 5 créditos serão cobrados pelo scraping. Se a primeira tentativa com basic for bem-sucedida, apenas o custo regular será cobrado. default: auto storeInCache: type: boolean description: >- Se definido como true, a página será armazenada no índice e no cache do Firecrawl. Definir isso como false é útil se sua atividade de scraping puder levantar preocupações relacionadas à proteção de dados. O uso de alguns parâmetros associados a scraping sensível (por exemplo, ações, headers) fará com que esse parâmetro seja definido automaticamente como false. default: true ExtractResponse: type: object properties: success: type: boolean id: type: string invalidURLs: type: array nullable: true items: type: string description: >- Se ignoreInvalidURLs for true, este será um array contendo as URLs inválidas especificadas na requisição. Se não houver URLs inválidas, será um array vazio. Se ignoreInvalidURLs for false, este campo será undefined. Formats: 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: Screenshot properties: type: type: string enum: - screenshot fullPage: type: boolean description: >- Define se a captura de tela deve abranger a página inteira (ignorando viewport.height) ou se deve ser limitada à viewport atual. default: false quality: type: integer description: >- Qualidade da captura de tela, de 1 a 100. 100 é a qualidade máxima. viewport: type: object properties: width: type: integer description: Largura da viewport em pixels height: type: integer description: Altura da viewport em pixels required: - width - height required: - type - type: object title: JSON properties: type: type: string enum: - json schema: type: object description: >- O esquema a ser usado para a saída em JSON. Deve estar em conformidade com o [JSON Schema](https://json-schema.org/). prompt: type: string description: O prompt a ser usado para gerar a saída em JSON required: - type - type: object title: Change Tracking properties: type: type: string enum: - changeTracking modes: type: array items: type: string enum: - git-diff - json description: >- O modo a ser usado para rastrear alterações. 'git-diff' fornece um diff detalhado e 'json' compara os dados JSON extraídos. schema: type: object description: >- Esquema para extração de JSON ao usar o modo `json`. Define a estrutura dos dados a serem extraídos e comparados. Deve estar em conformidade com o [JSON Schema](https://json-schema.org/). prompt: type: string description: >- Prompt a ser usado para rastreamento de alterações ao usar o modo "json". Caso não seja fornecido, será usado o prompt padrão. tag: type: string nullable: true default: null description: >- Tag a ser usada para rastreamento de alterações. Tags podem separar o histórico de rastreamento de alterações em “branches” (ramificações) distintas, em que o rastreamento com uma tag específica só vai comparar com coletas feitas na mesma tag. Se não for fornecida, será usada a tag padrão (null). required: - type - type: object title: Branding properties: type: type: string enum: - branding required: - type description: >- Formatos de saída que devem ser incluídos na resposta. Você pode especificar um ou mais formatos, como strings (por exemplo, `'markdown'`) ou como objetos com opções adicionais (por exemplo, `{ type: 'json', schema: {...} }`). Alguns formatos exigem que opções específicas sejam configuradas. Exemplo: `['markdown', { type: 'json', schema: {...} }]`. default: - markdown securitySchemes: bearerAuth: type: http scheme: bearer ````