Content API

All content methods live on client.content. They are all async and return a Promise.

TypeScriptCopy
import { Keyset } from "keysetapp";

const client = new Keyset({ apiKey: "pkey_…", cacheTTL: 60000 });

---

Read methods

getAll(options?)

Fetches all remote config entries as a flat key-value map.

TypeScriptCopy
const data = await client.content.getAll();
// { hero_title: "Welcome", show_banner: true, max_retries: 3 }

Pass { typed: true } to receive the full typed response (includes type metadata per entry):

TypeScriptCopy
const typed = await client.content.getAll({ typed: true });
// {
//   hero_title: { value: "Welcome", type: "string" },
//   show_banner: { value: true, type: "boolean" },
// }

Signature

TypeScriptCopy
getAll(options?: { typed?: boolean }): Promise<Record<string, unknown> | TypedContentResponse>

Caching — responses are cached under the key "content" (or "content:typed" when typed: true). Cache is shared across calls.

---

getTypedAll()

Shorthand for getAll({ typed: true }). Returns the full typed response.

TypeScriptCopy
const all = await client.content.getTypedAll();
// Record<string, { value: unknown; type: ContentType }>

Signature

TypeScriptCopy
getTypedAll(): Promise<TypedContentResponse>

---

getTyped(key)

Returns the typed entry for a single key, or null if it does not exist.

TypeScriptCopy
const entry = await client.content.getTyped("hero_title");
// { value: "Welcome", type: "string" } | null

Signature

TypeScriptCopy
getTyped(key: string): Promise<TypedContentEntry | null>

---

getString(key, defaultValue?)

Returns the string value for a key. Accepts entries of type string, url, or image. Falls back to defaultValue (default "") if the key is missing or has the wrong type.

TypeScriptCopy
const title = await client.content.getString("hero_title", "Default Title");

Signature

TypeScriptCopy
getString(key: string, defaultValue?: string): Promise<string>

---

getNumber(key, defaultValue?)

Returns the numeric value for a key. Falls back to defaultValue (default 0).

TypeScriptCopy
const limit = await client.content.getNumber("max_results", 10);

Signature

TypeScriptCopy
getNumber(key: string, defaultValue?: number): Promise<number>

---

getBoolean(key, defaultValue?)

Returns the boolean value for a key — ideal for feature flags. Falls back to defaultValue (default false).

TypeScriptCopy
const enabled = await client.content.getBoolean("dark_mode", false);

if (enabled) {
  enableDarkMode();
}

Signature

TypeScriptCopy
getBoolean(key: string, defaultValue?: boolean): Promise<boolean>

---

getJSON<T>(key, defaultValue?)

Returns the parsed JSON value for a key, typed as T. Falls back to defaultValue (default null).

TypeScriptCopy
interface NavLink { label: string; href: string }

const links = await client.content.getJSON<NavLink[]>("nav_links", []);

Signature

TypeScriptCopy
getJSON<T>(key: string, defaultValue?: T | null): Promise<T | null>

---

getURL(key, defaultValue?)

Returns the URL string for a key (type must be "url"). Falls back to defaultValue (default "").

TypeScriptCopy
const docsUrl = await client.content.getURL("docs_url", "https://docs.example.com");

Signature

TypeScriptCopy
getURL(key: string, defaultValue?: string): Promise<string>

---

getImage(key, defaultValue?)

Returns the image URL string for a key (type must be "image"). Falls back to defaultValue (default "").

TypeScriptCopy
const logoUrl = await client.content.getImage("logo_url", "/default-logo.png");

Signature

TypeScriptCopy
getImage(key: string, defaultValue?: string): Promise<string>

---

Write methods

create(entry)

Creates a new content entry.

TypeScriptCopy
await client.content.create({
  key: "promo_banner",
  value: "Summer sale — 20% off",
  type: "string",
});

Signature

TypeScriptCopy
create(entry: ContentEntry): Promise<KeysetResponse<unknown>>

Cache — invalidates both "content" and "content:typed" cache keys on success.

---

update(key, entry)

Updates an existing content entry by key.

TypeScriptCopy
await client.content.update("promo_banner", {
  value: "Winter sale — 30% off",
  type: "string",
});

Signature

TypeScriptCopy
update(key: string, entry: Omit<ContentEntry, "key">): Promise<KeysetResponse<unknown>>

Cache — invalidates both cache keys on success.

---

delete(key)

Deletes a content entry by key.

TypeScriptCopy
await client.content.delete("promo_banner");

Signature

TypeScriptCopy
delete(key: string): Promise<KeysetResponse<unknown>>

Cache — invalidates both cache keys on success.

---

dashboardList(projectId)

Returns all content entries for a project in the full dashboard format (includes id, createdAt, updatedAt). Intended for admin dashboards.

TypeScriptCopy
const entries = await client.content.dashboardList("proj_abc123");

Signature

TypeScriptCopy
dashboardList(projectId: string): Promise<KeysetResponse<DashboardContentEntry[]>>

Requires a secret key.

---

Content types at a glance