Repository navigation
docs(gaps): document recent API and SDK changes - #1754
Open
mintlify[bot] wants to merge 1 commit into
Open
mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This was referenced Oct 30, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents API and SDK changes that shipped without docs, rebased onto current main. Replaces eight stale single-source Autopilot PRs. The CLI gaps are in the companion PR #1753.
sdks/node.mdx,sdks/python.mdx:cancelCrawl/cancel_crawlnow return false on an already-completed crawl. Also covers the JSsignaloption oncrawl()and cancelling an awaited asynccrawl()in Python. Based on firecrawl#4898, firecrawl#4897 (claude[bot]). Was docs(sdks): document crawl cancellation in the JS and Python SDKs #1604.features/parse.mdx,v2-openapi.json:automode on /v2/parse now runs full layout analysis, structured tables come back as HTML, and /scrape output can differ. Based on firecrawl#5110, @abimaelmartell. Was docs(parse): describe full PDF layout parsing and HTML tables #1655.features/scrape.mdx,api-reference/introduction.mdx,v2-openapi.json: ZDR requests always verify TLS, soskipTlsVerificationis ignored. Based on firecrawl#5196, @rowinsg. Was docs(scrape): note that ZDR requests always verify TLS #1656.features/search.mdx,v2-openapi.json: a tools-only search returns503TOOL_DISCOVERY_UNAVAILABLEand is not billed. Based on firecrawl#5231, @erikengervall. Was docs: document .NET Interact, agent methods and the search tool-discovery 503 #1669. Its .NET Interact/Agent sections were dropped because Erik usually documents his own SDK work.features/developer.mdx: replaced the now-false note that the SDKs have no developer search method. Each SDK's method is now named. Based on firecrawl#5269–#5278, @erikengervall. Was docs(developer): document SDK developer search methods #1677, trimmed to this one sentence.api-reference/endpoint/credit-usage-historical.mdx,v2-openapi.json: adds thebyEndpointandbinparams, theendpoint/binfields and the400. Also fixestotalCreditstocreditsUsed. Based on firecrawl#5291, @rakshith48. Was docs(api-reference): document byEndpoint and bin for credit usage #1682.sdks/go.mdx:FirecrawlErrorwraps transport errors, so you can match them witherrors.Is/errors.As. Based on firecrawl#5311, @Chadha93. Was docs(go): note that FirecrawlError wraps transport errors #1695.api-reference/errors.mdx: adds the404zdr_no_snapshotsAgent error. Based on firecrawl#5185, @rakshith48. Was docs(agent): add the zdr_no_snapshots error to the Agent errors catalog #1697.Dropped: #1673 (Agent credit check). The credit gate changed after that PR (a 20-credit minimum, and hosted MCP credits in firecrawl#5463), and Rakshith usually documents Agent billing himself.
Needs a human look: the HTML-table wording on the Parse page leaves out exact thresholds because they come from FirePDF.