Pular para o conteúdo principal
A ocultação de PII substitui informações de identificação pessoal no markdown retornado antes de você enviá-lo para agentes, logs, bancos de vetores ou pipelines de análise.

​
Como funciona

Defina redactPII: true em uma requisição de scraping. O Firecrawl oculta as informações de identificação pessoal no markdown gerado e retorna a versão com esses dados ocultados em markdown. Você não precisa passar formats; markdown é o resultado padrão. 
from firecrawl import Firecrawl

firecrawl = Firecrawl(api_key="fc-YOUR_API_KEY")

doc = firecrawl.scrape(
    "https://example.com/contact",
    redact_pii=True,
)

print(doc.markdown)

​
Opções de ocultação

Para a maioria das requisições, use redactPII: true. Para ajustar a ocultação, passe um objeto de opções: 
{
  "redactPII": {
    "mode": "accurate",
    "entities": ["EMAIL", "PHONE", "SECRET"],
    "replaceStyle": "tag"
  }
}
OpçãoValoresPadrãoDescrição
modeaccurate, aggressive, fastaccurateEstratégia de ocultação. accurate usa um fluxo baseado apenas no modelo, aggressive aumenta o recall com heurísticas adicionais, e fast pula a chamada ao modelo.
entitiesPERSON, EMAIL, PHONE, LOCATION, FINANCIAL, SECRETTodas as entidadesLimita a ocultação a categorias específicas de entidades.
replaceStyletag, mask, removetagSubstitui trechos por tags como <EMAIL>, mascara com * ou remove os caracteres por completo.
A CLI do Firecrawl e o Servidor MCP expõem uma opção booleana simples de ocultação. As opções avançadas estão disponíveis pela API e pelos SDKs, que expõem o objeto completo de opções redactPII.

​
Resposta

Quando a ocultação for bem-sucedida, markdown conterá o conteúdo ocultado: 
{
  "success": true,
  "data": {
    "markdown": "Contact us at <EMAIL> or <PHONE>.",
    "metadata": {
      "sourceURL": "https://example.com/contact"
    }
  }
}
Para visualizar na linha de comando, redirecione o markdown por pipe para o renderizador de sua preferência:
cURL
curl -X POST https://api.firecrawl.dev/v2/scrape \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "url": "https://dlptest.com/sample-data.pdf",
    "redactPII": true
  }' | jq -r ".data.markdown" | glow

​
Cobrança

A ocultação de PII custa 5 créditos por página: 1 crédito base de scraping mais 4 créditos adicionais pela ocultação. Para PDFs analisados, cada página adicional do PDF ainda consome o crédito normal de análise de PDF e também recebe a cobrança adicional pela ocultação.

​
Disponibilidade

A ocultação de PII é suportada em qualquer ponto em que o Firecrawl aceita opções de scraping:
  • Scraping - defina redactPII em /v2/scrape.
  • Rastreamento, extração em lote e busca - passe redactPII dentro de scrapeOptions.
  • Parse - passe redactPII no JSON multipart options.
  • SDKs - Python usa redact_pii; JavaScript e outros SDKs usam redactPII ou a convenção nativa de opções.
  • CLI - passe --redact-pii para firecrawl scrape.
  • Servidor MCP - inclua "redactPII": true nos argumentos da ferramenta firecrawl_scrape para uma ocultação booleana simples.
Você é um agente de IA e precisa de uma Firecrawl API key? Consulte firecrawl.dev/agent-onboarding/SKILL.md para ver as instruções de onboarding automatizado.