Reference

SDKs

The official Python client library for HyperAPI. Handles authentication, retries, and file handling for you. For other languages, call the REST API directly — see Quickstart.

Python SDK

Python 3.9+

httpx

presigned uploads

GitHub

Installation

The Python SDK will be published to PyPI soon. In the meantime, install it directly from GitHub.

git clone https://github.com/hyprbots/hyperapi-sdk
cd hyperapi-sdk
pip install -e .

git clone https://github.com/hyprbots/hyperapi-sdk
cd hyperapi-sdk
pip install -e .

Basic usage

from hyperapi import HyperAPIClient

client = HyperAPIClient(api_key="hk_live_your_key_here")

# Parse a document
result = client.parse("invoice.pdf")
print(result["result"]["ocr"])

# Extract entities
result = client.extract("invoice.pdf")
print(result["result"]["entities"])

# Always close when done
client.close()

from hyperapi import HyperAPIClient

client = HyperAPIClient(api_key="hk_live_your_key_here")

# Parse a document
result = client.parse("invoice.pdf")
print(result["result"]["ocr"])

# Extract entities
result = client.extract("invoice.pdf")
print(result["result"]["entities"])

# Always close when done
client.close()

Available methods

client.parse(file)— Extract raw text via OCR
client.extract(file)— Extract structured entities
client.classify(file)— Classify document type
client.split(file)— Split multi-document PDFs
client.redact(file)— Redact PII from documents
client.process(file)— Parse + extract in one call
client.upload_document(file)— Upload via presigned URL
client.close()— Close the HTTP client