nchhaya commited on
Commit
82dff21
·
verified ·
1 Parent(s): b4d44b8

Add HyperAPI developer landing page

Browse files
Files changed (1) hide show
  1. index.html +228 -18
index.html CHANGED
@@ -1,19 +1,229 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8" />
5
- <meta name="viewport" content="width=device-width" />
6
- <title>My static Space</title>
7
- <link rel="stylesheet" href="style.css" />
8
- </head>
9
- <body>
10
- <div class="card">
11
- <h1>Welcome to your static Space!</h1>
12
- <p>You can modify this app directly by editing <i>index.html</i> in the Files and versions tab.</p>
13
- <p>
14
- Also don't forget to check the
15
- <a href="https://huggingface.co/docs/hub/spaces" target="_blank">Spaces documentation</a>.
16
- </p>
17
- </div>
18
- </body>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
19
  </html>
 
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1">
6
+ <title>HyperAPI by Hyperbots: Document intelligence APIs for finance</title>
7
+ <meta name="description" content="HyperAPI turns invoices, receipts, statements and contracts into validated JSON. Parse, Extract, Classify, Split and Redact endpoints with a free tier.">
8
+ <style>
9
+ :root{--ink:#0f172a;--muted:#475569;--line:#e2e8f0;--bg:#ffffff;--soft:#f8fafc;--brand:#2563eb;--brand2:#0ea5e9;--code:#0b1220;--codeink:#e2e8f0}
10
+ *{box-sizing:border-box}
11
+ html,body{margin:0;background:var(--bg);color:var(--ink);font:16px/1.6 -apple-system,BlinkMacSystemFont,"Segoe UI",Inter,Roboto,Helvetica,Arial,sans-serif}
12
+ a{color:var(--brand);text-decoration:none}a:hover{text-decoration:underline}
13
+ .wrap{max-width:1040px;margin:0 auto;padding:0 24px}
14
+ header.hero{background:linear-gradient(135deg,#0b1220 0%,#13254a 55%,#0c3b6e 100%);color:#fff;padding:64px 0 56px}
15
+ .badge{display:inline-block;font-size:12px;letter-spacing:.06em;text-transform:uppercase;background:rgba(255,255,255,.12);border:1px solid rgba(255,255,255,.25);padding:4px 10px;border-radius:999px}
16
+ h1{font-size:44px;line-height:1.1;margin:18px 0 12px;letter-spacing:-.02em}
17
+ .lede{font-size:19px;color:#cbd5e1;max-width:720px;margin:0 0 28px}
18
+ .cta{display:flex;gap:12px;flex-wrap:wrap}
19
+ .btn{display:inline-block;padding:11px 18px;border-radius:10px;font-weight:600;font-size:15px}
20
+ .btn.primary{background:#fff;color:#0b1220}.btn.ghost{border:1px solid rgba(255,255,255,.4);color:#fff}
21
+ .btn:hover{text-decoration:none;opacity:.92}
22
+ .facts{display:flex;gap:28px;flex-wrap:wrap;margin-top:34px;color:#cbd5e1;font-size:14px}
23
+ .facts b{display:block;color:#fff;font-size:20px}
24
+ section{padding:56px 0;border-bottom:1px solid var(--line)}
25
+ section.alt{background:var(--soft)}
26
+ h2{font-size:28px;margin:0 0 8px;letter-spacing:-.01em}
27
+ .sub{color:var(--muted);margin:0 0 28px}
28
+ .grid{display:grid;grid-template-columns:repeat(auto-fit,minmax(190px,1fr));gap:16px}
29
+ .card{border:1px solid var(--line);border-radius:14px;padding:18px;background:#fff}
30
+ .card h3{margin:0 0 6px;font-size:17px}
31
+ .card code{font-size:13px;color:var(--brand)}
32
+ .card p{margin:8px 0 0;color:var(--muted);font-size:14.5px}
33
+ .price{font-size:13px;color:#0f766e;font-weight:600;margin-top:10px}
34
+ pre{background:var(--code);color:var(--codeink);padding:18px 20px;border-radius:12px;overflow:auto;font:13.5px/1.55 ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;margin:0 0 18px}
35
+ code{font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace}
36
+ .c{color:#94a3b8}.k{color:#93c5fd}.s{color:#86efac}
37
+ table{width:100%;border-collapse:collapse;font-size:15px;background:#fff;border:1px solid var(--line);border-radius:12px;overflow:hidden}
38
+ th,td{text-align:left;padding:11px 14px;border-bottom:1px solid var(--line);vertical-align:top}
39
+ th{background:var(--soft);font-weight:600;font-size:13.5px;color:var(--muted);text-transform:uppercase;letter-spacing:.04em}
40
+ tr:last-child td{border-bottom:0}
41
+ .steps{counter-reset:s;list-style:none;padding:0;margin:0 0 22px}
42
+ .steps li{counter-increment:s;position:relative;padding:0 0 12px 40px}
43
+ .steps li:before{content:counter(s);position:absolute;left:0;top:0;width:26px;height:26px;border-radius:50%;background:var(--brand);color:#fff;font-size:13px;font-weight:700;display:flex;align-items:center;justify-content:center}
44
+ .note{border-left:3px solid var(--brand2);background:#f0f9ff;padding:12px 16px;border-radius:0 10px 10px 0;color:#0c4a6e;font-size:14.5px;margin:0 0 18px}
45
+ .two{display:grid;grid-template-columns:1fr 1fr;gap:24px}
46
+ @media(max-width:760px){.two{grid-template-columns:1fr}h1{font-size:34px}}
47
+ ul.clean{padding-left:18px;margin:0}ul.clean li{margin:0 0 8px}
48
+ footer{padding:36px 0 48px;color:var(--muted);font-size:14px}
49
+ .links{display:flex;gap:18px;flex-wrap:wrap}
50
+ </style>
51
+ </head>
52
+ <body>
53
+
54
+ <header class="hero">
55
+ <div class="wrap">
56
+ <span class="badge">HyperAPI · by Hyperbots</span>
57
+ <h1>Turn financial documents into validated JSON</h1>
58
+ <p class="lede">HyperAPI is a set of document intelligence APIs for invoices, receipts, bank statements, contracts and other finance documents. You send a PDF or image and get back clean text, typed fields, a document type or redacted pages. It works from a backend service, a dashboard or an AI agent.</p>
59
+ <div class="cta">
60
+ <a class="btn primary" href="https://apis.hyperbots.com/dashboard/register" target="_blank" rel="noopener">Get a free API key</a>
61
+ <a class="btn ghost" href="https://apis.hyperbots.com/docs" target="_blank" rel="noopener">Read the docs</a>
62
+ <a class="btn ghost" href="https://apis.hyperbots.com/sandbox" target="_blank" rel="noopener">Try the sandbox</a>
63
+ </div>
64
+ <div class="facts">
65
+ <div><b>5</b>core endpoints</div>
66
+ <div><b>30 pages / mo</b>free, no credit card</div>
67
+ <div><b>$0.001 / page</b>fast parse</div>
68
+ <div><b>Python SDK</b>sync + async, MIT</div>
69
+ </div>
70
+ </div>
71
+ </header>
72
+
73
+ <section>
74
+ <div class="wrap">
75
+ <h2>Five endpoints. Call any of them on its own.</h2>
76
+ <p class="sub">Each endpoint takes a <code>document_key</code> from a single upload, so you can chain them without uploading the file again.</p>
77
+ <div class="grid">
78
+ <div class="card"><h3>Parse</h3><code>POST /v1/parse</code><p>OCR to clean text and markdown with page geometry, line and word boxes, layout regions and table parsing. <code>advanced</code> mode adds per-page structured HTML and markdown.</p><div class="price">from $0.001 / page</div></div>
79
+ <div class="card"><h3>Extract</h3><code>POST /v1/extract</code><p>Typed entities and line items from invoices and receipts. For any other document, pass your own JSON schema.</p><div class="price">$0.05 / page</div></div>
80
+ <div class="card"><h3>Classify</h3><code>POST /v1/classify</code><p>Returns a document type with a confidence score and ranked candidates. You can add your own classes and descriptions.</p><div class="price">$0.05 / page</div></div>
81
+ <div class="card"><h3>Split</h3><code>POST /v1/split</code><p>Breaks a bundled PDF into separate logical documents, with a page range, label and confidence for each.</p><div class="price">$0.05 / page</div></div>
82
+ <div class="card"><h3>Redact</h3><code>POST /v1/redact</code><p>Covers PII with black boxes or replaces it with synthetic values. You can add your own entity types.</p><div class="price">$0.05 / page</div></div>
83
+ </div>
84
+ </div>
85
+ </section>
86
+
87
+ <section class="alt" id="quickstart">
88
+ <div class="wrap">
89
+ <h2>Quickstart</h2>
90
+ <p class="sub">Python 3.9+. The official SDK installs from GitHub.</p>
91
+ <ol class="steps">
92
+ <li>Create a free account and generate a key at <a href="https://apis.hyperbots.com/dashboard/api-keys" target="_blank" rel="noopener">apis.hyperbots.com/dashboard/api-keys</a>. Keys that start with <code>hk_live_</code> are for production and keys that start with <code>hk_test_</code> are for testing.</li>
93
+ <li>Install the SDK and set <code>HYPERAPI_KEY</code>.</li>
94
+ <li>Parse and extract in a single call.</li>
95
+ </ol>
96
+ <pre><span class="c"># install (the package installs as hyperapi-sdk and imports as hyperapi)</span>
97
+ pip install <span class="s">"hyperapi-sdk @ git+https://github.com/hyprbots/hyperapi-sdk.git"</span>
98
+ export HYPERAPI_KEY=hk_test_...</pre>
99
+ <pre><span class="k">from</span> hyperapi <span class="k">import</span> HyperAPIClient
100
+
101
+ <span class="k">with</span> HyperAPIClient() <span class="k">as</span> client: <span class="c"># reads HYPERAPI_KEY</span>
102
+ doc = client.process(<span class="s">"invoice.pdf"</span>) <span class="c"># parse + extract in one call</span>
103
+ print(doc[<span class="s">"result"</span>])
104
+
105
+ text = client.parse(<span class="s">"invoice.pdf"</span>) <span class="c"># OCR text + layout</span>
106
+ kind = client.classify(<span class="s">"bundle.pdf"</span>) <span class="c"># document type + confidence</span>
107
+ parts = client.split(<span class="s">"bundle.pdf"</span>) <span class="c"># page ranges per document</span>
108
+ safe = client.redact(<span class="s">"statement.pdf"</span>, mode=<span class="s">"deidentify"</span>)</pre>
109
+ <div class="note">Don't run <code>pip install hyperapi</code>. That name on PyPI belongs to an unrelated project. Use the GitHub install above.</div>
110
+ <p>For FastAPI, aiohttp or agent loops, use <code>AsyncHyperAPIClient</code> and fan calls out with <code>asyncio.gather</code>. Every endpoint also has a <code>submit_*</code> variant that returns a job for bulk or long-running work. Batches are available through <code>create_batch_from_files</code>.</p>
111
+ </div>
112
+ </section>
113
+
114
+ <section id="rest">
115
+ <div class="wrap">
116
+ <h2>REST, from any language</h2>
117
+ <p class="sub">The flow has three steps: request an upload URL, PUT the bytes, then call any endpoint with the <code>document_key</code>. The key is valid for 24 hours.</p>
118
+ <pre><span class="c"># 1. request a presigned upload URL</span>
119
+ curl -X POST https://apis.hyperbots.com/v1/documents/upload \
120
+ -H <span class="s">"X-API-Key: $HYPERAPI_KEY"</span> -H <span class="s">"Content-Type: application/json"</span> \
121
+ -d <span class="s">'{"filename":"invoice.pdf","content_type":"application/pdf","content_length":184213}'</span>
122
+ <span class="c"># -> {"document_key":"550e8400-...","upload_url":"https://...","expires_in":900}</span>
123
+
124
+ <span class="c"># 2. upload the file to upload_url with an HTTP PUT (no API key needed)</span>
125
+
126
+ <span class="c"># 3. extract structured fields</span>
127
+ curl -X POST https://apis.hyperbots.com/v1/extract \
128
+ -H <span class="s">"X-API-Key: $HYPERAPI_KEY"</span> \
129
+ -F <span class="s">"document_key=550e8400-e29b-41d4-a716-446655440000"</span></pre>
130
+ <div class="two">
131
+ <pre>{
132
+ <span class="s">"status"</span>: <span class="s">"success"</span>,
133
+ <span class="s">"task"</span>: <span class="s">"extract"</span>,
134
+ <span class="s">"model_used"</span>: <span class="s">"HyperLM"</span>,
135
+ <span class="s">"result"</span>: {
136
+ <span class="s">"entities"</span>: {
137
+ <span class="s">"invoice_number"</span>: <span class="s">"INV-2024-0042"</span>,
138
+ <span class="s">"date"</span>: <span class="s">"2024-01-15"</span>,
139
+ <span class="s">"due_date"</span>: <span class="s">"2024-02-15"</span>,
140
+ <span class="s">"vendor_name"</span>: <span class="s">"Acme Supplies Ltd"</span>,
141
+ <span class="s">"total_amount"</span>: <span class="s">"1,250.00"</span>,
142
+ <span class="s">"currency"</span>: <span class="s">"USD"</span>
143
+ },
144
+ <span class="s">"line_items"</span>: [ ... ]
145
+ }
146
+ }</pre>
147
+ <pre><span class="c"># any document, your schema</span>
148
+ curl -X POST \
149
+ <span class="s">"https://apis.hyperbots.com/v1/extract?category=non_financial"</span> \
150
+ -H <span class="s">"X-API-Key: $HYPERAPI_KEY"</span> \
151
+ -F <span class="s">"document_key=..."</span> \
152
+ -F <span class="s">'schema={"patient_name":null,"active":false}'</span>
153
+
154
+ <span class="c"># dense tables and forms</span>
155
+ <span class="c"># add ?parse_mode=advanced (Plus, Pro, Custom)</span>
156
+
157
+ <span class="c"># process asynchronously and get a job id</span>
158
+ -H <span class="s">"X-Async: true"</span></pre>
159
+ </div>
160
+ </div>
161
+ </section>
162
+
163
+ <section class="alt" id="pricing">
164
+ <div class="wrap">
165
+ <h2>Pricing</h2>
166
+ <p class="sub">Start free. Paid plans charge overage to prepaid credits at the per-page rates shown above. Results are cached per document for 24 hours, and cached results are not billed.</p>
167
+ <table>
168
+ <tr><th>Plan</th><th>Price</th><th>Pages / month</th><th>Rate limit</th><th>Highlights</th></tr>
169
+ <tr><td><b>Free</b></td><td>$0</td><td>30</td><td>1 req/min</td><td>All core APIs, fast parse, no credit card</td></tr>
170
+ <tr><td><b>Starter</b></td><td>$1</td><td>300</td><td>10 req/min</td><td>Core APIs, email support</td></tr>
171
+ <tr><td><b>Plus</b></td><td>$25</td><td>10,000</td><td>30 req/min</td><td>Advanced parse, team workspace with 3 seats</td></tr>
172
+ <tr><td><b>Pro</b></td><td>$99</td><td>50,000</td><td>60 req/min</td><td>Priority routing, up to 10 seats, priority support</td></tr>
173
+ <tr><td><b>Custom</b></td><td>Talk to us</td><td>Volume</td><td>Dedicated</td><td>BYOK, IP allowlist, human-in-the-loop review</td></tr>
174
+ </table>
175
+ <p style="margin-top:14px;color:var(--muted);font-size:14.5px">Current prices and promotions are on the <a href="https://apis.hyperbots.com/pricing" target="_blank" rel="noopener">pricing page</a>.</p>
176
+ </div>
177
+ </section>
178
+
179
+ <section id="details">
180
+ <div class="wrap two">
181
+ <div>
182
+ <h2>Inputs and limits</h2>
183
+ <ul class="clean">
184
+ <li>PDF, PNG, JPEG, WebP, TIFF and HEIC, plus Word, Excel, PowerPoint, CSV, TXT, RTF, JSON and XML.</li>
185
+ <li>Uploads up to 50 MB (512 MiB for Custom async).</li>
186
+ <li>Fast parse, Classify and Split have no page cap. Advanced parse and advanced Extract allow 60 pages (500 for Custom async). Redact allows 36 pages.</li>
187
+ <li><code>GET /v1/limits</code> returns the limits that apply to your key.</li>
188
+ </ul>
189
+ </div>
190
+ <div>
191
+ <h2>Data handling</h2>
192
+ <ul class="clean">
193
+ <li>Files are processed in memory and deleted when a run completes, unless you turn on retention.</li>
194
+ <li>Documents are not used for training.</li>
195
+ <li>Redact can remove PII before any downstream model sees the document.</li>
196
+ <li>Hyperbots is SOC 1 Type 2, SOC 2 Type 2 and ISO 27001 certified.</li>
197
+ </ul>
198
+ </div>
199
+ </div>
200
+ </section>
201
+
202
+ <section class="alt" id="research">
203
+ <div class="wrap">
204
+ <h2>Research behind it</h2>
205
+ <p class="sub">HyperAPI runs on Hyperbots' finance-specific models, including HyperLM and in-house vision-language models.</p>
206
+ <div class="grid">
207
+ <div class="card"><h3>DocuLite</h3><p>Adapting LLMs and VLMs to invoice extraction without human-annotated training data, using synthetic data generators (InvoicePy and TemplatePy). Accepted at the 4th Deployable AI Workshop, AAAI 2026.</p><p><a href="https://www.hyperbots.com/research/breaking-the-annotation-barrier-with-doculite" target="_blank" rel="noopener">Read the research →</a></p></div>
208
+ <div class="card"><h3>Synthetic invoice dataset</h3><p>A synthetic invoice set with HTML, OCR-style text and gold labels in the Extract output format. Use it to benchmark HyperAPI or your own pipeline.</p><p><a href="https://huggingface.co/datasets/hyperbots-inc/synthetic-invoice-extraction" target="_blank" rel="noopener">Open the dataset →</a></p></div>
209
+ <div class="card"><h3>Engineering blog</h3><p>Posts on deterministic extraction from financial PDFs, schema-as-contract, and classifying more than 1,400 bank statement templates.</p><p><a href="https://apis.hyperbots.com/blogs" target="_blank" rel="noopener">Read the blog →</a></p></div>
210
+ </div>
211
+ </div>
212
+ </section>
213
+
214
+ <footer>
215
+ <div class="wrap">
216
+ <div class="links">
217
+ <a href="https://apis.hyperbots.com" target="_blank" rel="noopener">apis.hyperbots.com</a>
218
+ <a href="https://apis.hyperbots.com/docs" target="_blank" rel="noopener">Docs</a>
219
+ <a href="https://github.com/hyprbots/hyperapi-sdk" target="_blank" rel="noopener">Python SDK</a>
220
+ <a href="https://apis.hyperbots.com/docs/status" target="_blank" rel="noopener">Status</a>
221
+ <a href="https://huggingface.co/hyperbots-inc" target="_blank" rel="noopener">Hyperbots on Hugging Face</a>
222
+ <a href="https://www.hyperbots.com" target="_blank" rel="noopener">hyperbots.com</a>
223
+ <a href="mailto:hyperapi-support@hyperbots.com">hyperapi-support@hyperbots.com</a>
224
+ </div>
225
+ <p style="margin-top:16px">© 2026 Hyperbots Inc. HyperAPI is a product of Hyperbots Inc.</p>
226
+ </div>
227
+ </footer>
228
+ </body>
229
  </html>