SDKs

Every Norbelys SDK is generated from the same OpenAPI spec the API itself is built from, so they never drift from the platform. Pick your language and go — the API reference shows a ready-to-copy snippet for each endpoint under the TypeScript tab.

TypeScript / JavaScript

@norbelys/sdk on npm — a tiny, fully typed, resource-oriented client.

Python

norbelys on PyPI.

Go

github.com/norbelys-com/sdk-go.

Ruby

norbelys on RubyGems.

All SDKs authenticate the same way as the API: an org-scoped API key (ak_…) or a Clerk OAuth token, sent as Authorization: Bearer ….

TypeScript

The TypeScript SDK is a small, tree-shakeable client with a resource-oriented API (norbelys.people.list()) and full type inference on every parameter and response.

Install

npm install @norbelys/sdk    # or: bun add @norbelys/sdk

Create a client

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

Call the API

Every method returns { data, error } — check error first, then data is fully typed.

const { data, error } = await norbelys.people.list({ limit: 10 });
if (error) {
  throw new Error(error.error.message);
}
console.log(data.data); // Person[]

Examples

await norbelys.people.list({ limit: 20, status: "active" });
await norbelys.people.create({ email: "[email protected]", givenName: "Ada" });
await norbelys.people.find("con_b2n4x8mq1w7e");
await norbelys.people.update("con_b2n4x8mq1w7e", { familyName: "Lovelace" });
await norbelys.people.archive("con_b2n4x8mq1w7e");
await norbelys.people.bulkCreate({ people: [{ email: "[email protected]" }] });

const { data: program } = await norbelys.programs.create({ name: "Q3 outreach" });
await norbelys.programs.enroll(program!.id, { all: true });
await norbelys.programs.launch(program!.id);
await norbelys.programs.pause(program!.id);

await norbelys.groups.create({ name: "Founders" });
await norbelys.groups.members.add("grp_5r8t2w", { personIds: ["con_b2n4x8mq1w7e"] });
await norbelys.segments.create({ name: "Engaged", definition: { match: "all", conditions: [] } });

await norbelys.messages.create({ from: "[email protected]", to: "[email protected]", subject: "Hi", html: "<p>Hey</p>" });
await norbelys.messages.list({ direction: "inbound" });
const { data } = await norbelys.verify.email({ email: "[email protected]" });

const { data } = await norbelys.analytics.query({ query: "program_funnel" });

For anything the resource methods don’t cover, use the typed escape hatch:

await norbelys.raw.GET("/organization");

Source

github.com/norbelys-com/sdk-js

Python

pip install norbelys

import norbelys
from norbelys.rest import ApiException

config = norbelys.Configuration(
    host="https://api.norbelys.com/v1",
    access_token="ak_live_…",
)

with norbelys.ApiClient(config) as client:
    people = norbelys.PeopleApi(client)
    page = people.people_list(limit=10)
    print(page.data)

Source

github.com/norbelys-com/sdk-python

Go

go get github.com/norbelys-com/sdk-go

import (
    "context"
    norbelys "github.com/norbelys-com/sdk-go"
)

cfg := norbelys.NewConfiguration()
cfg.Servers = norbelys.ServerConfigurations{{URL: "https://api.norbelys.com/v1"}}
client := norbelys.NewAPIClient(cfg)

ctx := context.WithValue(context.Background(), norbelys.ContextAccessToken, "ak_live_…")
page, _, err := client.PeopleAPI.PeopleList(ctx).Limit(10).Execute()

Source

github.com/norbelys-com/sdk-go

Ruby

gem install norbelys

require "norbelys"

Norbelys.configure do |c|
  c.host = "api.norbelys.com/v1"
  c.access_token = "ak_live_…"
end

people = Norbelys::PeopleApi.new
page = people.people_list(limit: 10)
puts page.data

Source

github.com/norbelys-com/sdk-ruby

Prefer no SDK?

Every endpoint is a plain HTTPS call with a bearer token — see the API reference for curl examples, or drive it from the terminal with the CLI.

Get started

Reference

TypeScript / JavaScript

Python

Go

Ruby

TypeScript

Examples

Source

Python

Source

Go

Source

Ruby

Source

Prefer no SDK?

TypeScript / JavaScript

Python

Go

Ruby

​TypeScript

​Examples

Source

​Python

Source

​Go

Source

​Ruby

Source

​Prefer no SDK?

TypeScript

Examples

Python

Go

Ruby

Prefer no SDK?