Skip to main content
This page is the single entry point to the @statisfy/digital-workers-react reference. Each link below is the Markdown form of the page, so an AI coding agent can fetch it directly instead of parsing rendered HTML. Drop the .md for the human-readable version. If you are editing a Statisfy-hosted Portal, the SDK is installed for you at build time and is not checked into the portal’s repository — these pages are the only reference for what a component accepts.

​
Reference pages

  • Overview — what the SDK does, and the two auth models: vendored (your backend signs the token, passed in via getToken) vs portal (the browser exchanges the tenant’s IdP JWT).
  • Getting started — install, mint a session token, wrap the app in StatisfyProvider, render a first DigitalWorkerChat.
  • Digital Worker chat — DigitalWorkerChat and OnboardingModule props, configId config mode, autoKickoff / kickoffPrompt, inline forms, and the headless client.
  • Project module — ProjectModule, the headless useProject hook, every composable primitive’s exact props (TaskList, MilestoneJourney, TaskDetail, Comments), and useComments.
  • Portal runtime config — portal.runtime.json shape, literal values vs per-customer {"$field": …} references, useResolvedFields, isFieldRef, fetchResolvedFields.
  • API reference — endpoints, auth headers, error codes, TypeScript types, useStatisfyConfig.
These are the v0 pages, matching the current 0.x SDK. This index stays at /sdk/llms.md across versions, so it is safe to bookmark or hardcode.

​
Before you write component code

Do not guess a prop name or an export. A portal builds with vite build and no type-check step, so an invalid prop compiles cleanly and then fails in the end user’s browser — nothing catches it at save time. Take prop names from the pages above, or copy the usage already in the portal’s src/ (for example src/App.tsx) and change only what the task needs. For documentation outside the SDK, the full site index is at https://help.statisfy.com/llms.txt.