-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add WebSocket connection documentation #8404
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@OpenHands make it clear that if your connecting via OpenHands Cloud, you should provision an API key, and then pass the header Authorization: Bearer $API_KEY
to websocat or whatever other websocket client
Link to https://docs.all-hands.dev/modules/usage/cloud/cloud-api for getting an API key
Also add a link to that page (inside the docs/ folder) linking to this page and explaining that this is how you connect to the websocket
Ack on this. Is the information accurate? Have you done an initial review? |
I've read through it, but haven't run the code samples @OpenHands replace the placeholder |
I'm on it! rbren can track my progress at all-hands.dev |
I successfully addressed the PR comment by replacing all instances of the placeholder URL in the WebSocket documentation. Here's what I did:
The PR #8404 has been updated with these changes. All code examples in the WebSocket documentation now use localhost:3000 as the server URL instead of the placeholder. |
This PR adds documentation for connecting to the OpenHands WebSocket API:
The documentation includes:
To run this PR locally, use the following command: