SDK

The Boost.space SDK is a typed client for the same REST API, in TypeScript and Python. It works with your AgentOS system for everything in the API reference. The ACT automations your agents write use the Python SDK too.

Your agent turns a request into code on the typed Boost.space SDK, which offers it every method

When do I use it?

When you or your agent write code in TypeScript or Python. In any other language, call the REST API directly.

The SDK gives you Instead of
Typed models for modules, spaces, records, fields and the rest. Reading raw JSON.
Pagination you iterate over. A list fetches the next page when you reach it. Counting offset and limit yourself.
Automatic retries. A 429 is retried after its Retry-After. A 5xx or a network error is retried for GET, PUT and DELETE. A POST is never retried, so nothing is created twice. Writing your own backoff.
Typed errors that carry the HTTP status and the API's code. Parsing error bodies.

How do I start?

  1. Create an API token: click your avatar, then API & MCP tokens > New API/MCP token > API Token. See API and MCP tokens.
  2. Install the package:
npm install @boost-space/sdk    # TypeScript
pip install boostspace-sdk      # Python
  1. Make your first call. system is your system name, the first part of its address: https://acme.boost.space is acme.
import { BoostSpace } from "@boost-space/sdk";
const bs = new BoostSpace({ token: process.env.BOOST_SPACE_TOKEN!, system: "acme" });
const space = await bs.spaces.get(42);
for await (const s of bs.spaces.list({ order: "name;ASC" })) console.log(s.name);
from boostspace import BoostSpace
bs = BoostSpace("<your token>", system="acme")
space = bs.spaces.get(42)
for s in bs.spaces.list(order="name;ASC"):
    print(s.name)

Filters and sorting take the same strings as the API. See How do I filter?

How do I sign in?

Way Use it when
A token Your own script or integration. Pass it as token.
A token provider Your token changes over time. Pass a function as token, and the SDK calls it before each request.
OAuth 2.0 Your app acts for other people. The SDK's OAuth2Session runs the flow and refreshes the token before it expires.

The Authentication guide shows each one in both languages.

Where are the full guides?

The SDK is the same for Boost.space and AgentOS, so its guides live in the SDK docs:

Guide What is in it
Authentication Tokens, token providers and OAuth 2.0.
Filtering The full filter grammar with tested examples.
Ordering and pagination Sorting, and iterating over pages.
Errors and retries The error types and when a request is retried.
Relations and expand Moving from a record to the records it links.
Delta sync and bulk Fetching only what changed, and working in batches.

The SDK reference lists every method. Use the ones whose endpoints appear in the AgentOS API reference.