Core SDK

Build with CapxulClient in browsers, Node services, scripts, and agents—without React.

@capxul/sdk is the Core SDK product surface. Create a client, then call domain method bundles for authentication, Accounts, payments, Organizations, onboarding, and agent workflows. React is optional: the React package is a separate projection over this client.

import { createCapxulClient } from "@capxul/sdk";

const created = await createCapxulClient({
  publishableKey: process.env.CAPXUL_PUBLISHABLE_KEY!,
  requirement: "counterfactual",
});

if (!created.ok) throw created.error;
const client = created.value;

Choose your path

Create your first client

Learn the factory, OTP flow, and a first Account read.

Solve a task

Authenticate, choose readiness, run in Node, observe failures, or make a payment.

Look up every method

Exact inputs, outputs, errors, examples, React equivalents, and practical availability.

Understand the model

See how one client hides bootstrap, Effect programs, ports, and platform substrate.

The public contract

createCapxulClient accepts a CapxulClientInput with publishableKey, observability?, requirement?, and signer?.
Every method resolves Promise<CapxulResult<T>>.
The client groups methods by domain instead of transport.
Chain configuration comes from bootstrap; methods do not accept a chain ID.
A published type is not automatically an available operation. Methods that return NOT_IMPLEMENTED are identified in capability status.

Import examples use only paths present in the packed npm package. Internal adapter, flow, port, and testing paths are not installable consumer API.