Start
Getting started
Create a client, pick the right credential, and make the first call against a named resource.
npm install @ultrahost/sdkA React app also installs @ultrahost/react. A server, deploy script, or trusted agent installs @ultrahost/admin. See Packages.
Create a client
import { createClient } from "@ultrahost/sdk";
const ultrahost = createClient({
projectId: "my-project",
token: userAccessToken
});projectId selects the project. token is the authenticated end user's credential. The client sends that context on every call, so application code does not attach project, tenant, or owner fields by hand.
Choose a credential
| Client | Package | Use it for |
|---|---|---|
createClient() | @ultrahost/sdk | Reads and writes the signed-in user is allowed to make |
createAdminClient() | @ultrahost/admin | Provisioning, secrets, deploys, and other privileged work |
| React hooks | @ultrahost/react | Loading state, cache, and session helpers around the user client |
Create, then use
Production apps create a resource on purpose. A write does not silently create the collection, index, or bucket underneath it.
await ultrahost.documents.createCollection("projects");
const project = await ultrahost.documents.create("projects", {
name: "My Startup",
status: "active",
ownerId: user.id
});The first call is control-plane work and needs permission to provision. The second is ordinary application data. Both use the same namespace. They do not require the same credential. Architecture explains that split.
Where to go next
- Conventions for REST paths, pagination, and long-running work.
- React if the app is a React UI.
- Coding agents if a coding agent will call the SDK.
- Any building block in the sidebar. Each page is split into create, configure, and use.