{"id":27897,"library":"kodexa","title":"Kodexa Python SDK","description":"Python SDK for the Kodexa Platform, enabling AI-powered document processing, content extraction, and workflow automation. Current version 7.4.421830084132, with rapid, automated releases. Requires Python >=3.11,<3.14.","status":"active","version":"7.4.421830084132","language":"python","source_language":"en","source_url":"https://github.com/kodexa-ai/kodexa","tags":["sdk","document-processing","ai","kodexa"],"install":[{"cmd":"pip install kodexa","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"KodexaClient is directly under the kodexa package, not a submodule.","wrong":"from kodexa.client import KodexaClient","symbol":"KodexaClient","correct":"from kodexa import KodexaClient"},{"note":"","wrong":"","symbol":"Document","correct":"from kodexa import Document"}],"quickstart":{"code":"from kodexa import KodexaClient\nimport os\n\nclient = KodexaClient(api_key=os.environ.get('KODEXA_API_KEY', ''))\nprint(client.get_me())\n","lang":"python","description":"Initialize client with API key from environment variable and fetch current user info."},"warnings":[{"fix":"Pin to exact version: kodexa==7.4.421830084132","message":"The SDK versioning uses a four-part semver with timestamp-based patch; major/minor bumps may include breaking changes without notice. Always pin your dependency and test thoroughly before upgrading.","severity":"breaking","affected_versions":">=7.0"},{"fix":"Replace `from kodexa.platform import KodexaPlatform` with `from kodexa import KodexaClient` and adjust method calls accordingly.","message":"The `KodexaPlatform` class (imported from `kodexa.platform`) is deprecated in favor of `KodexaClient`. Update all code using the old client.","severity":"deprecated","affected_versions":">=7.0"},{"fix":"Pass `timeout` parameter during client instantiation: `KodexaClient(..., timeout=120)`","message":"The SDK internally uses `httpx` with a default timeout of 30 seconds. Long-running document processing may timeout. Adjust client timeout via `KodexaClient(timeout=120)` if needed.","severity":"gotcha","affected_versions":">=7.0"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Use `from kodexa import KodexaClient`","cause":"Incorrect import path for KodexaClient; users often try `from kodexa.client import KodexaClient` based on older patterns.","error":"ModuleNotFoundError: No module named 'kodexa.client'"},{"fix":"Set environment variable `KODEXA_API_KEY` or pass `api_key='your-key'` to `KodexaClient()`","cause":"Missing or invalid API key. The SDK expects a valid Kodexa API key set as `KODEXA_API_KEY` environment variable or passed as `api_key` parameter.","error":"kodexa.exceptions.KodexaApiError: 401 Unauthorized"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}