Installation

A flat-file content engine that reads like a printout and ships like code. Install the client, configure a single object, and start making fully-typed requests. Everything below is copy-paste ready — no scaffolding required.

Configuration

Create a client once and reuse it across your app. The configuration object is fully typed; your editor will autocomplete every field.

1import { createClient } from "@plaintext/core"
2 
3const client = createClient({
4  apiKey: process.env.API_KEY,
5  region: "us-east",
6  timeout: 5000,
7})
8 
9const { data } = await client.query("projects")

Parameters

Response shape

Every successful call resolves to a discriminated union you can narrow safely:

1{
2  "ok": true,
3  "count": 3,
4  "data": [
5    { "id": "prj_8fa2", "name": "Atlas" }
6  ]
7}