Austin/firecrawl
1
0
Fork 0
mirror of https://github.com/mendableai/firecrawl.git synced 2024-11-16 03:32:22 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update openapi.json

Browse Source
This commit is contained in:
rafaelsideguide 2024-07-18 10:34:03 -03:00
parent eda616d728
commit f13ef02a08
1 changed files with 216 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

236
apps/api/openapi.json
View File

@ -93,21 +93,22 @@
}, },
"extractorOptions": { "extractorOptions": {
"type": "object", "type": "object",
"description": "Options for LLM-based extraction of structured information from the page content", "description": "Options for extraction of structured information from the page content. Note: LLM-based extraction is not performed by default and only occurs when explicitly configured. The 'markdown' mode simply returns the scraped markdown and is the default mode for scraping.",
"default": {},
"properties": { "properties": {
"mode": { "mode": {
"type": "string", "type": "string",
"enum": ["llm-extraction", "llm-extraction-from-raw-html"], "enum": ["markdown", "llm-extraction", "llm-extraction-from-raw-html", "llm-extraction-from-markdown"],
"description": "The extraction mode to use. llm-extraction: Extracts information from the cleaned and parsed content. llm-extraction-from-raw-html: Extracts information directly from the raw HTML." "description": "The extraction mode to use. 'markdown': Returns the scraped markdown content, does not perform LLM extraction. 'llm-extraction': Extracts information from the cleaned and parsed content using LLM. 'llm-extraction-from-raw-html': Extracts information directly from the raw HTML using LLM. 'llm-extraction-from-markdown': Extracts information from the markdown content using LLM."
}, },
"extractionPrompt": { "extractionPrompt": {
"type": "string", "type": "string",
"description": "A prompt describing what information to extract from the page" "description": "A prompt describing what information to extract from the page, applicable for LLM extraction modes."
}, },
"extractionSchema": { "extractionSchema": {
"type": "object", "type": "object",
"additionalProperties": true, "additionalProperties": true,
"description": "The schema for the data to be extracted", "description": "The schema for the data to be extracted, required only for LLM extraction modes.",
"required": [ "required": [
"company_mission", "company_mission",
"supports_sso", "supports_sso",
@ -139,13 +140,52 @@
} }
}, },
"402": { "402": {
"description": "Payment required" "description": "Payment required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Payment required to access this resource."
}
}
}
}
}
}, },
"429": { "429": {
"description": "Too many requests" "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": { "500": {
"description": "Server error" "description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "An unexpected error occurred on the server."
}
}
}
}
}
} }
} }
} }
@ -302,13 +342,52 @@
} }
}, },
"402": { "402": {
"description": "Payment required" "description": "Payment required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Payment required to access this resource."
}
}
}
}
}
}, },
"429": { "429": {
"description": "Too many requests" "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": { "500": {
"description": "Server error" "description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "An unexpected error occurred on the server."
}
}
}
}
}
} }
} }
} }
@ -387,13 +466,52 @@
} }
}, },
"402": { "402": {
"description": "Payment required" "description": "Payment required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Payment required to access this resource."
}
}
}
}
}
}, },
"429": { "429": {
"description": "Too many requests" "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": { "500": {
"description": "Server error" "description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "An unexpected error occurred on the server."
}
}
}
}
}
} }
} }
} }
@ -459,13 +577,52 @@
} }
}, },
"402": { "402": {
"description": "Payment required" "description": "Payment required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Payment required to access this resource."
}
}
}
}
}
}, },
"429": { "429": {
"description": "Too many requests" "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": { "500": {
"description": "Server error" "description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "An unexpected error occurred on the server."
}
}
}
}
}
} }
} }
} }
@ -509,13 +666,52 @@
} }
}, },
"402": { "402": {
"description": "Payment required" "description": "Payment required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Payment required to access this resource."
}
}
}
}
}
}, },
"429": { "429": {
"description": "Too many requests" "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": { "500": {
"description": "Server error" "description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "An unexpected error occurred on the server."
}
}
}
}
}
} }
} }
} }