Docs
Documentation is being written
Only the catalog guide is written as a docs page so far. The sections below are the ones that will exist. Where this site already covers a section, the card links to that page, and each API serves its own description; the rest say they are coming.
Sections
What the docs will cover
Quickstart
From an empty repository to a published config: the skills or the CLI, uc init, an SDK and a publish to dev.
On this site
Concepts
Profiles, events, segments, slots, experiences, flags and how a decision is made. Written as reference pages, one concept each.
Coming
SDKs
The web, server and Astro SDKs: setup, consent, identity, slots and fallbacks. The developers page has a snippet for each.
On this site
CLI and config
The uc commands, the config file and which objects code owns and which the console owns.
On this site
MCP and agent skills
The skills that teach a coding agent to set up tracking, and the MCP server that lets it read and propose changes.
On this site
Catalog
Declare item types, upload a catalog by API, uc catalog, MCP or a bulk NDJSON or CSV import, and recommend from it with catalog slots.
Built
Architecture
How UserCurrent is built on Cloudflare: the edge, live profiles, queues, the event lake and where AI runs.
On this site
GET /v1/openapi.json
Runtime API
What your site, app and server call on the edge: send events, decide slots and flags (with the progressive response), read the kill list in force, alias ids, set accounts and read collection settings. The edge serves its OpenAPI 3.1 description at this path, without a key.
Served by the API
GET /api/v1/openapi.json
Control API
The REST API behind the console, the CLI and the MCP server: organizations and keys, projects and environments, config and publishing, approvals, experiments and flags, insights and dashboards, privacy requests and usage. Its OpenAPI 3.1 description is served by the control plane at this path.
Served by the API
API reference pages
Readable reference pages generated from the two descriptions, with example requests.
Coming
Both descriptions are generated from each service's route table and request and response schemas, not written by hand.
Start with the shortest path
Skills or the CLI, a starter config, an SDK and a publish to dev.
Why this button?
It is this page's own suggestion for now. As you read, this site keeps a small profile of who each page is for and what it is about, in your browser, and picks this button from it. Nothing is sent.