解析
上传本地或非公开文档,并将其转换为干净、适用于 LLM 的数据
/parse 端点可将本地或非公开文档转换为干净、适用于 LLM 的数据。通过 multipart/form-data 上传文件字节后,可返回 Markdown、JSON、HTML、链接、图片或摘要,并保留阅读顺序和表格。
- 将 PDF、DOCX、XLSX、HTML 等转换为 Markdown 或结构化 JSON
- 借助基于 Rust 的引擎,解析速度最高可提升 5 倍
- 每次请求的文件大小上限为 50 MB
- 支持 Zero Data Retention
当源文档是本地文件,或无法通过公开 URL 访问时,请使用 /parse。如果你有指向该文档的公开 URL,优先使用 /scrape——它会根据扩展名或内容类型自动检测文件类型,并以相同方式解析。
| 来源 | 端点 |
|---|---|
指向文档的公开 URL (例如 https://example.com/report.pdf) | POST /scrape |
| 本地文件或非公开字节数据 (PDF、DOCX、XLSX、HTML、...) | POST /parse |
通过 MCP 使用 Firecrawl? 对于本地文件,请使用 firecrawl_parse。配置了 FIRECRAWL_API_URL 后,本地 MCP 可以直接读取文件。远程托管的 MCP 会先返回一个短时有效的上传命令,然后再解析返回的 uploadRef。公开的文档 URL 仍应使用 /scrape。
有公开的 PDF URL? 请改用 /scrape——它会自动检测文档类型,并返回干净的 markdown。无需额外使用 PDF 库。
doc = firecrawl.scrape("https://example.com/report.pdf", formats=["markdown"])用于上传文件并获取解析后的内容。该请求采用 multipart/form-data 格式,包含一个必填的 file 部分,以及一个可选的 options JSON 部分。
支持的扩展名: .html, .htm, .pdf, .docx, .doc, .odt, .rtf, .xlsx, .xls.
from firecrawl import Firecrawl
firecrawl = Firecrawl(api_key="fc-YOUR-API-KEY")
doc = firecrawl.parse("./report.pdf")
print(doc.markdown)SDK 直接返回文档对象。cURL 返回 JSON 数据。
{
"success": true,
"data": {
"markdown": "# Annual Report\n\n...",
"metadata": {
"title": "Annual Report",
"numPages": 42,
"totalPages": 42,
"sourceFile": "report.pdf"
}
}
}numPages 是实际解析的页数;totalPages 是文档的
实际总页数。除非 maxPages 截断了结果,否则两者会一致——例如,解析
一个 100 页的 PDF 并设置 maxPages: 10 时,会返回 numPages: 10 和 totalPages: 100,因此
totalPages > numPages 表示输出已被截断。无法确定页数时,
则会省略 totalPages。
/parse 可在 options 字段下接受部分 scrape 选项。常见设置如下:
formats:输出格式数组。默认值为["markdown"]。支持:markdown、html、rawHtml、links、images、summary和json(可搭配 schema 或 prompt) 。onlyMainContent:仅返回文档的主体内容。默认值为true。includeTags/excludeTags:按标签包含或排除内容 (适用于 HTML 输入) 。redactPII:对返回的 markdown 中的个人身份识别信息进行脱敏处理。timeout:请求超时时间 (毫秒) 。默认值为30000,最大为300000。parsers:文件解析器控制选项。对于 PDF,设置为{ "type": "pdf", "mode": "fast" | "auto" | "ocr", "maxPages": <int> }。
/parse 不支持仅适用于浏览器的选项,例如 actions、waitFor、location、mobile 或变更追踪。
curl -X POST https://api.firecrawl.dev/v2/parse \
-H 'Authorization: Bearer YOUR_API_KEY' \
-F 'file=@./scan.pdf' \
-F 'options={"parsers":[{"type":"pdf","mode":"ocr","maxPages":50}]};type=application/json'fast:仅提取文本,速度最快。auto(默认值) :优先提取文本,页面仅含图像时回退到 OCR。ocr:对每一页执行 OCR——适用于扫描文档。
传入 JSON schema 或 prompt,即可直接从文档中提取结构化数据:
curl -X POST https://api.firecrawl.dev/v2/parse \
-H 'Authorization: Bearer YOUR_API_KEY' \
-F 'file=@./invoice.pdf' \
-F 'options={"formats":[{"type":"json","schema":{"type":"object","properties":{"total":{"type":"number"},"vendor":{"type":"string"}}}}]};type=application/json'- 每个请求的最大文件大小为 50 MB。
- 在
ocr模式下解析超大 PDF 或扫描版 PDF 可能需要更长时间——请增大timeout,或使用maxPages来限定处理范围。 - 对于多份文件,请对每个文件并行调用
/parse;不支持批量上传。
你是需要 Firecrawl API 密钥的 AI 代理吗?请参见 firecrawl.dev/agent-onboarding/SKILL.md 获取自动化引导说明。