github/v-firecrawl
github/v-firecrawl
0
Fork 0
Code Actions

Update openapi.json

Browse Source
This commit is contained in:
Nicolas 2024-04-22 08:41:54 -07:00
parent 3ead2efdca
commit de7e1f501b
1 changed files with 290 additions and 276 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
apps/api/openapi.json
View File

@ -3,11 +3,11 @@
"info": {
"title": "Firecrawl API",
"version": "1.0.0",
"description": "API for interacting with Firecrawl services to convert websites to LLM-ready data.",
"description": "API for interacting with Firecrawl services to perform web scraping and crawling tasks.",
"contact": {
"name": "Firecrawl Support",
"url": "https://firecrawl.dev/support",
"email": "help@mendable.ai"
"email": "support@firecrawl.dev"
}
},
"servers": [
@ -37,6 +37,16 @@
"type": "string",
"format": "uri",
"description": "The URL to scrape"
},
"pageOptions": {
"type": "object",
"properties": {
"onlyMainContent": {
"type": "boolean",
"description": "Only return the main content of the page excluding headers, navs, footers, etc.",
"default": false
}
}
}
},
"required": ["url"]
@ -111,6 +121,11 @@
"description": "Generate alt text for images using LLMs (must have a paid plan)",
"default": false
},
"returnOnlyUrls": {
"type": "boolean",
"description": "If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.",
"default": false
},
"limit": {
"type": "integer",
"description": "Maximum number of pages to crawl"
@ -291,5 +306,4 @@
"bearerAuth": []
}
]
}
}