docs: advertise the hosted v4 API in the README - #145
Merged
Conversation
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Alezander9
added a commit
to browser-use/browser-use
that referenced
this pull request
Aug 4, 2026
## Summary The "Fully-Hosted Cloud Agent" block sells the hosted agent but never shows it. Adds the one call that runs it, right under the bullets: ```sh curl -X POST https://api.browser-use.com/api/v4/runs \ -H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \ -H "Content-Type: application/json" \ -d '{"task": "Your task"}' ``` `task` is the only required field. Same snippet is going into the BrowserCode README (browser-use/browsercode#145) — v4 is the BrowserCode agent, which is the Cloud v4 line in the plot above this section. ## Test plan Ran the snippet verbatim against production with a real key: created a run (`{"id":"f20575b6-...","status":"queued","model":"gpt-5.6-luna",...}`), cancelled immediately, $0.00 spent. Ran it verbatim with `BROWSER_USE_API_KEY` unset: curl drops a valueless header rather than sending an empty one, so it lands on the missing-API-key 401. browser-use/cloud#5397 rewrites that 401 to name the one-click key-creation URL, so this should land after that deploys. `pre-commit run --files README.md` — passed (codespell + the file hygiene hooks; the Python hooks have no files to check). <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Add a curl example to the README to show how to start the Fully-Hosted Cloud Agent via POST to https://api.browser-use.com/api/v4/runs. The snippet uses the `X-Browser-Use-API-Key` header and `Content-Type: application/json`; `task` is the only required field. <sup>Written for commit 455fd42. Summary will update on new commits.</sup> <a href="https://cubic.dev/pr/browser-use/browser-use/pull/5394?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. -->
![https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source](https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source){kind=link}
![https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img](https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img){kind=link}
![https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a](https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a){kind=link}
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
1 participant
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.
Issue for this PR
Closes #
Type of change
What does this PR do?
The Hosted section pointed at the Cloud dashboard and left it at that. v4 is BrowserCode-only by
construction (the v4 worker image ships
bcodeas its sole core agent), so the hosted pitch can bethe API call itself rather than a link to a signup flow. Replaces the sentence with the one call
that runs the agent:
taskis the only required field. The Browser Use Cloud link is kept on the sentence above it.How did you verify your code works?
Ran the snippet verbatim against production with a real key: it created a run
(
{"id":"f20575b6-...","status":"queued","model":"gpt-5.6-luna",...}), which I cancelledimmediately ($0.00 spent).
Also ran it verbatim with
BROWSER_USE_API_KEYunset. curl drops a valueless header rather thansending an empty one, so it lands on the missing-header 401. That error currently reads
X-Browser-Use-API-Key header is required, which tells a new reader nothing;browser-use/cloud#5397 rewrites both 401 bodies to name the one-click key-creation URL. This PR
should land after that deploys.
Screenshots / recordings
n/a
Checklist
Summary by cubic
Adds a hosted v4 API quickstart to the README so users can run the agent with a single curl call. Keeps the Cloud link and shows POST https://api.browser-use.com/api/v4/runs using the X-Browser-Use-API-Key header, with task as the only required field.
Written for commit 8615ae9. Summary will update on new commits.