Client SDK

A wrong collection name is a compile error here. So is a wrong where field, and so is a key on create that the collection does not have. The server still checks access and validates the value it receives.

What is on the client

createClient<AppConfig>(config) returns the members below. It also returns crdt, which throws the moment you read it.

Create it

Create the client once and export it. createClient comes from questpie/client. AppConfig is the type codegen wrote, and it is what makes every call typed.

import { createClient } from "questpie/client";

import type { AppConfig } from "#questpie";

export const client = createClient<AppConfig>({
	baseURL:
		typeof window !== "undefined"
			? window.location.origin
			: process.env.APP_URL || "http://localhost:3000",
	basePath: "/api",
});

Then call it from anywhere. The same client runs in a browser, a Bun script, a worker or a test.

import { client } from "@/lib/client.js";

const { docs, totalDocs } = await client.collections.posts.find({
	where: { published: true },
	limit: 10,
});

AppConfig is a type parameter, not a value. Run questpie generate after a schema change and every method moves with it. TypeScript checks the names, and the server still checks access and validates the input.

Configuration

Every request sends credentials: "include", so a session cookie travels with it. Reach for getAuthHeaders when the token rotates, such as a bearer token in a mobile app. It runs fresh on each request, so you never rebuild the client. basePath gains a leading slash if you left it off, and loses a trailing one.

Collection methods

client.collections.<name> carries the methods below. Reads take the full query language. Mutations take a second argument of locale, localeFallback and stage, which goes into the query string. The uploads and the two introspection calls are the exceptions.

update, delete and restore are aliases of the three …ById methods, so on the client they act on one row. The server gives those same names to its bulk operations, so prefer the …ById names. purgeById appears only on collections with soft delete on. Every collection types upload, but the server answers 400 unless the collection called .upload().

Global methods

A global is one row with no id, so client.globals.<name> is a shorter list.

update takes the data object directly, not the { id, data } wrapper that collections use.

Routes and search

Your routes arrive as a nested proxy. Each folder is one dot, and the HTTP method is the leaf that sends the request. client.search holds two methods and talks to your search adapter.

// routes/admin/stats.post.ts
const stats = await client.routes.admin.stats.post({ period: "week" });

const results = await client.search.search({ query: "questpie", limit: 20 });
await client.search.reindex("posts");

Route leaves are get, post, put, patch and delete. A get turns its input into the query string. Any other property is one more path segment, camelCase to kebab-case, so adminStats requests admin-stats. Search hands back { docs, total, facets? }, each doc carrying _collection and _search.

Locale

setLocale rewrites the client's shared headers in place, so it moves every later request on that client. It does not reach a subscription that is already open, because live() builds its topic when you call it. Pass locale in the live options instead.

client.setLocale?.("de"); // sends accept-language: de
client.getLocale?.(); // "de"
client.setLocale?.(); // pass nothing to clear it

All three are typed optional on QuestpieClient, so call them with ?.(). Per-call overrides go in the method options instead, such as find({ locale: "de" }). See Client i18n.

Where each topic lives

Next

Collection methods is the same list again, with a runnable call for each one.