Skip to content

docs: document keyless feedback in the v2 API reference - #1414

Draft
Max17190 wants to merge 15 commits into
mainfrom
max/document-keyless-feedback
Draft

Max17190 wants to merge 15 commits into
mainfrom
max/document-keyless-feedback

Conversation

@Max17190

@Max17190 Max17190 commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Why

The v2 feedback reference needs to describe keyless Search, Scrape, and Parse requests while preserving the existing authenticated API.

Summary

  • Add the three keyless request formats with concise field descriptions, category-specific observations, and shared evidence fields.
  • Document optional replacement knownSources on irrelevant Search results, applicable output formats, correct content in comparisons, and keyless Parse feedback retention. Unmentioned Search results remain unassessed.
  • Use the existing UUID documentation convention for job IDs and positive page/result positions.
  • Preserve the authenticated request format and example. Add keyless authentication guidance, the daily submission limit, and a keyless example.
  • Add one feedback discovery sentence to Search, Scrape, and Parse. Remove the Search Feedback recommendation from the Feedback page; leave its API operation and page unchanged.
  • Keep the existing documentation layout, security scheme, and navigation. No CSS or translated-page changes.

Depends on firecrawl/firecrawl#4616. Publish after the API support is deployed.

Test Plan

  • Passed 236 request acceptance comparisons against the API validator, including replacement-source URL schemes, bounds, and observation-kind restrictions. All local OpenAPI references resolve.
  • Verified these revisions only change the keyless request/comparison schemas and feedback page wording; authenticated schemas and operation definitions are unchanged.
  • Ran mint validate against both the revised checkout and the pre-revision commit. Both report the same 17 missing-snippet warnings, with no new warnings from these changes.
  • The locale-literal CI check fails on the same 14 translated identifiers as the pre-revision commit; verified identical diagnostics locally.
  • Passed git diff --check.

Mintlify still labels bearer authentication required despite optional authentication in the specification. Keyless header omission is documented; no renderer workaround is included.

@mintlify

mintlify Bot commented Sep 13, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Sep 14, 2026, 3:03 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@Max17190 Max17190 changed the title docs(api): document keyless feedback in the v2 reference docs: document keyless feedback in the v2 API reference Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant