{"id":46558,"library":"superdoc-sdk","title":"SuperDoc SDK","description":"SuperDoc SDK (CLI-backed) is a Python library for document parsing and data extraction, focusing on structured outputs from PDFs and images. It provides both high-level and low-level APIs for interacting with SuperDoc's cloud service. Current version 1.14.0, released monthly (requires Python >=3.9).","status":"active","version":"1.14.0","language":"python","source_language":"en","source_url":"https://github.com/superdoc/superdoc-sdk","tags":["document-parsing","pdf","ocr","data-extraction","superdoc"],"install":[{"cmd":"pip install superdoc-sdk","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"HTTP client for API requests","package":"httpx","optional":false},{"reason":"Data validation and settings management","package":"pydantic","optional":false},{"reason":"File uploads via multipart","package":"python-multipart","optional":false}],"imports":[{"wrong":"from superdoc_sdk import SuperDocClient","symbol":"SuperDocClient","correct":"from superdoc import SuperDocClient"},{"wrong":"from superdoc_sdk import AsyncSuperDocClient","symbol":"AsyncSuperDocClient","correct":"from superdoc import AsyncSuperDocClient"},{"wrong":"from superdoc_sdk import SuperDocDocument","symbol":"SuperDocDocument","correct":"from superdoc import SuperDocDocument"}],"quickstart":{"code":"import os\nfrom superdoc_sdk import SuperDocClient\n\nclient = SuperDocClient(api_key=os.environ.get('SUPERDOC_API_KEY', ''))\n\n# Parse a PDF\nwith open('document.pdf', 'rb') as f:\n    result = client.parse_document(f, file_type='pdf')\n\nprint(result.id)\nprint(result.status)","lang":"python","description":"Initialize client with API key and parse a PDF document."},"warnings":[{"fix":"Update imports: `from superdoc_sdk import SuperDocClient`.","message":"The import path changed from `superdoc.client` to `superdoc_sdk` in v1.12. Code using the old path will break.","severity":"breaking","affected_versions":">=1.12.0"},{"fix":"Always specify `file_type` (e.g., 'pdf', 'image', 'docx').","message":"`parse_document` now requires `file_type` as a mandatory keyword argument (previously inferred from extension). Omitting it raises a `ValueError`.","severity":"breaking","affected_versions":">=1.13.0"},{"fix":"Install the CLI via `pip install superdoc-cli` or add its location to PATH.","message":"The library uses a CLI-backed architecture; ensure the `superdoc` CLI is installed and available in PATH during init, or the SDK may fail silently.","severity":"gotcha","affected_versions":"all"},{"fix":"Replace `doc.parse()` with `doc.extract()`.","message":"Method `document.parse()` was deprecated in v1.14 in favor of `document.extract()`. Old method will be removed in v2.0.","severity":"deprecated","affected_versions":">=1.14.0"},{"fix":"Set `SUPERDOC_API_KEY` in environment or pass `api_key` parameter.","message":"API key must be provided via environment variable `SUPERDOC_API_KEY` or passed explicitly to the constructor. If neither is set, the client raises a `ConfigurationError`.","severity":"gotcha","affected_versions":"all"},{"fix":"Use `async with SuperDocClient(...) as client:` for async operations.","message":"The library uses `httpx` for async requests; by default, the client is sync. Mixing sync and async contexts can cause `RuntimeError`.","severity":"gotcha","affected_versions":"all"},{"fix":"Access `result.status` instead of `result.state`.","message":"Response model `DocParseResponse` had field `status` renamed from `state` in v1.10. Old code accessing `result.state` will fail.","severity":"breaking","affected_versions":">=1.10.0"}],"env_vars":null,"search_vec":"'1.14.0':46 '3.9':51 'api':36 'back':7 'cli':6 'cli-back':5 'cloud':42 'current':44 'data':16,58 'data-extract':57 'document':13,53 'document-pars':52 'extract':17,59 'focus':18 'high':30 'high-level':29 'imag':25 'interact':38 'level':31,35 'librari':11 'low':34 'low-level':33 'month':48 'ocr':56 'output':21 'pars':14,54 'pdf':55 'pdfs':23 'provid':27 'python':10,50 'releas':47 'requir':49 'sdk':2,4 'servic':43 'structur':20 'superdoc':1,3,40,60 'version':45","created_at":"2026-06-07T13:00:31.017744+00:00","updated_at":"2026-06-07T13:00:31.017744+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":null,"github":null,"docs":null,"changelog":null,"pypi":null,"npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["ai-ml","devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-08-02","install_tag":null}}