Spaces:
Running
Running
Drop pip install instructions; point to quickstart (SDK, REST, MCP)
Browse files- index.html +1 -5
index.html
CHANGED
|
@@ -123,10 +123,7 @@ footer{padding:36px 0 48px;color:var(--muted);font-size:14px}
|
|
| 123 |
<section id="quickstart">
|
| 124 |
<div class="wrap">
|
| 125 |
<h2>Quickstart</h2>
|
| 126 |
-
<p class="sub">
|
| 127 |
-
<pre><span class="c"># the package installs as hyperapi-sdk and imports as hyperapi</span>
|
| 128 |
-
pip install <span class="s">"hyperapi-sdk @ git+https://github.com/hyprbots/hyperapi-sdk.git"</span>
|
| 129 |
-
export HYPERAPI_KEY=hk_test_... <span class="c"># https://apis.hyperbots.com/dashboard/api-keys</span></pre>
|
| 130 |
<pre><span class="k">from</span> hyperapi <span class="k">import</span> HyperAPIClient
|
| 131 |
|
| 132 |
<span class="k">with</span> HyperAPIClient() <span class="k">as</span> client:
|
|
@@ -134,7 +131,6 @@ export HYPERAPI_KEY=hk_test_... <span class="c"># https://apis.hyperbots.co
|
|
| 134 |
kind = client.classify(<span class="s">"packet.pdf"</span>) <span class="c"># label + confidence</span>
|
| 135 |
parts = client.split(<span class="s">"packet.pdf"</span>) <span class="c"># start/end page per document</span>
|
| 136 |
safe = client.redact(<span class="s">"packet.pdf"</span>, mode=<span class="s">"deidentify"</span>)</pre>
|
| 137 |
-
<div class="note">Don't run <code>pip install hyperapi</code>. That PyPI name belongs to an unrelated project. Use the GitHub install above.</div>
|
| 138 |
<pre><span class="c"># any document, your schema (REST)</span>
|
| 139 |
curl -X POST <span class="s">"https://apis.hyperbots.com/v1/extract?category=non_financial"</span> \
|
| 140 |
-H <span class="s">"X-API-Key: $HYPERAPI_KEY"</span> \
|
|
|
|
| 123 |
<section id="quickstart">
|
| 124 |
<div class="wrap">
|
| 125 |
<h2>Quickstart</h2>
|
| 126 |
+
<p class="sub"><a href="https://apis.hyperbots.com/dashboard/register" target="_blank" rel="noopener">Get a free key</a> (30 pages a month, no credit card), set <code>HYPERAPI_KEY</code>, and follow the <a href="https://apis.hyperbots.com/docs/quickstart" target="_blank" rel="noopener">quickstart</a> to use the Python or TypeScript SDK, the REST API or the MCP server.</p>
|
|
|
|
|
|
|
|
|
|
| 127 |
<pre><span class="k">from</span> hyperapi <span class="k">import</span> HyperAPIClient
|
| 128 |
|
| 129 |
<span class="k">with</span> HyperAPIClient() <span class="k">as</span> client:
|
|
|
|
| 131 |
kind = client.classify(<span class="s">"packet.pdf"</span>) <span class="c"># label + confidence</span>
|
| 132 |
parts = client.split(<span class="s">"packet.pdf"</span>) <span class="c"># start/end page per document</span>
|
| 133 |
safe = client.redact(<span class="s">"packet.pdf"</span>, mode=<span class="s">"deidentify"</span>)</pre>
|
|
|
|
| 134 |
<pre><span class="c"># any document, your schema (REST)</span>
|
| 135 |
curl -X POST <span class="s">"https://apis.hyperbots.com/v1/extract?category=non_financial"</span> \
|
| 136 |
-H <span class="s">"X-API-Key: $HYPERAPI_KEY"</span> \
|