Skip to content

docs: add agent usability redirects and endpoint lookup tables - #1278

Open
claude[bot] wants to merge 2 commits into
mainfrom
docs/agent-usability-actionables-aug-2026
Open

docs: add agent usability redirects and endpoint lookup tables#1278
claude[bot] wants to merge 2 commits into
mainfrom
docs/agent-usability-actionables-aug-2026

Conversation

@claude

@claude claude Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Requested by Micah Stairs · Slack thread

Before

An agent (or a person) guessing a plausible-looking docs slug for our browser, interact, crawl, and team-management endpoints hit a 404. Fifteen such guesses — things like /api-reference/endpoint/browser-create-session, /api-reference/endpoint/crawl-url-preview, /features/scrape-and-interact, and eight team-prefixed variants — had no page and no redirect, so there was no path from the guess to the real page. On top of that, the team endpoints are served under /v2/team/... while their docs slugs drop the team prefix, and that mapping was written down nowhere. The interaction-model table on the Interact page named the REST endpoints but not the SDK methods that call them, so a reader still had to go hunting for the method name.

After

Those fifteen slugs now land on their real pages instead of 404ing. The Team Activity reference page carries a lookup table mapping each team operation to its HTTP path and its docs slug, so a wrong guess is one table away from the right page. The Interact page's existing comparison table gained an "SDK methods (Node)" column, with the Python snake_case equivalents named in the prose below it, so the endpoint and the method that calls it are visible in the same row.

How

Three files, all additive — no existing content was rewritten or removed.

  • docs.json — 15 entries added to the redirects array (118 → 133). They cover browser/interact slug variants, two crawl operation variants, and eight team-management variants. The block is prepended as one themed group, matching how the July batch (a20f233a) landed; the array is not alphabetically sorted, so appending or interleaving would have been the odd choice here.
  • api-reference/endpoint/activity.mdx — a new "Team Management Endpoints" section with a verb-to-slug lookup table covering activity, credit usage, credit usage (historical), queue status, token usage, and token usage (historical).
  • features/interact.mdx — a fourth column on the existing ## Choose the right interaction model table, rather than a second near-duplicate table below it.

Deviations from the source actionables document

Three places where the source document's proposal did not survive contact with the repo:

  • Its proposed team-activity destination is itself a redirect, so that entry points at activity directly rather than creating a two-hop chain.
  • The four SDK method names it proposed do not exist in the repo. The real ones were used: browser(), browserExecute(), listBrowsers(), deleteBrowser(), interact(), and stopInteraction().
  • Two cells in its draft table were clipped mid-word and were reconstructed as credit-usage-historical and token-usage-historical.

The 7 routes the source document deliberately excluded were left untouched.

What a reviewer should spot-check

Live HTTP verification was not possible from this environment — outbound HTTPS is blocked, so no request was ever made against the live docs site. The 404s were confirmed against the docs source at HEAD instead: for each of the 15 sources there is no page file and no pre-existing entry in the redirects array. That is a source-level check, not a real response, so it is worth confirming against production that these 15 really do 404 today and that each destination really does resolve.

python3 -m json.tool docs.json parses cleanly.


Generated by Claude Code

Land the 15 August 2026 Firecrawl Agent Usability Actionables redirects
and the two content improvements still open from the July 18 baseline.

docs.json: add 15 redirects (5 browser/interact, 2 crawl, 8 team
management) for slug variants agents construct from HTTP paths. The
redirects array goes 118 -> 133 entries. The get-team-activity redirect
targets /api-reference/endpoint/activity rather than the proposed
/api-reference/endpoint/team-activity, which is itself a redirect source
and would have produced a two-hop chain.

api-reference/endpoint/activity.mdx: add a "Team Management Endpoints"
verb-to-slug lookup table mapping each team operation to its
/v2/team/... HTTP path and its canonical docs page. Placed on the first
page of the Account Endpoints group, which is where the team-* redirects
land.

features/interact.mdx: extend the existing "Choose the right interaction
model" table with an SDK methods column instead of adding a second,
overlapping operations table. Method names verified against the snippets
under snippets/v2/browser and snippets/v2/interact.
@mintlify

mintlify Bot commented Aug 18, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
firecrawl 🟢 Ready View Preview Aug 18, 2026, 6:41 PM

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

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