AI/firecrawl
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/mendableai/firecrawl synced 2025-08-05 13:00:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update openapi.json

Browse Source
This commit is contained in:
rafaelsideguide 2024-07-17 15:07:06 -03:00
parent f020048a46
commit 205cd63c2f
1 changed files with 54 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
apps/api/openapi.json
View File

@ -41,14 +41,37 @@
"pageOptions": { "pageOptions": {
"type": "object", "type": "object",
"properties": { "properties": {
"headers": {
"type": "object",
"description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
},
"includeHtml": {
"type": "boolean",
"description": "Include the raw HTML content of the page. Will output a html key in the response.",
"default": false
},
"onlyIncludeTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
},
"onlyMainContent": { "onlyMainContent": {
"type": "boolean", "type": "boolean",
"description": "Only return the main content of the page excluding headers, navs, footers, etc.", "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
"default": false "default": false
}, },
"includeHtml": { "removeTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
},
"replaceAllPathsWithAbsolutePaths": {
"type": "boolean", "type": "boolean",
"description": "Include the raw HTML content of the page. Will output a html key in the response.", "description": "Replace all relative paths with absolute paths for images and links",
"default": false "default": false
}, },
"screenshot": { "screenshot": {
@ -60,29 +83,6 @@
"type": "integer", "type": "integer",
"description": "Wait x amount of milliseconds for the page to load to fetch content", "description": "Wait x amount of milliseconds for the page to load to fetch content",
"default": 0 "default": 0
},
"removeTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'"
},
"onlyIncludeTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
},
"headers": {
"type": "object",
"description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
},
"replaceAllPathsWithAbsolutePaths": {
"type": "boolean",
"description": "Replace all relative paths with absolute paths for images and links",
"default": false
} }
} }
}, },
@ -216,7 +216,12 @@
}, },
"allowBackwardCrawling": { "allowBackwardCrawling": {
"type": "boolean", "type": "boolean",
"description": "Allow backward crawling (crawl from the base URL to the previous URLs)", "description": "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'",
"default": false
},
"allowExternalContentLinks": {
"type": "boolean",
"description": "Allows the crawler to follow links to external websites.",
"default": false "default": false
} }
} }
@ -224,24 +229,26 @@
"pageOptions": { "pageOptions": {
"type": "object", "type": "object",
"properties": { "properties": {
"onlyMainContent": { "headers": {
"type": "boolean", "type": "object",
"description": "Only return the main content of the page excluding headers, navs, footers, etc.", "description": "Headers to send with the request. Can be used to send cookies, user-agent, etc."
"default": false
}, },
"includeHtml": { "includeHtml": {
"type": "boolean", "type": "boolean",
"description": "Include the raw HTML content of the page. Will output a html key in the response.", "description": "Include the raw HTML content of the page. Will output a html key in the response.",
"default": false "default": false
}, },
"screenshot": { "onlyIncludeTags": {
"type": "boolean", "type": "array",
"description": "Include a screenshot of the top of the page that you are scraping.", "items": {
"default": false "type": "string"
},
"description": "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'"
}, },
"headers": { "onlyMainContent": {
"type": "object", "type": "boolean",
"description": "Headers to send with the request when scraping. Can be used to send cookies, user-agent, etc." "description": "Only return the main content of the page excluding headers, navs, footers, etc.",
"default": false
}, },
"removeTags": { "removeTags": {
"type": "array", "type": "array",
@ -254,6 +261,16 @@
"type": "boolean", "type": "boolean",
"description": "Replace all relative paths with absolute paths for images and links", "description": "Replace all relative paths with absolute paths for images and links",
"default": false "default": false
},
"screenshot": {
"type": "boolean",
"description": "Include a screenshot of the top of the page that you are scraping.",
"default": false
},
"waitFor": {
"type": "integer",
"description": "Wait x amount of milliseconds for the page to load to fetch content",
"default": 0
} }
} }
} }