# Subako TypeScript SDK

> The TypeScript SDK for Subako — sessions, streaming, and the tools your own client answers, typed end to end.

## Docs

- [Overview](https://typescript-sdk-docs.subako.ai/): What the Subako TypeScript SDK does, which package you need, and where to start.
- [Quickstart](https://typescript-sdk-docs.subako.ai/quickstart): Create a session on your backend, hand the browser a token, and let the page answer the agent's tool calls.
- [Running on a server](https://typescript-sdk-docs.subako.ai/server-jobs): Using a session from a backend job, with no browser and no session tokens.
- [Clients and authentication](https://typescript-sdk-docs.subako.ai/clients-and-auth): Which client to use, what credential it takes, and when the SDK asks for a new token.
- [React](https://typescript-sdk-docs.subako.ai/react): The provider and the four hooks, and what each of them owns.
- [assistant-ui](https://typescript-sdk-docs.subako.ai/assistant-ui): Drop in a working chat, or build your own thread on the same runtime.

## Sessions

- [The session connection](https://typescript-sdk-docs.subako.ai/sessions/connection): connect() opens a session, keeps its log, and reconnects when the stream drops.
- [Reading the log](https://typescript-sdk-docs.subako.ai/sessions/reading-the-log): What a session's events look like, and how to turn them into a transcript.
- [Sandboxes](https://typescript-sdk-docs.subako.ai/sessions/sandboxes): Reading the Linux instances an agent was granted, and cleaning up the archive one leaves behind.

## Tools

- [Client tools](https://typescript-sdk-docs.subako.ai/tools/client-tools): How your code offers tools to a session and answers the calls an agent makes.
- [Forms](https://typescript-sdk-docs.subako.ai/tools/forms): Let an agent fill in a form and submit it.
- [Navigation](https://typescript-sdk-docs.subako.ai/tools/navigation): Let an agent move the person between your app's pages.

## Workspace

- [Agents](https://typescript-sdk-docs.subako.ai/workspace/agents): Creating an agent and publishing the versions a session binds to.
- [Skills](https://typescript-sdk-docs.subako.ai/workspace/skills): Packaging a skill bundle and pushing new versions of it.
- [Vaults](https://typescript-sdk-docs.subako.ai/workspace/vaults): Storing the credentials the broker uses on an agent's behalf.
- [Keys and access](https://typescript-sdk-docs.subako.ai/workspace/keys-and-access): Minting API keys with the permissions they need, and managing who is in the workspace.

## Reference

- [Pagination](https://typescript-sdk-docs.subako.ai/reference/pagination): How listings page, and the one that does not.
- [Errors](https://typescript-sdk-docs.subako.ai/reference/errors): What the SDK throws, and how to tell the kinds apart.
- [Timeouts, retries and idempotency](https://typescript-sdk-docs.subako.ai/reference/timeouts-and-retries): How long a call waits, when it is retried, and what an idempotency key buys you.
- [Packages](https://typescript-sdk-docs.subako.ai/reference/packages): What each package is for and what it needs.

## Agent resources

- [llms-full.txt](https://typescript-sdk-docs.subako.ai/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://typescript-sdk-docs.subako.ai/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://typescript-sdk-docs.subako.ai/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://typescript-sdk-docs.subako.ai/openapi.json.
- [API catalog](https://typescript-sdk-docs.subako.ai/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](https://typescript-sdk-docs.subako.ai/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://typescript-sdk-docs.subako.ai/sitemap.xml): Every indexable page URL with its last-modified date.