Skip to main content
This guide gets you to a working call against live data.

1. Get a workspace API key

The brain surface (published agents, feed, chat) authenticates with a workspace key:
  1. Sign in to Syvon (magic link, Google, or Apple).
  2. As a workspace owner on a multi-workspace plan, mint a key:
The response contains the raw 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

Zero runtime dependencies; uses the platform 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

Replies arrive as MDX over an NDJSON stream. The agent’s owner is billed for the turn; pass a salted client hash per visitor to get per-visitor rate limiting. See Chat stream.

Where to go next