Start
Architecture
Control plane versus data plane, automatic authorization, and how resources stay named and scoped.
The SDK can look like one object. The API underneath separates who is allowed to change the system from who is allowed to use it.
Control plane and data plane
| Plane | Examples | Credential |
|---|---|---|
| Control | Create an index, change a policy, deploy a function, set a secret | Admin |
| Data | Read a document, run a search, generate a response, upload a file, invoke an exposed function | End-user client |
await ultrahost.search.createIndex("products", config);
await ultrahost.search.query("products", {
text: "running shoes"
});Same namespace. Different permissions.
Authorization is enforced by the API
Every call inherits the caller's project, tenant, and permission context. Developers should not re-implement ownership checks on each request. The SDK can still express an explicit resource-scoped policy when a product needs one.
A React check such as authorization.check() is there to hide a button. The API repeats the check when the delete actually happens. Client-side results are not a security boundary. See Authorization.
Prefer named resources
"products"
"customer-support"
"daily-report"is the application contract. An ARN, a table name, or a bucket URL is an implementation detail Ultrahost keeps inside the platform.
Asynchronous work has one shape
Immediate reads return the resource. Work that can run for a while returns an operation id, a status, and progress. operations.wait() polls that shape for every building block. See Conventions.
The API describes itself
The platform publishes an OpenAPI document that lists every endpoint, schema, auth requirement, permission, error code, capability, and example. The TypeScript SDK is generated from that document, or continuously checked against it.
projects.getCapabilities() is the runtime version of the same idea: a project tells the caller which blocks and features are actually available, so the SDK does not pretend every deployment behaves identically.
An MCP server exposes those same capabilities to coding agents without a second business API. See Coding agents.
Priority
| Priority | Building blocks | Role |
|---|---|---|
| P0 — Foundation | Documents, Auth, Authorization, Files, Functions | A product can store data, identify users, decide access, keep files, and run logic |
| P1 — Intelligence & discovery | Search, Vectors, LLM, RAG | The capabilities that distinguish Ultrahost |
| P2 — Advanced systems | Timeseries, Graph, Cron, Agent sessions, Schemas & ontologies | Specialized products |
P0 is the foundation. P1 is intelligence and discovery. P2 is the specialized systems. The reference covers all 14.
Rules
- Identity and scope. Resources belong to one project. Names, access control, and paths are scoped to that project.
- Explicit creation.
documents.create("projects", data)does not create the collection if it is missing. Provision the collection first so setup stays obvious. - Method names. Use an explicit name when a namespace manages several resource types (
createCollection,createIndex). Use a short name when it manages one (cron.create). - Browser, server, admin. Each operation is safe for React, required on a server, or admin-only. The catalogs in this reference are the full surface, not a browser allowlist.
Packages
Three packages share types and transport, and enforce different credentials:
| Package | Role |
|---|---|
@ultrahost/sdk | Framework-independent TypeScript client |
@ultrahost/react | Hooks and providers |
@ultrahost/admin | Privileged configuration and deployment |
Details are on Packages.