API reference
Every value and type exported by @north-light/crouter-sdk, read from the TypeScript compiler.
Every export of @north-light/crouter-sdk, read from the TypeScript compiler at build time and grouped by what it is used for. Types re-exported from @north-light/crouter-api are documented with that package.
Client
Constructing a client, the options it takes, and the authentication and profile calls it exposes.
Crouter, CrouterOptions, AuthStatus, AuthStatusParams, EnsureProfileParams
Nodes
Creating a node, messaging it, cancelling it, and reading the outcome it reports.
NodeCreateParams, NodeOutcomeOptions, ParsedOutcome, MessageParams, CancelParams
Streaming and activity
A node's live event stream and the activity feed built on top of it.
NodeStream, NodeStreamEvent, NodeStreamEventType, NodeStreamEventListener, NodeEventsOptions, ActivityStep, DescribeTool, describeToolDefault, followActivity
Errors
The base error every failed request throws, and its status-specific subclasses.
CrouterError, BadRequestError, AuthenticationError, PermissionDeniedError, NotFoundError, ConflictError, UnprocessableEntityError, RateLimitError, InternalServerError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError
Schemas and request options
Structured-output schemas, the type they produce, and the options accepted by every request.