Firecrawl MCP Server
MCP server for Firecrawl — web search, scraping, and biomedical/arXiv paper search.
¿Debería usar esto?
Calidad y seguridad
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"firecrawl-mcp-server": {
"command": "npx",
"args": [
"firecrawl-mcp"
]
}
}
}Paquetes ejecutables
3.27.1stdioPuntos de conexión remotos
https://mcp.firecrawl.dev/v2/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (3)
🟡firecrawl_scrape(url, formats, jsonOptions, queryOptions, screenshotOptions, ...)
Scrape one URL and return its content: markdown by default, or HTML, links, screenshots, branding data, a targeted answer, or JSON matching a supplied schema. Use it when the request identifies a page and needs its content or defined fields. Use `firecrawl_search` when additional web sources are needed; on an authenticated session, `firecrawl_map` lists a site's URLs and `firecrawl_crawl` collects a set of pages. Firecrawl may serve recently indexed content; set `maxAge: 0` for a live fetch or a smaller `maxAge` to bound staleness. A successful response does not by itself confirm the page is still current. Browser actions can change the live page when interactive actions are enabled. Authenticated responses can include a `metadata.scrapeId` for optional scrape feedback. On an authenticated session with Alexandria access, `firecrawl_search` with `sources` unset and `firecrawl_find_tools` can discover providers for the same fields across several pages; a matching provider returns typed records in one call. Keyless sessions have no provider matches. Alexandria mode, on an authenticated session with Alexandria access: `alexandria` selects catalogued capability execution and is mutually exclusive with `url`.
Esquema de entrada
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"markdown",
"html",
"rawHtml",
"screenshot",
"links",
"summary",
"changeTracking",
"branding",
"json",
"query",
"audio"
]
}
},
"jsonOptions": {
"type": "object",
"properties": {
"prompt": {
"type": "string"
},
"schema": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"queryOptions": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"maxLength": 10000
},
"mode": {
"default": "freeform",
"type": "string",
"enum": [
"directQuote",
"freeform"
]
}
},
"required": [
"prompt"
],
"additionalProperties": false
},
"screenshotOptions": {
"type": "object",
"properties": {
"fullPage": {
"type": "boolean"
},
"quality": {
"type": "number"
},
"viewport": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"parsers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pdf"
]
}
},
"pdfOptions": {
"type": "object",
"properties": {
"maxPages": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
"additionalProperties": false
},
"onlyMainContent": {
"type": "boolean"
},
"redactPII": {
"type": "boolean"
},
"includeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"waitFor": {
"type": "number"
},
"mobile": {
"type": "boolean"
},
"skipTlsVerification": {
"type": "boolean"
},
"removeBase64Images": {
"type": "boolean"
},
"location": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"storeInCache": {
"type": "boolean"
},
"zeroDataRetention": {
"type": "boolean"
},
"maxAge": {
"type": "number"
},
"lockdown": {
"type": "boolean"
},
"proxy": {
"type": "string",
"enum": [
"basic",
"stealth",
"enhanced",
"auto"
]
},
"profile": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"saveChanges": {
"type": "boolean"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"timeout": {
"description": "Execution timeout in milliseconds.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"description": "Idempotency key bound to one Alexandria execution payload. Generated when omitted and returned with the result.",
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{1,128}$"
},
"alexandria": {
"description": "Catalogued Alexandria capability invocation, mutually exclusive with url. One {provider, capability, options} object or an array of 1-10, with contracts available through firecrawl_search or firecrawl_find_tools. Each call may include version to pin a published workflow; omitting it uses latest. Only requestId and timeout are supported alongside alexandria. The selected contract marks required inputs and any requiresOneOf groups (at least one member per group); it may include example.request/example.response and response.key (which may differ from records). Where pagination is declared, its fields govern paging with the same filters; catalogue next is separate from provider pagination. Returns per-capability results in data.alexandria with data, records, or an error with a code; individual capabilities can fail even when the outer response succeeds. Requires an API key on a team with Alexandria enabled. Some providers require accepted terms; blocked requests return the applicable requirements.",
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"description": "Provider slug, e.g. \"fred\".",
"type": "string",
"minLength": 1
},
"capability": {
"description": "Capability address as returned by search or discover, e.g. \"series/observations\".",
"type": "string",
"minLength": 1
},
"version": {
"description": "Optional published workflow version. Omit to use the latest version.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"options": {
"description": "Capability options as declared by its contract.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"provider",
"capability"
]
},
{
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"provider": {
"description": "Provider slug, e.g. \"fred\".",
"type": "string",
"minLength": 1
},
"capability": {
"description": "Capability address as returned by search or discover, e.g. \"series/observations\".",
"type": "string",
"minLength": 1
},
"version": {
"description": "Optional published workflow version. Omit to use the latest version.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"options": {
"description": "Capability options as declared by its contract.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"provider",
"capability"
]
}
}
]
},
"toolDetail": {
"description": "URL mode only: domain discovery detail, summary by default; compact returns provider/capability/description, full includes contracts. Ignored with alexandria.",
"type": "string",
"enum": [
"compact",
"summary",
"full"
]
},
"domainTools": {
"description": "URL mode only: include domain-matched Alexandria tools for the page in tools on the returned document. Ignored with alexandria.",
"type": "boolean"
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"agent_hints": {
"description": "Optional response guidance from the Firecrawl API.",
"type": "array",
"items": {
"type": "string"
}
},
"markdown": {
"description": "Page content as markdown.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"html": {
"description": "Processed HTML of the page.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"rawHtml": {
"description": "Unprocessed HTML of the page.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"summary": {
"description": "Summary of the page content.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"links": {
"description": "Links found on the page."
},
"screenshot": {
"description": "Screenshot of the page."
},
"images": {
"description": "Images found on the page."
},
"audio": {
"description": "Audio extracted from the page."
},
"video": {
"description": "Video extracted from the page."
},
"answer": {
"description": "Targeted answer to the question that was asked of the page.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highlights": {
"description": "Highlighted passages from the page."
},
"pages": {
"description": "Physical PDF pages, when `parsers[].pages` is set."
},
"blocks": {
"description": "Typed PDF layout blocks, when `parsers[].blocks` is set."
},
"product": {
"description": "Product data extracted from the page."
},
"menu": {
"description": "Menu data extracted from the page."
},
"json": {
"description": "Structured data matching the requested JSON schema or prompt."
},
"attributes": {
"description": "Values collected by the requested attribute selectors."
},
"actions": {
"description": "Results of the browser actions that ran during the scrape."
},
"changeTracking": {
"description": "Change-tracking comparison against the previous scrape."
},
"branding": {
"description": "Branding data extracted from the page."
},
"metadata": {
"description": "Page metadata; authenticated responses can include `metadata.scrapeId` for scrape feedback."
},
"tools": {
"description": "Domain-matched Alexandria tools for the page, when `domainTools` is set."
},
"warning": {
"description": "Non-fatal warning about the result.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"success": {
"description": "Whether the API call succeeded.",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"error": {
"description": "Error message or error object when the call did not succeed."
},
"data": {
"description": "Alexandria mode: per-capability results in `data.alexandria`, each with `data`, `records`, or an `error`."
},
"requestId": {
"description": "Identifier of this Alexandria execution.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scrape_id": {
"description": "Identifier of the underlying scrape.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"receipt": {
"description": "Billing receipt for the execution."
},
"creditsCost": {
"description": "Credits this call consumed.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"delivery": {
"description": "`retained` when the full result stayed server-side instead of being inlined.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"responseBytes": {
"description": "Size of the full result in bytes.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"estimatedTokens": {
"description": "Estimated token cost of the full result.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"tokenEstimateMethod": {
"description": "How `estimatedTokens` was derived.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"inlineTokenBudget": {
"description": "Token budget above which a result is retained rather than inlined.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"workspaceId": {
"description": "Workspace holding a retained result, for inspection through virtual Bash.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"idleTtlSeconds": {
"description": "Seconds a retained workspace stays available while idle.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"message": {
"description": "Guidance that accompanies the result.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"nextTool": {
"description": "A follow-up tool call (`{name, arguments}`) that continues or inspects this result."
},
"feedbackTool": {
"description": "Pointer to the feedback tool for reporting how this result served the task."
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A scraped document, or the Alexandria execution envelope when `alexandria` was passed.",
"additionalProperties": false
}🟢firecrawl_search(toolDetail, query, domainTools, highlights, limit, ...)
Search web, news, or image sources and return ranked results with query-relevant highlights. Each web result is a title, URL, and description; use `firecrawl_scrape` on a result URL when the excerpt is not enough. Authenticated search also returns matching Alexandria data providers in data.tools (companies, people, jobs, finance and filings, public records and government spending, real estate, places and restaurants, retail and prices, package registries and developer data, news, research, and more). Prefer a provider over scraping pages when the task needs the same fields across several entities, exact figures or timestamps, provenance, or many records; use web results when they already answer the question. A search with sources: ["web"] omits semantic provider discovery; domainTools: true can still return website-matched tools. Web-only results use domainTools: false. On an authenticated session, tool matches describe available capabilities; `firecrawl_find_tools` returns their contracts and `firecrawl_scrape` with an `alexandria` body executes a selected capability. Keyless sessions get no Alexandria matches in data.tools. For a programming question, add `categories: ["developer"]`; its hits return in `data.web` with `category: "developer"`. `categories: ["research"]` restricts web results to research-affiliated websites; the `firecrawl_research_*` tools are a separate surface over paper abstracts and full text (PubMed, bioRxiv, medRxiv, arXiv). Query operators, domain filters, `categories`, `toolDetail` and `scrapeOptions` are described on their parameters. Returns source-type result groups and usage metadata. Authenticated responses can include an `id` for optional search feedback.
Esquema de entrada
{
"type": "object",
"properties": {
"toolDetail": {
"description": "Compact by default. Compact returns only provider, capability and description; full includes contracts. Inspect selected compact tools with firecrawl_find_tools providers and capabilities.",
"type": "string",
"enum": [
"compact",
"summary",
"full"
]
},
"query": {
"description": "Query for web and semantic tool discovery. Operators include quoted phrases, `-term`, `site:host`, `inurl:term`, `intitle:term`, and `related:host`; the set is non-exhaustive. Catalogue browsing is available through firecrawl_find_tools.",
"type": "string",
"minLength": 1
},
"domainTools": {
"description": "Include domain-matched tools for result URLs. Defaults to true when Alexandria is combined with web, news or images; semantic-only search leaves domain matching off.",
"type": "boolean"
},
"highlights": {
"description": "Return query-relevant page excerpts for web and news results when available (default). Highlights appear in web `description` and news `snippet`; otherwise, original snippets are returned. Set to false to keep the original search snippets.",
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"tbs": {
"type": "string"
},
"filter": {
"type": "string"
},
"location": {
"type": "string"
},
"includeDomains": {
"description": "Hostnames to restrict results to. Mutually exclusive with excludeDomains.",
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
}
},
"excludeDomains": {
"description": "Hostnames to leave out of results. Mutually exclusive with includeDomains.",
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$"
}
},
"sources": {
"description": "Search sources; authenticated sessions default to web + alexandria, keyless sessions to web only. A search with sources: [\"web\"] omits semantic provider discovery; domainTools: true can still return website-matched tools. Web-only results use domainTools: false. Use [\"alexandria\"] alone for provider discovery without web results.",
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"web",
"images",
"news",
"alexandria",
"exchange"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"web",
"images",
"news",
"alexandria",
"exchange"
]
}
},
"required": [
"type"
],
"additionalProperties": false
}
]
}
},
"categories": {
"description": "Limit results to specific source types. `research` restricts ordinary web results to research-affiliated websites and returns page snippets, which is separate from the `firecrawl_research_*` tools that search paper abstracts and full text across biomedical (PubMed, bioRxiv, medRxiv) and arXiv literature; `pdf` searches PDF results; `developer` searches an index built for coding agents over public repositories, GitHub issues, merged pull requests, repository READMEs, and code documentation. `developer` returns hits in `data.web` with `category: \"developer\"`; the other categories also filter `data.web`.",
"type": "array",
"items": {
"type": "string",
"enum": [
"research",
"pdf",
"developer"
]
}
},
"enterprise": {
"type": "array",
"items": {
"type": "string",
"enum": [
"default",
"anon",
"zdr"
]
}
},
"scrapeOptions": {
"description": "Attach page content for web results in the same call. These fetches ignore maxAge, so use firecrawl_scrape when you need a live fetch. scrapeOptions fetches web pages, never Alexandria provider tools.",
"type": "object",
"properties": {
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"markdown",
"html",
"rawHtml",
"screenshot",
"links",
"summary",
"changeTracking",
"branding",
"json",
"query",
"audio"
]
}
},
"jsonOptions": {
"type": "object",
"properties": {
"prompt": {
"type": "string"
},
"schema": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"queryOptions": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"maxLength": 10000
},
"mode": {
"default": "freeform",
"type": "string",
"enum": [
"directQuote",
"freeform"
]
}
},
"required": [
"prompt"
],
"additionalProperties": false
},
"screenshotOptions": {
"type": "object",
"properties": {
"fullPage": {
"type": "boolean"
},
"quality": {
"type": "number"
},
"viewport": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"width",
"height"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"parsers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pdf"
]
}
},
"pdfOptions": {
"type": "object",
"properties": {
"maxPages": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
"additionalProperties": false
},
"onlyMainContent": {
"type": "boolean"
},
"redactPII": {
"type": "boolean"
},
"includeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"waitFor": {
"type": "number"
},
"mobile": {
"type": "boolean"
},
"skipTlsVerification": {
"type": "boolean"
},
"removeBase64Images": {
"type": "boolean"
},
"location": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"storeInCache": {
"type": "boolean"
},
"zeroDataRetention": {
"type": "boolean"
},
"maxAge": {
"type": "number"
},
"lockdown": {
"type": "boolean"
},
"proxy": {
"type": "string",
"enum": [
"basic",
"stealth",
"enhanced",
"auto"
]
},
"profile": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"saveChanges": {
"type": "boolean"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"query"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"agent_hints": {
"description": "Optional response guidance from the Firecrawl API.",
"type": "array",
"items": {
"type": "string"
}
},
"success": {
"description": "Whether the API call succeeded.",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"data": {
"description": "Ranked results grouped by source, such as `web`, `news`, `images`, and `alexandria`."
},
"error": {
"description": "Error message or error object when the call did not succeed."
},
"warning": {
"description": "Non-fatal warning about the result.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"description": "Search identifier, for optional `firecrawl_search_feedback`.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"creditsUsed": {
"description": "Credits this search consumed.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"tools": {
"description": "Domain-matched Alexandria tools for the results."
},
"nextTool": {
"description": "A follow-up tool call that continues this search."
},
"feedbackTool": {
"description": "Pointer to the feedback tool for this search."
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Ranked search results grouped by source.",
"additionalProperties": false
}🟢firecrawl_parse(formats, jsonOptions, queryOptions, parsers, pdfOptions, ...)
Parse one supported document into markdown, HTML, links, summary, targeted answers, or JSON matching a schema. Supported inputs include common HTML, PDF, Word, RTF, OpenDocument, and spreadsheet files; PDF parsing can be bounded with `pdfOptions.maxPages`. Local MCP reads `filePath` from the server filesystem. Hosted MCP uses two calls: first provide `filePath` to receive upload instructions, upload locally, then call again with the returned `uploadRef`; do not send both fields together. Remote web URLs belong in `firecrawl_scrape`. Set `redactPII` to request redaction of personally identifiable information in the returned content. `zeroDataRetention` requires an eligible authenticated account; omit it for anonymous keyless use. Returns upload instructions for hosted phase one or parsed document content for the final call. Authenticated final responses can include a `data.metadata.scrapeId` for optional parse feedback.
Esquema de entrada
{
"type": "object",
"properties": {
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"markdown",
"html",
"rawHtml",
"links",
"summary",
"json",
"query"
]
}
},
"jsonOptions": {
"type": "object",
"properties": {
"prompt": {
"type": "string"
},
"schema": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"queryOptions": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"maxLength": 10000
},
"mode": {
"default": "freeform",
"type": "string",
"enum": [
"directQuote",
"freeform"
]
}
},
"required": [
"prompt"
],
"additionalProperties": false
},
"parsers": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pdf"
]
}
},
"pdfOptions": {
"type": "object",
"properties": {
"maxPages": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
},
"additionalProperties": false
},
"onlyMainContent": {
"type": "boolean"
},
"redactPII": {
"type": "boolean"
},
"includeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeTags": {
"type": "array",
"items": {
"type": "string"
}
},
"removeBase64Images": {
"type": "boolean"
},
"skipTlsVerification": {
"type": "boolean"
},
"storeInCache": {
"type": "boolean"
},
"zeroDataRetention": {
"type": "boolean"
},
"maxAge": {
"description": "Ignored: parse never reuses or stores indexed content.",
"type": "number"
},
"proxy": {
"type": "string",
"enum": [
"basic",
"auto"
]
},
"filePath": {
"description": "Phase 1 only: path to the local file on the caller/harness machine. Hosted MCP will not read or stat this path; it is used only to produce upload instructions.",
"type": "string",
"minLength": 1
},
"uploadRef": {
"description": "Phase 2 only: short-lived upload reference returned by phase 1 after the local PUT upload completes.",
"type": "string",
"minLength": 1
},
"contentType": {
"description": "Phase 1 MIME type override. If omitted, the server infers it from the file extension without reading the file.",
"type": "string"
},
"declaredSizeBytes": {
"description": "Optional phase 1 size declaration. Hosted MCP does not stat the file; provide this only if the caller already knows it.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"agent_hints": {
"description": "Optional response guidance from the Firecrawl API.",
"type": "array",
"items": {
"type": "string"
}
},
"success": {
"description": "Whether the API call succeeded.",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"error": {
"description": "Error message or error object when the call did not succeed."
},
"warning": {
"description": "Non-fatal warning about the result.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mode": {
"description": "Which phase of the hosted flow produced this response.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"message": {
"description": "Guidance for the next call.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"data": {
"description": "Parsed document content; can include `data.metadata.scrapeId` for parse feedback."
},
"upload": {
"description": "Hosted phase one: how to upload the local file.",
"type": "object",
"properties": {
"command": {
"description": "Local command that performs the upload. It carries no Firecrawl API key.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"method": {
"description": "HTTP method for the upload.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"headers": {
"description": "Headers the upload request must send."
},
"fields": {
"description": "Form fields the upload request must send, for a POST upload."
},
"uploadUrl": {
"description": "URL to upload the local file to.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"uploadRef": {
"description": "Reference to pass back on the second call.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"expiresAt": {
"description": "When the upload URL expires.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"maxSizeBytes": {
"description": "Largest file the upload URL accepts.",
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"nextToolCall": {
"description": "Hosted phase one: the second `firecrawl_parse` call to make once the upload succeeds, as `{name, arguments}`."
},
"notes": {
"description": "Hosted phase one: constraints on completing the upload flow.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"raw": {
"description": "Response body when it was not JSON.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Parsed document content, or the upload instructions for the hosted two-call flow.",
"additionalProperties": false
}Comunidad
Evidencia