@clawnify/knowledge
v0.1.0
Published
Read your organization's Company Knowledge from a deployed Clawnify app.
Readme
@clawnify/knowledge
Read your organization's Company Knowledge from a deployed Clawnify app, so the app does not ask its user to retype what the org already wrote down.
import { offering } from "@clawnify/knowledge";
// In a server route, before an AI call that needs to know what the org sells.
const settings = await getSettings(c.env);
const pinned = settings.about ? null : await offering(c.env);
const about = settings.about || pinned?.body || "";offering(env) returns the document the org pinned as "what we sell" in
Settings → Brand, or null:
| Returns | When |
|---|---|
| { id, title, version, published_at, body, url } | A published document is pinned |
| null | No token (the app runs outside Clawnify), nothing pinned, or the pinned document is a draft, archived, or flagged outdated |
| throws ClawnifyKnowledgeError | The call failed (unauthorized, network_error, redirect_refused, …) |
null means "fall back to your own field", which is why an open-source app
keeps its settings field: deployed anywhere else, the field is the only source.
Treat the app's own field as an override when it is filled, and show where the
text comes from when it is not (Per ${title} v${version}, linking to url).
Configuration
CLAWNIFY_TOKEN is injected into every app Clawnify deploys. Never expose it in
browser code. An OAuth bearer also works, with optional CLAWNIFY_ORG_ID to
select the organization. CLAWNIFY_API_URL overrides the HTTPS origin;
localhost HTTP is allowed for development.
The token is one per organization and shared by its apps, so a pinned document is readable by every app in the org. Only documents pinned for apps are served.
