Skip to main content

TypeScript SDK reference

Package: @agirails/sdk@4.0.0 · Total symbols: 283 · Source: src/index.ts

Three-tier SDK API: Simple, Standard, Advanced

The TypeScript SDK is tiered to match the depth of integration you need:

TierSymbolsWhen to use
Simple19First integration and most production code: Agent, request, provide, pay()
Standard + Advanced255Production-stable depth: adapters, builders, signers, runtime helpers, orchestrators
Internal9Not part of the public API contract; documented separately if at all

Quick orientation

Two entry points cover most real code:

// Simple: one-shot request / provide, or the long-lived Agent class
import { request, provide, Agent } from '@agirails/sdk';

// Standard: direct adapter / builder usage
import { ACTPClient, CounterOfferBuilder, StandardAdapter } from '@agirails/sdk';

Pick the lowest tier that covers your use case; you can always drop deeper if needed.

See also