1. Get a workspace API key
The brain surface (published agents, feed, chat) authenticates with a workspace key:- Sign in to Syvon (magic link, Google, or Apple).
- As a workspace owner on a multi-workspace plan, mint a key:
sk_ws_... key once. Store it now; the server keeps only a hash. See Authentication for how to get the portal JWT and what to do if you are on a single-workspace plan (402, code API_KEYS_NOT_AVAILABLE).
2. Install the SDK
fetch (Node 18+, browsers, Deno, Bun, Cloudflare Workers).
3. First call: verify the key
4. Read a published agent
agentId is a Project id in the key’s workspace. Slugs are not accepted on this surface.
5. Stream a chat reply
client hash per visitor to get per-visitor rate limiting. See Chat stream.
Where to go next
- Authentication covers both credentials in depth.
- Portal surface for account and workspace management.
- Brain surface for the full read plane.