diff options
Diffstat (limited to 'packages/sdk/python/docs/usage/configuration.md')
| -rw-r--r-- | packages/sdk/python/docs/usage/configuration.md | 21 |
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 |
