docs(ask): drop usage from /support/ask response + neutralize example diagnosis#920
Merged
docs(ask): drop usage from /support/ask response + neutralize example diagnosis#920
Conversation
… example
support-agent dropped `usage` from the customer-facing /v2/support/ask
response envelope (it was an internal cost-tracking signal customers
can't act on). Sync the docs:
- api-reference/v2-openapi.json: remove `usage` from AskResponse schema.
- api-reference/endpoint/ask.mdx: remove the `usage` row from the
response fields table.
- features/ask.mdx: remove the `usage` line from the /ask example
payload AND replace the prior example answer/fixParameters/validation
with neutral placeholders. The previous example was a fabricated
diagnosis ("Your crawl is hitting a robots.txt disallow on
/products/*. The fix is to add the allowBackwardCrawling parameter.")
that read like real Firecrawl guidance — readers might apply it to
unrelated runs even though the agent's actual answer is generated
per-request from the user's specific job logs. Replaced with `<...>`
placeholders + an explicit note clarifying that the example shows the
shape, not a real diagnosis.
The /support/docs-search example keeps its usage field — that endpoint
still returns it (different envelope shape, different code path).
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
Two changes on the
/support/askdocs to keep the published contract honest:1. Drop
usagefrom the/support/askresponseToken usage is captured server-side for telemetry but not returned to callers — companion change in support-agent removes it from the
AnswerEnvelope. The docs were promising ausageobject that won't actually be there. Updates:api-reference/v2-openapi.json— dropusagefrom theAskResponseschema.api-reference/endpoint/ask.mdx— drop theusagerow from the response fields table.features/ask.mdx— drop theusageline from the/support/askexample payload./support/docs-searchkeeps itsusagefield — that endpoint still returns it (different envelope shape, different code path).2. Replace the fabricated example diagnosis
The previous example in
features/ask.mdxlooked like real Firecrawl guidance:{ "answer": "Your crawl is hitting a robots.txt disallow on /products/*. The fix is to add the allowBackwardCrawling parameter.", "fixParameters": { "allowBackwardCrawling": true }, "validation": { "tested": true, "result": "success", "evidence": "validateScrape with allowBackwardCrawling:true returned 12,403 chars vs 0 baseline." } }The agent generates each
answer/fixParameters/validation.evidenceper request, from the caller's specific job logs — there's no canonical "robots.txt → allowBackwardCrawling" mapping in the agent. Showing this example invites readers (and downstream LLMs reading the docs) to apply it to unrelated failures even though it's a snapshot from one particular run.Replaced with neutral
<...>placeholders and an explicit one-liner clarifying that the example shows the shape, not a real diagnosis:{ "answer": "<2-4 sentence prose diagnosis of the issue plus the recommended fix.>", "confidence": "high", "fixParameters": { "<param>": "<value>" }, "validation": { "tested": true, "result": "success", "evidence": "<short summary of the validation tool call the agent ran to confirm the fix>" }, "feedback": null, "durationMs": 18432 }Companion PRs
usagefrom theAnswerEnvelopeinterface (source of truth).usagefrom the playground Debug modal's validation schema.usagefrom the CLI'sAskResponsetype.usagefrom thefirecrawl_asktool's Returns description.Test plan
usageline.usageunderAskResponse.features/ask.mdxreads as obviously templated (<...>placeholders) rather than as factual guidance.🤖 Generated with Claude Code