Scrape a single page and return its main content as markdown.
Firecrawl
Search, scrape, map, file parsing and asynchronous crawling.
Scrape a single page and return its main content as markdown.
Fetch one URL and get its main content back as markdown. url and proxy are both required — proxy must be basic on the metered profile — and formats selects the output. Returns success and data with markdown plus a large metadata object carrying the page's og: and twitter: tags, statusCode, sourceURL and language. ⚠️ The URL must be HTTPS and must not point at a PDF; both are rejected rather than best-effort. Use it when you have the URL and want the text. For several URLs at once post_firecrawl_batch_scrape runs them as one background job, and extractWebContent does a small batch synchronously. To find URLs first, post_firecrawl_map.
- 枚举proxy常量:basic必填
Proxy tier. Must be explicitly set to "basic" on the metered profile.
值- basic
- 类型: string 格式: uriurl必填
The HTTPS URL to scrape. PDF URLs are not supported on the metered profile.
- 类型: array string[] 枚举formats常量:markdown
Optional output formats. When present it must be exactly ["markdown"].
值- markdown
- 类型: object200
Scrape completed successfully.
- 类型: integercredits
Used Firecrawl credits consumed by the request (1 per page).
- 类型: objectdata
- markdown类型: string
The scraped page content in markdown.
- metadata类型: object
Page metadata such as title, description, source URL, and HTTP status.
- description类型: string
- source类型: string
U R L - status类型: integer
Code Integer numbers.
- title类型: string
- 类型: booleansuccess
True when the scrape succeeded.
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/firecrawl/scrape \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"url": "https://docs.firecrawl.dev",
"proxy": "basic",
"formats": [
"markdown"
]
}'
{
"success": true,
"data": {
"markdown": "string",
"metadata": {
"title": "string",
"description": "string",
"sourceURL": "string",
"statusCode": 1
}
},
"creditsUsed": 1
}