Skip to main content
Custral publishes official client libraries on npm. Pick the one that matches where your code runs and which key you hold:

TypeScript SDK

@custral/sdk: the server-side, secret-key (sk_…) client for the /v1 REST API. Records, objects, identity, usage modules, MCP introspection, and webhook verification.

Browser SDK

@custral/js: the browser, publishable-key (pk_…) layer. CustralUsage for metering, one error hierarchy, and the realtime connector.

React SDK

@custral/widget: the chat widget as a React component, plus the headless engine underneath it. Builds on @custral/js.

​
Which one?

There’s also the @custral/cli for working with your workspace from the terminal as yourself, and the widget.js drop-in script for embedding chat with no bundler.
@custral/ui is deprecated. It never contained any UI: it shipped the chat engine and the usage client. Those are now @custral/widget and @custral/js. The APIs are unchanged, so migrating is a rename of the import.

​
Roadmap

  • Python and Ruby SDKs.
  • A workflow-action SDK for hosted custom actions.