Skip to content

Commit 9c990bc

Browse files
Document custom header configuration in README
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent e70b553 commit 9c990bc

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ export HYPERBROWSER_API_KEY="your_api_key"
2424
export HYPERBROWSER_BASE_URL="https://api.hyperbrowser.ai" # optional
2525
```
2626

27+
You can also pass custom headers (for tracing/correlation) via `ClientConfig`:
28+
29+
```python
30+
from hyperbrowser import ClientConfig, Hyperbrowser
31+
32+
config = ClientConfig(
33+
api_key="your_api_key",
34+
headers={"X-Correlation-Id": "req-123"},
35+
)
36+
37+
with Hyperbrowser(config=config) as client:
38+
...
39+
```
40+
2741
## Clients
2842

2943
The SDK provides both sync and async clients with mirrored APIs:

0 commit comments

Comments
 (0)