Fix docs R2: auth header, legacy property names#100
Open
MagMueller wants to merge 2 commits intomainfrom
Open
Conversation
There was a problem hiding this comment.
1 issue found across 3 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/cloud/legacy/agent.mdx">
<violation number="1" location="docs/cloud/legacy/agent.mdx:77">
P2: The snippet now uses POST, but the section explicitly says presigned uploads should use PUT. This makes the example inconsistent and likely incorrect for presigned URLs.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.
| await fetch(upload.presignedUrl, { | ||
| method: "PUT", | ||
| await fetch(upload.url, { | ||
| method: "POST", |
There was a problem hiding this comment.
P2: The snippet now uses POST, but the section explicitly says presigned uploads should use PUT. This makes the example inconsistent and likely incorrect for presigned URLs.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/cloud/legacy/agent.mdx, line 77:
<comment>The snippet now uses POST, but the section explicitly says presigned uploads should use PUT. This makes the example inconsistent and likely incorrect for presigned URLs.</comment>
<file context>
@@ -73,8 +73,8 @@ const upload = await client.files.sessionUrl(session.id, {
-await fetch(upload.presignedUrl, {
- method: "PUT",
+await fetch(upload.url, {
+ method: "POST",
body: readFileSync("input.pdf"),
headers: { "Content-Type": "application/pdf" },
</file context>
Suggested change
| method: "POST", | |
| method: "PUT", |
- agent/quickstart.mdx: Authorization: Bearer → X-Browser-Use-API-Key - legacy/agent.mdx: upload.presignedUrl → upload.url, method PUT → POST - legacy/agent.mdx: output.presignedUrl → output.downloadUrl - legacy/public-share.mdx: share.url → share.shareUrl (both Python and TS) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove link to non-existent github.com/browser-use/browser-use-cli repo. The profile subcommand is part of the CLI itself. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
d1b3005 to
37ed738
Compare
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
agent/quickstart.mdxcurl example:Authorization: Bearer→X-Browser-Use-API-Keyupload.presignedUrl→upload.url, methodPUT→POST;output.presignedUrl→output.downloadUrlshare.url→share.shareUrl(both Python and TS)All
Authorization: Bearerinstances now removed from MDX sources (only remain in generatedllms-full.txtwhich will regenerate).Still needs input
profile.shURL is 404 — need correct URL or removalbrowser-use-cliGitHub repo is 404 — need correct repo URLTest plan
X-Browser-Use-API-Key🤖 Generated with Claude Code
Summary by cubic
Fix docs to use the
X-Browser-Use-API-Keyheader, align legacy examples with the current API, and remove a dead CLI repo link. Curl and code samples now work as written; CLI docs clarify thatprofileis built-in.docs/cloud/agent/quickstart.mdx, replaceAuthorization: BearerwithX-Browser-Use-API-Key.docs/cloud/legacy/agent.mdx, changeupload.presignedUrl→upload.urlwithPOST, andoutput.presignedUrl→output.downloadUrl.docs/cloud/legacy/public-share.mdx, changeshare.url→share.shareUrl(TS) andshare.share_url(Python).docs/open-source/browser-use-cli.mdx, remove the dead repo link and state theprofilesubcommand syncs cookies and is part of the CLI.Written for commit 37ed738. Summary will update on new commits.