Skip to content

docs(parse): add v2 parse endpoint #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
firecrawl-spring wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(parse): add v2 parse endpoint #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions api-reference/endpoint/parse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: 'Parse'
openapi: '/api-reference/v2-openapi.json POST /parse'
---

import ParseCurl from '/snippets/v2/parse/base/curl.mdx'

Use `/v2/parse` to upload a local file and run it through the scrape pipeline (PDF/document parsing, markdown conversion, metadata extraction, and transformers).

## Multipart Fields

- `file` (required): The file to parse.
- `options` (optional): JSON string of parse options.
- `origin`, `integration`, `zeroDataRetention` (optional): Same semantics as `/v2/scrape`.

## Allowed Options

- `formats`: `markdown`, `html`, `rawHtml`, `links`, `images`, `summary`, `json`, `attributes`
- `onlyMainContent`, `includeTags`, `excludeTags`, `parsers` (pdf only), `removeBase64Images`, `timeout`

## Supported File Types

- PDF (`application/pdf` or `%PDF` signature)
- Office documents: `.docx`, `.odt`, `.rtf`, `.xlsx`, `.xls`
- HTML: `.html`, `.htm`, `text/html`, `application/xhtml+xml`
- Markdown: `.md`, `text/markdown`
- Plain text: `text/plain`

## Example

<ParseCurl />
Loading