Skip to content

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

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

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

Conversation

@Max17190

@Max17190 Max17190 commented Sep 13, 2026 •

Copy link
Copy Markdown
Member

Why

Document optional, evidence-based feedback for keyless Search, Scrape, and Parse using the API contract in #4616.

Summary

  • Describe the API invitation, job references, 24-hour window, retries, failure observations, and Parse retention. Tie the submission deadline to the invitation's expiresAt and require the originating caller IP.
  • Document endpoint-specific observations, reason codes, evidence requirements, and request limits in OpenAPI.
  • Preserve authenticated feedback and the separate Search Feedback endpoint.

Publish before enabling the API invitations publicly; they link to this page. MCP and CLI support can follow once the API and docs are available.

Test Plan

  • Current head 69f906d3: synced with main; valid OpenAPI JSON and all 861 schema parity cases passed against the current API implementation.
  • Extraction-hostile markdown and locale fixture checks passed.
  • Fresh Firecrawl scrape of the deployed preview verified the exact API invitation, visible keyless required fields, metadata locations, 24-hour window, retry timing, document class, and size limits.
  • The locale literal check reports the same 14 translated-page failures as current main. Translated files are managed separately.
  • Requested a full Cubic review. This repository has not returned a Cubic review or check.

@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 Oct 3, 2026, 3:23 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
Remove the daily submission allowance and the exact attempt rate from the
feedback reference and OpenAPI description. Each job accepts one submission,
retries return the original record, and attempts are rate limited.
The keyless feedback API caps each knownSources URL at 2048 characters,
matching the comparison reference.
Declare minLength 1 for origin, matching the API validation.
@Max17190
Max17190 marked this pull request as ready for review October 1, 2026 16:08
@Max17190

Max17190 commented Oct 1, 2026

Copy link
Copy Markdown
Member Author

@cubic-dev-ai review this PR. Review the full diff using firecrawl/firecrawl#4616 as the API contract, including optional invitation language, endpoint-specific evidence, the 24-hour window, and preservation of authenticated feedback.

@Max17190

Max17190 commented Oct 3, 2026

Copy link
Copy Markdown
Member Author

@cubic-dev-ai review the complete current PR diff after syncing with main. Use firecrawl/firecrawl#4616 as the source of truth for optional keyless feedback. Verify the 24-hour window, evidence requirements, preserved job references on success and failure, ownership, one submission per job, separate attempt limits, no keyless refunds or quota resets, and preservation of authenticated feedback. Recheck prior findings against the current code.

This branch was successfully deployed

1 active deployment
staging — 69f906d3 Deployed Oct 3, 2026 by mintlify[bot]
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