Simbee Documentation

Everything you need to turn user behavior into ranked feeds, smart groupings, and clean analytics — reference, recipes, and the SDKs to get there. Start with Getting Started if you're new.

Guides

Getting Started

Step-by-step tutorial covering users, signals, affinities, feed, clusters, campaigns, and analytics.

Concepts

How each primitive works independently and how they compose into different application patterns.

Authentication

How the SDK uses your API key, how the underlying token exchange works, and how to authenticate raw HTTP calls.

Webhooks

Event catalog, payload schemas, signature verification, and delivery guarantees.

Use Case Recipes

Content recommendation, community matching, marketplace discovery, and more.

API Reference

Interactive reference for all endpoints, generated from the OpenAPI spec.

Error Codes

Standard error response format, HTTP status codes, and retry guidance.

SDKs

Use a typed client in your language of choice. Each SDK takes your API key, exchanges it for a short-lived session token transparently, and refreshes before expiry — you never handle JWTs by hand.

TypeScript

@simbee-io/sdk (npm)

Ruby

simbee-sdk (gem)

Python

simbee-sdk (pip)

Quick start

Install the SDK

# Ruby
gem install simbee-sdk

# Node / TS
npm install @simbee-io/sdk

# Python
pip install simbee-sdk

Initialize with your API key

# Ruby
client = Simbee::Client.new(api_key: ENV.fetch("SIMBEE_API_KEY"))

// TypeScript
const client = new SimbeeClient({ apiKey: process.env.SIMBEE_API_KEY! });

# Python
client = simbee_sdk.Client(api_key=os.environ["SIMBEE_API_KEY"])

Call the API

# All three SDKs share the same surface — pick a user, get their feed.
client.feed.ranked(user_id: "alice")

Calling Simbee from a language without an SDK? See raw HTTP auth — one POST exchanges your API key for a 15-minute JWT.