Repository navigation
docs(cli): document CLI request attribution and agent origin - #1675
Open
mintlify[bot] wants to merge 2 commits into
Open
mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
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.
Adds a "Request attribution" section to the CLI page. It explains how tools that wrap the CLI set
FIRECRAWL_INTEGRATIONso their requests are attributed to them instead ofcli.The same section now explains that CLI requests carry a
cli@<version>origin. When a coding agent runs the CLI, the origin also names the agent (for examplecli.codex@<version>). SetFIRECRAWL_CLI_DISABLE_AGENT_ORIGIN=1to turn that off.It also corrects the
integrationfield description in the OpenAPI spec. A body value ofclino longer beats a validX-Integrationheader, so "the body value takes precedence" was no longer fully true.Based on feat(cli): let wrappers set the integration tag with FIRECRAWL_INTEGRATION, which sends the variable as the
X-Integrationheader, fix(api): let a valid X-Integration header override a body integration of cli, which made the API honor it, and feat: stamp the coding agent in the request origin, which added the agent origin and its opt-out.Needs a human look: the example value
_my-toolfollows the CLI README. I renamed the section from "Integration attribution" to "Request attribution" because it now covers the origin too. The page lists the seven detected agents by name. Drop the list if you'd rather not keep it in sync with the CLI.