Overview
Build websites, server integrations and custom apps on the uidu platform.
The uidu SDK gives you typed access to everything a uidu workspace holds — its CMS, forms, events, contacts, people, goals and more — from TypeScript, React and the terminal.
What are you building?
A public website
A site, blog, careers page or event listing rendered from uidu, with forms that write back. Public token for reads, a server action for writes.
A server integration
An internal dashboard, a sync job, a provisioning script — reading and writing the workspace's private data from a server you control.
An app inside uidu
An app members open inside a uidu Space. It acts as the signed-in member, with no token to configure, and keeps its own data in Models.
Each path is a step-by-step guide. The rest of the docs back it up: Foundations explain what applies everywhere (authentication, the data model, writes, errors), the Domains pages cover one area of uidu each, and Reference lists every export.
With an AI assistant
Every page has a Markdown version — add .md to its URL, or use Copy Markdown / Open in
Claude at the top of the page. For an agent working on your code:
/llms.txt— the index of these docs, one line per page, linking the Markdown versions./llms-full.txt— every page in one file./sdk-manifest.json— every export of the SDK with its domain, auth, signature and CLI command, generated from the source.https://developers.uidu.org/mcp— the same docs as MCP tools (search, read a page, look up a function). See Docs MCP server to connect Claude, ChatGPT or Cursor.
Packages
| Package | What it is | Reference |
|---|---|---|
@uidu/client | Typed GraphQL client. Framework-agnostic, server-first, no React dependency. | 177 exports — reference |
@uidu/react | React provider, hooks and components on top of @uidu/client. | 14 exports — reference |
@uidu/app-bridge | The browser half of a custom app running inside uidu: handshake + session token. | 8 exports — reference |
@uidu/cli | The uidu command: read and author a workspace from the terminal, built for AI agents. | 32 entities — commands |
create-uidu-app | Scaffolds a new uidu-powered app. | npx create-uidu-app |
@uidu/skills | Agent skills (Claude Code, Cursor…) for building on uidu. | npx skills add uidu-org/api.js |
What the SDK covers
Every domain @uidu/client can read or write, generated from the source. Each links to its guide;
the client reference lists every function with its auth and CLI command.
What the platform can do that the SDK doesn't cover yet is on the Roadmap.
- Client & utilities —
createClient,fromBridge,normalizeFieldValueContent,normalizeFieldValuesAttributes,paginate - CMS — Sites · CLI:
sites—createSite,getPageBySlug,getSingletonBlock,getSite,getSiteByDomain,listSitePages - CMS — Projects (legacy) · CLI:
projects—createFieldValue,createPage,createPageBlock,createProject,getPage,getTemplate,listPages,listProjects - Stories · CLI:
stories—createStory,getStory,listStories,updateStory - Help center · CLI:
channel—createChannel,deleteChannel,getChannel,listChannels,updateChannel - Knowledge base · CLI:
kb-collections,kb-articles—createKbArticle,createKbCollection,deleteKbArticle,deleteKbCollection,getKbArticle,getKbCollection,listKbArticles,listKbCollections,updateKbArticle,updateKbCollection - Search —
search - Forms · CLI:
forms—createForm,createFormResponse,deleteForm,getForm,listForms,updateForm,updateFormResponse - Events · CLI:
events,attendances—createAttendance,createEvent,getEvent,listEvents,updateEvent - Donations · CLI:
donations—createDonation,createDonationCampaign,deleteDonationCampaign,getDonationCampaign,listDonationCampaigns,updateDonationCampaign - Courses · CLI:
courses—createCourse,deleteCourse,getCourse,getEnrollment,getLecture,listCourses,listEnrollments,listLectures,updateCourse - Calls · CLI:
calls—getCall,listCalls - Jobs & applications · CLI:
jobs,applications—completeApplication,createApplication,getJob,listApplications,listJobs,updateApplication - Contacts & deals · reads need Bearer · CLI:
contacts,deals—createContact,createDeal,deleteContact,getContact,getDeal,listContacts,listDeals,updateDeal - Campaigns · reads need Bearer · CLI:
campaigns—getCampaign,listCampaigns,listEmailCampaigns - People (HR) · reads need Bearer · CLI:
employees,employments,offices,roles,ccnls,time-clocks,compensations,benefits,benefit-enrollments—contractEvents,createBenefit,createBenefitEnrollment,createCcnl,createCompensation,createEmployee,createEmployment,createTimeClock,deleteCompensation,deleteEmployment,getEmployee,listCcnls,listCircles,listEmployees,listEmploymentHistory,listKinds,listOffices,listRoles,terminateEmployment,updateCompensation,updateEmployee,updateEmployment,weekStartFor - Goals (OKRs) · reads need Bearer · CLI:
goals,timeframes—getGoal,goalProgress,goalTimeElapsed,goalValue,isGoalBehind,listGoals,listTimeframes,toGoalRaw,updateGoal - Spaces, tasks & notes · CLI:
tasks,notes,spaces—createNote,createSpace,createTask,deleteNote,deleteSpace,deleteTask,updateNote,updateSpace,updateTask - Bookings & calendars · reads need Bearer · CLI:
bookings—getBooking,getCalendar,getCalendarEvent,listBookings,listCalendarEvents,listCalendars - Models (custom data) · reads need Bearer —
createField,createFieldOption,createModel,createModelItem,deleteField,deleteFieldOption,deleteFieldValue,deleteModelItem,ensureModel,getModel,getModelItem,listModelItems,listModels,toFieldValuesAttributes,updateField,updateFieldOption,updateFieldValue,updateModel,updateModelItem - Provisioning & actions —
createWorkspace,executeAction,generateWorkspaceApiCredentials