SDK reference

bun add @dexby.ai/sdk
# or: npm install @dexby.ai/sdk

The SDK is ESM only. To use a framework provider, also install its framework; see providers.

import { Dexby } from '@dexby.ai/sdk'

export const dexby = new Dexby({ userId: 'user_123' })

OptionsCopy Anchor Link

new Dexby(config) takes one optional object.

ResultsCopy Anchor Link

API request errors are returned through neverthrow results as SdkError. Methods returning ResultAsync<T, SdkError> can be chained with .andThen(...) before awaiting; the first error stops the chain. Constructor validation and exceptions in your callbacks can still throw.

import { Dexby } from '@dexby.ai/sdk'

const dexby = new Dexby({ userId: 'user_123' })

const tools = await dexby
	.createSession({ connectors: ['slack'] })
	.andThen((session) => session.tools())

if (tools.isErr()) throw new Error(tools.error.message)

console.log(tools.value)

Dexby methodsCopy Anchor Link

Every method that returns a ResultAsync also accepts an AbortSignal (as signal in the options object, or as the last argument).

createSession and createConnectLink return a VALIDATION_ERROR without calling the API when neither the call nor the client has a userId. mcpUrl takes the endpoint slug you chose in Distribute → MCP endpoints.

SessionCopy Anchor Link

createSession() resolves to a Session.

A ToolOutcome is { ok: true, result } or { ok: false, error }. The second is a refusal the model reads and acts on, not an SdkError. See Sessions.

ProvidersCopy Anchor Link

A provider turns session tools into one framework's tool type. Pass it as provider. Framework providers need that framework installed next to the SDK (an optional peer dependency). Model API providers return plain definitions without a framework dependency. Install the model client package if your application calls its API directly.

Snippets for each are in frameworks.

ErrorsCopy Anchor Link

An SdkError has code and message, plus issues on VALIDATION_ERROR and choices (the user's accounts) on AMBIGUOUS_CONNECTION. Branch on code. Every code, with the fix, is in errors.

ExportsCopy Anchor Link