summaryrefslogtreecommitdiffhomepage
path: root/packages/sdk/python/docs/usage/configuration.md
diff options
context:
space:
mode:
authorKevin King <[email protected]>2025-10-28 19:32:45 -0400
committerGitHub <[email protected]>2025-10-28 18:32:45 -0500
commit0e60f666043910afb96e9de2f84b0b8a68c7e4d6 (patch)
tree6ca20af712e2faca6262f029d6d8499c9888eb50 /packages/sdk/python/docs/usage/configuration.md
parentfc8db6cdf9cb81e29c5dda69c8646aa52e453a9c (diff)
downloadopencode-0e60f666043910afb96e9de2f84b0b8a68c7e4d6.tar.gz
opencode-0e60f666043910afb96e9de2f84b0b8a68c7e4d6.zip
ignore: python sdk (#2779)
Co-authored-by: Aiden Cline <[email protected]>
Diffstat (limited to 'packages/sdk/python/docs/usage/configuration.md')
-rw-r--r--packages/sdk/python/docs/usage/configuration.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/packages/sdk/python/docs/usage/configuration.md b/packages/sdk/python/docs/usage/configuration.md
new file mode 100644
index 000000000..f5e0c60bb
--- /dev/null
+++ b/packages/sdk/python/docs/usage/configuration.md
@@ -0,0 +1,21 @@
+# Configuration
+
+OpenCodeClient accepts common options for auth, timeouts, and retries.
+
+```python
+from opencode_ai import OpenCodeClient
+
+client = OpenCodeClient(
+ base_url="http://localhost:4096",
+ token="pypi-or-other-token",
+ auth_header_name="Authorization",
+ auth_prefix="Bearer",
+ timeout=30.0, # seconds
+ retries=2,
+ backoff_factor=0.2, # exponential backoff
+)
+```
+
+- Auth: sets the header `{auth_header_name}: {auth_prefix} {token}` when `token` is provided
+- Retries: retry on transient httpx.RequestError and 429/5xx
+- Timeouts: passed to httpx.Timeout