Getting Started
Quickstart
From zero to your first API call in under 5 minutes.
01
Get an API key
Create a free account and generate an API key from your dashboard. Keys are prefixed with hk_live_ for production and hk_test_ for testing.
02
Install the SDK
Install the official Python SDK. Requires Python 3.9+.
pip install hyperapi-sdkpip install hyperapi-sdk03
Make your first call
Parse a PDF document and get back structured text. Replace hk_live_your_key_here with your actual API key.
from hyperapi import HyperAPIClient
client = HyperAPIClient(api_key="hk_live_your_key_here")
result = client.parse("invoice.pdf")
print(result["result"]["ocr"])
client.close()from hyperapi import HyperAPIClient
client = HyperAPIClient(api_key="hk_live_your_key_here")
result = client.parse("invoice.pdf")
print(result["result"]["ocr"])
client.close()Explore the Playground
Try all four APIs interactively in the Playground — upload a file and see the response in real time.
Next steps
- → Read the Parse API reference — request headers, body params, response schema
- → Authentication guide — live vs. test keys, key rotation
- → Error codes — handle 401, 402, 429 and more