Repository navigation
docs(alexandria): document zero data retention for provider calls - #1707
Open
developersdigest wants to merge 1 commit into
Open
developersdigest wants to merge 1 commit into
developersdigest wants to merge 1 commit into
Conversation
Explain how to set zeroDataRetention beside alexandria, which providers show support, the per-request credit, and the replay errors. Co-authored-by: Developers Digest <developersdigest@users.noreply.github.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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 how to run an Alexandria provider call with zero data retention.
The page is Alexandria → Zero Data Retention. It explains what is kept, how to tell which providers support ZDR, how to set the flag, the +1 credit, and what a retry does. Scrape, billing, security, enterprise, agent, the error catalog, and the v2 scrape reference cross-link that section instead of repeating it.
How to enable it
POST /v2/scrapeacceptszeroDataRetention: trueas a sibling ofalexandria, next totimeout,origin, andintegration. Verified inapps/api/src/controllers/v2/scrape-alexandria.tsonfirecrawl/firecrawlmain, and in firecrawl/firecrawl#5178. A team withforceZDR/scrapeZDR: "forced"gets the flag on every Alexandria call without setting it. The public API forwards the field to Exchange asx-exchange-zero-data-retention: trueon the quote and the retrieve call.The current JavaScript and Python SDKs on that same main do not send the field for an Alexandria scrape. JavaScript rejects any key other than
alexandria,requestId,timeout,integration, andorigin. Python forwardstimeout,integration, andrequest_idonly. The page says to send the HTTP request.What a ZDR call keeps
The original response is returned to the caller. After that:
responseWithheld). Replaying the samex-request-idreturns 409response_not_retainedwith "This provider request already completed. Its response is not kept under zero data retention."zeroDataRetentionvalue, returns 409duplicate_request.domainToolson a URL scrape is still refused with 403 when zero data retention is active. Alexandria execution itself is no longer described as a 403 for that reason. The OpenAPI 403 text is updated to match.Not verified here
creditsCostExchange returns. firecrawl/firecrawl#5178 says Exchange prices +1 credit for workflow programs in the quote, and that this depended onfirecrawl/exchange#936, which was not merged when that pull request landed.firecrawl/exchangeand firecrawl/firecrawl-web#4267 both returned 404 to this environment, so the pill copy and the quote math were not read from source. The page states the cost the provider-page pill is described as showing: +1 credit per request when ZDR is enabled, on top of the tool price, withdata.creditsCostas the total. It does not say how that credit multiplies when one HTTP request batches several calls.zero_data_retention_unsupported. The merged API change says Exchange answers 400 with this code for a capability that cannot honor ZDR, and the controller comment says Exchange decides per capability. The code string is not asserted in the public API tests; the API relays Exchange's body. The exact error sentence is not documented.firecrawl/find-toolsas still refused by Exchange unless Exchange allows it. The public API forwards the flag and skips recording discovery. That refusal is not written up here.allowZDRbefore forwardingzeroDataRetention: true. Only the forced mode is applied automatically. No 403 for a team without ZDR enabled is documented for this path.