You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: USECASES.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,6 +56,9 @@ This document describes fictional but detailed scenarios for using JACS. Each se
56
56
1.**Create a JACS agent.** Locally create and configure the agent (e.g. `jacs init` or Python/Node/Go `create`/`load`). Ensure you have the agent’s public key and identity (e.g. agent ID, public key hash).
57
57
2.**Get an HAI API key.** Obtain an API key from HAI.ai (e.g. https://hai.ai or https://hai.ai/developers). Set `HAI_API_KEY` in the environment or pass it to the registration call.
58
58
3.**Register the agent.** Use the HAI registration flow:
59
+
60
+
> **Note:** The registration functions below (`register_with_hai`, `registerWithHai`, etc.) are provided by the separate [haisdk](https://github.com/HumanAssisted/haisdk) package, not by the core `jacs` library. Install `haisdk` alongside `jacs` for HAI platform workflows.
61
+
59
62
-**Python:** Use the `register_with_hai` example or `register_new_agent()` from `jacs.hai` (see `jacspy/examples/register_with_hai.py` and `jacspy/examples/hai_quickstart.py`). Quick path: `hai_quickstart.py` can create and register in one step.
<p>HTTP object store pointed at <code>HAI_STORAGE_URL</code>. This backend uses <code>object_store::http::HttpStore</code> under the hood — it is a generic HTTP store, not a managed platform.</p>
337
+
<p>For HAI platform registration, attestation, and key discovery, use the separate <ahref="https://github.com/HumanAssisted/haisdk">haisdk</a> package.</p>
<li><strong>Python</strong>: <code>jacs.a2a_server</code> is the clearest full discovery story.</li>
289
289
<li><strong>Node.js</strong>: <code>jacsA2AMiddleware()</code> serves five <code>.well-known</code> routes from Express, but the generated <code>jwks.json</code> and <code>jacs-pubkey.json</code> payloads are still placeholder metadata. <code>listen()</code> is intentionally smaller and only suitable for demos.</li>
290
290
</ul>
291
-
<p>Those gaps are tracked outside the book in <code>docs/missing-features.md</code>.</p>
292
291
<h2id="example-paths-in-this-repo"><aclass="header" href="#example-paths-in-this-repo">Example Paths In This Repo</a></h2>
<p>HTTP object store pointed at <code>HAI_STORAGE_URL</code>. This backend uses <code>object_store::http::HttpStore</code> under the hood — it is a generic HTTP store, not a managed platform.</p>
11732
+
<p>For HAI platform registration, attestation, and key discovery, use the separate <a href="https://github.com/HumanAssisted/haisdk">haisdk</a> package.</p>
<li><strong>Python</strong>: <code>jacs.a2a_server</code> is the clearest full discovery story.</li>
13667
13695
<li><strong>Node.js</strong>: <code>jacsA2AMiddleware()</code> serves five <code>.well-known</code> routes from Express, but the generated <code>jwks.json</code> and <code>jacs-pubkey.json</code> payloads are still placeholder metadata. <code>listen()</code> is intentionally smaller and only suitable for demos.</li>
13668
13696
</ul>
13669
-
<p>Those gaps are tracked outside the book in <code>docs/missing-features.md</code>.</p>
13670
13697
<h2 id="example-paths-in-this-repo-3"><a class="header" href="#example-paths-in-this-repo-3">Example Paths In This Repo</a></h2>
<li><code>HAI_STORAGE_URL</code> - HAI.ai storage service endpoint</li>
18058
18085
</ul>
18059
-
<p><strong>Best for:</strong> Integration with HAI.ai platform services</p>
18086
+
<p>This is an HTTP object store backend. Full HAI platform workflows (registration, attestation, key discovery) require the separate <a href="https://github.com/HumanAssisted/haisdk">haisdk</a> package.</p>
18087
+
<p><strong>Best for:</strong> Remote document storage via HTTP</p>
<li><code>HAI_STORAGE_URL</code> - HAI.ai storage service endpoint</li>
528
528
</ul>
529
-
<p><strong>Best for:</strong> Integration with HAI.ai platform services</p>
529
+
<p>This is an HTTP object store backend. Full HAI platform workflows (registration, attestation, key discovery) require the separate <ahref="https://github.com/HumanAssisted/haisdk">haisdk</a> package.</p>
530
+
<p><strong>Best for:</strong> Remote document storage via HTTP</p>
0 commit comments