Skip to content

Commit 83f7cc7

Browse files
Document base URL control-character restrictions
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent 5fe4d6a commit 83f7cc7

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ export HYPERBROWSER_HEADERS='{"X-Correlation-Id":"req-123"}' # optional JSON obj
2828
`api_key` must be a non-empty string.
2929

3030
`base_url` must start with `https://` (or `http://` for local testing), include a host,
31-
and not contain query parameters, URL fragments, backslashes, or whitespace/newline characters.
31+
and not contain query parameters, URL fragments, backslashes, control characters,
32+
or whitespace/newline characters.
3233
The SDK normalizes trailing slashes automatically.
3334
If `base_url` already ends with `/api`, the SDK avoids adding a duplicate `/api` prefix.
3435
If `HYPERBROWSER_BASE_URL` is set, it must be non-empty.

0 commit comments

Comments
 (0)