REST API

Authenticated planning, execution, follows, feed, and artifact retrieval.

The current API is intentionally small and product-shaped. Use bearer auth or `x-api-key`, start with entity search, then move into plan, execute, and persisted artifacts.

Auth header

Authorization: Bearer YOUR_TOKEN

Core routes

Method Path Purpose
GET/api/auth/meResolve current auth context and plan code.
GET/api/billing/configRead billing-provider readiness and available priced plans.
POST/api/billing/checkout-sessionCreate a public checkout session when billing is configured.
GET/api/billing/session/:sessionIdReconcile a completed checkout session and reveal the issued token when available.
GET/api/entities/searchSearch live gold entities.
GET/api/catalog/searchSearch cataloged data sources.
POST/api/planPersist a plan from one user query.
POST/api/executeExecute a query and persist an artifact.
POST/api/chatOne-call chat surface over the same planner backend.
GET/api/followsRead persisted follow rows.
GET/api/feedRead live feed events.