Skip to content

docs: /parse API (ENG-4608) #616

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
mogery wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: /parse API (ENG-4608) #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9738c80
docs: /parse API
mogery Mar 13, 2026
80d33b5
fix parse openapi
mogery Mar 13, 2026
c859b08
fixes
mogery Mar 13, 2026
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
4 changes: 4 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,4 @@
---
title: 'Parse'
openapi: '/api-reference/v2-openapi.json POST /parse'
---
3 changes: 3 additions & 0 deletions api-reference/v2-introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The Firecrawl API gives you programmatic access to web data. All endpoints share
<Card title="Scrape" icon="markdown" href="/api-reference/endpoint/scrape" color="FF713C">
Extract content from any webpage in markdown or json format.
</Card>
<Card title="Parse" icon="markdown" href="/api-reference/endpoint/parse" color="FF713C">
Upload files and parse them into markdown or other formats.
</Card>
<Card title="Crawl" icon="spider" href="/api-reference/endpoint/crawl-post" color="FF713C">
Crawl entire websites, extract their content and metadata.
</Card>
Expand Down
329 changes: 329 additions & 0 deletions api-reference/v2-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,136 @@
}
}
},
"/parse": {
"post": {
"summary": "Upload and parse a file",
"operationId": "parseFile",
"tags": ["Scraping"],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The file bytes to parse. Supported extensions: .html, .htm, .pdf, .docx, .doc, .odt, .rtf, .xlsx, .xls."
},
"options": {
"$ref": "#/components/schemas/ParseOptions"
}
},
"required": ["file"]
},
"encoding": {
"options": {
"contentType": "application/json"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScrapeResponse"
}
}
}
},
"400": {
"description": "Bad request",
"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": "Payment required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Payment required to access this resource."
}
}
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Request rate limit exceeded. Please wait and try again later."
}
}
}
}
}
},
"500": {
"description": "Server error",
"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."
}
}
}
}
}
}
}
}
},
"/batch/scrape": {
"post": {
"summary": "Scrape multiple URLs and optionally extract information using an LLM",
Expand Down Expand Up @@ -3183,6 +3313,205 @@
"description": "Output formats to include in the response. You can specify one or more formats, either as strings (e.g., `'markdown'`) or as objects with additional options (e.g., `{ type: 'json', schema: {...} }`). Some formats require specific options to be set. Example: `['markdown', { type: 'json', schema: {...} }]`.",
"default": ["markdown"]
},
"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": "The schema to use for the JSON output. Must conform to [JSON Schema](https://json-schema.org/)."
},
"prompt": {
"type": "string",
"description": "The prompt to use for the JSON output"
}
},
"required": ["type"]
}
]
},
"description": "Output formats supported for `/parse` uploads. Browser-rendering formats and change tracking are not supported.",
"default": ["markdown"]
},
"ParseOptions": {
"type": "object",
"description": "Optional parse options sent as JSON in the multipart `options` field.",
"properties": {
"formats": {
"$ref": "#/components/schemas/ParseFormats"
},
"onlyMainContent": {
"type": "boolean",
"description": "Only return the main content of the page excluding headers, navs, footers, etc.",
"default": true
},
"includeTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to include in the output."
},
"excludeTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to exclude from the output."
},
"headers": {
"type": "object",
"description": "Headers to send when additional network requests are required."
},
"timeout": {
"type": "integer",
"description": "Timeout in milliseconds for the request. Default is 30000 (30 seconds). Maximum is 300000 (300 seconds).",
"default": 30000,
"maximum": 300000
},
"parsers": {
"type": "array",
"description": "Controls file parser behavior when relevant (for example PDF parser mode).",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["pdf"]
},
"mode": {
"type": "string",
"enum": ["fast", "auto", "ocr"],
"default": "auto",
"description": "PDF parsing mode. \"fast\": text-only extraction. \"auto\": text-first with OCR fallback. \"ocr\": OCR on every page."
},
"maxPages": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "Maximum number of pages to parse from the PDF."
}
},
"required": ["type"],
"additionalProperties": false
}
]
},
"default": ["pdf"]
},
"skipTlsVerification": {
"type": "boolean",
"description": "Skip TLS certificate verification when making requests.",
"default": true
},
"removeBase64Images": {
"type": "boolean",
"description": "Remove base64-encoded images from output and keep alt text placeholders.",
"default": true
},
"blockAds": {
"type": "boolean",
"description": "Enable ad and cookie popup blocking.",
"default": true
},
"proxy": {
"type": "string",
"enum": ["basic", "auto"],
"description": "Proxy mode for parse uploads. `/parse` supports only `basic` and `auto`."
},
"origin": {
"type": "string",
"description": "Origin identifier for analytics and logging.",
"default": "api"
},
"integration": {
"type": "string",
"nullable": true,
"description": "Optional integration identifier."
},
"zeroDataRetention": {
"type": "boolean",
"default": false,
"description": "If true, this will enable zero data retention for this parse. To enable this feature, please contact help@firecrawl.dev"
}
}
},
"ScrapeOptions": {
"type": "object",
"properties": {
Expand Down
6 changes: 6 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,12 @@
"api-reference/endpoint/map"
]
},
{
"group": "Parse Endpoints",
"pages": [
"api-reference/endpoint/parse"
]
},
{
"group": "Crawl Endpoints",
"pages": [
Expand Down
Loading