Glossary
Terms that appear in docs, UI, and code. This is the central reference — if a page uses a term without defining it, it should be here.
Pipelines and content
| Term | Definition | ID prefix |
|---|---|---|
| Pipeline | A unit of work: source + processing + output + tone. Re-runnable. | pp_ |
| Source | Where the content comes from. Three possible layers. | — |
| Layer | One of the three ingestion layers: official API, managed ingestion, manual paste. | — |
| Run | An execution of a job. FSM pending → running → succeeded / failed / cancelled. | run_ |
| Post | An ingested item (social post, webpage snapshot, RSS entry). | sp_ for social posts, ws_ for webpage snapshots |
| Decode | Structural analysis of a single post (hook, tone, format, triggers). Emits decode.ready. | — |
| Riff | A draft generated from one source post. The product's verb: to "riff" a pattern. | rf_ |
| Brief | An aggregated synthesis of multiple source posts (up to 50). | bf_ |
| Pattern | The reusable structure the decoder extracts (hook + tone + format + triggers). | pt_ |
| Artifact | Umbrella term for publishable outputs — today: Riffs and Briefs. Not a concrete entity. FSM review → ready → published / discarded. | — |
| Refinement | An action that takes an artifact and produces a child (shorter, change_tone, match_voice, more_punchy). Triggered by POST /artifacts/{parent_id}/refine. Genealogy via parent_id. | — |
| Recipe | A named pipeline + prompt-template combination (generate-riff, generate-brief, decode-post, etc.). | — |
| Inbox | The list of pending + ready artifacts for a pipeline. | — |
Sessions (drafting canvas)
| Term | Definition | ID prefix |
|---|---|---|
| Session (Canvas) | A drafting workspace scoped to one (org, user). Holds snapshotted items, variants and exports. See Sessions. | uuid (no prefix) |
| Session item | An immutable snapshot of an upstream item (social post / webpage / RSS / custom) at selection moment. Changes upstream don't propagate. | uuid (no prefix) |
| Variant | A generation slot in a session: preset + prompt + style + (optional) per-variant LLM credential. Holds one append-only history of rounds. | uuid (no prefix) |
| Round | A single generation output for a variant. Append-only; selecting an older round doesn't delete newer ones. | uuid (no prefix) |
| Preset | A named (prompt, style, typeTag) the user can save and reuse across variants. Built-in presets: social-thread, blog-with-images, long-form, newsletter-section, tldr-brief, custom. | uuid (no prefix) |
| Export | Recorded event when a round is exported as markdown. Backs the EXPORTS 7D KPI on /console. | uuid (no prefix) |
| Activity | Log entry of every UI action and MCP tool call against a session. Drives /console NowFeed. | uuid (no prefix) |
Dashboards
| Term | Definition | ID prefix |
|---|---|---|
| Dashboard | A named collection of widgets in the active workspace. Created by a user, scoped to the org. | uuid (no prefix) |
| Widget | A typed chart (kpi, timeseries, donut, bar, topN, table) backed by a querySpec validated against the dataset catalog. | uuid (no prefix) |
| Dataset | Read-only metric/dimension/filter catalog exposed by the dashboards engine. dashboards_list_datasets returns the catalog. | — |
| QuerySpec | The structured query body of a widget: metric, dimensions, filters, groupBy, timeRange. Validated at write, resolved at execute. | — |
Interfaces
| Term | Definition |
|---|---|
| Workbench | The Next.js UI where the operator views runs, posts, artifacts, sessions and dashboards. |
| CLI | whet — the NPM binary covering install/auth/pipelines/inbox/publish/adapters/credentials. |
| MCP | Model Context Protocol. Whet exposes an MCP server (Streamable HTTP) with tools across core (8), sessions (18) and dashboards (9), plus 2 prompts and 2 resources. |
| Agent-native | A design where every human action has agent parity via CLI and MCP. |
| Workspace | The configuration singleton per organization. One Whet instance = one workspace. |
| Operator | The human (or agent) who operates the workbench. In the REST API it also designates a "tracked account" subscribed by the org. |
Auth + secrets
| Term | Definition | ID prefix |
|---|---|---|
| Agent token | Credential CLI and MCP use against /api/agent/v1 and /api/mcp. Generated on first launch of Whet Desktop and persisted in your OS keychain. | 64-char hex, no prefix |
| Webhook signing secret | Per-customer HMAC secret used to sign inbound webhook deliveries on Basic / Pro. See Webhooks · HMAC verification. | — |
| OAuth credential | A platform account linked via whet auth connect <platform>. Tokens stored encrypted in the backend vault. | uuid (no prefix) |
| Adapter credential | Encrypted secret bundle for an installed adapter. Managed via whet credentials *. | uuid (no prefix) |
ID convention
IDs are opaque: do not parse them, do not assume length, do not extract metadata. If you need to filter by type, use the endpoints that already filter (/pipelines, /runs, /artifacts, /api/sessions, etc.).
Discontinued terms
| Old term | Replacement | Why |
|---|---|---|
| "Picko" / "Picko platform" | Backend (Bun + Elysia) | The Rails platform was retired in U10; the backend is now a Bun service. The /api/picko/* route prefix in whet-app is an internal facade name kept for path stability. |
| "Pattern" as a standalone entity | A property of a structured artifact, not a separate entity. | Simplification. |