Skip to content

docs(ask): drop usage from /support/ask response + neutralize example diagnosis#920

Merged
devhims merged 2 commits intomainfrom
docs/drop-usage-from-ask-response
May 7, 2026
Merged

docs(ask): drop usage from /support/ask response + neutralize example diagnosis#920
devhims merged 2 commits intomainfrom
docs/drop-usage-from-ask-response

Conversation

@devhims
Copy link
Copy Markdown
Member

@devhims devhims commented May 7, 2026

Summary

Two changes on the /support/ask docs to keep the published contract honest:

1. Drop usage from the /support/ask response

Token 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 a usage object that won't actually be there. Updates:

  • api-reference/v2-openapi.json — drop usage from the AskResponse schema.
  • api-reference/endpoint/ask.mdx — drop the usage row from the response fields table.
  • features/ask.mdx — drop the usage line from the /support/ask example payload.

/support/docs-search keeps its usage field — that endpoint still returns it (different envelope shape, different code path).

2. Replace the fabricated example diagnosis

The previous example in features/ask.mdx looked 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.evidence per 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
}

The actual answer, fixParameters, and validation.evidence are produced per request by the agent based on your specific run; the example above shows the response shape, not a real diagnosis.

Companion PRs

Test plan

  • Mintlify renders the response example without the usage line.
  • OpenAPI-generated reference page no longer shows usage under AskResponse.
  • The example block in features/ask.mdx reads as obviously templated (<...> placeholders) rather than as factual guidance.

🤖 Generated with Claude Code


Open in Devin Review

devhims and others added 2 commits May 7, 2026 19:57
… 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>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 7, 2026

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

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview May 7, 2026, 2:31 PM

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

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

@devhims devhims merged commit 8e86a82 into main May 7, 2026
2 checks passed
@devhims devhims deleted the docs/drop-usage-from-ask-response branch May 7, 2026 14:59
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