SentientUI developer resources

Every machine-facing surface SentientUI publishes — the REST API and its OpenAPI spec, authentication, webhooks, the MCP server, and the CLI — with the URL for each.

SentientUI REST API

The public management and ingest API. The spec is generated from the running server, so it never drifts from the routes it documents.

Every response carries RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset so a client can self-throttle; a 429 additionally sets Retry-After. Deprecated operations are marked deprecated in the spec and return RFC 8594 Deprecation and Sunset headers for at least 90 days before removal.

Authentication

Every request authenticates with Authorization: Bearer <key>. Which key depends on what you are calling.

curl https://api.sentient-ui.com/v1/mgmt/projects \
  -H "Authorization: Bearer sk_..."

Server-truth commerce

Report revenue from your server rather than the browser, so refunds and fraud never inflate what the optimizer learns.

Authenticate with a secret key, or with a publishable key plus an X-Sentient-Signature HMAC (hex SHA-256 of the raw body, keyed with your conversions secret). Full schemas are in the OpenAPI spec.

Webhooks

Register outbound webhooks per project from the dashboard or the management API. Payloads are signed; signature verification and the event shape are documented under Integrations → Webhooks.

SentientUI MCP server

A first-party Model Context Protocol server that exposes your project data and actions to AI assistants. Streamable HTTP transport, OAuth 2.1 authentication.

# Claude Code
claude mcp add --transport http sentientui https://api.sentient-ui.com/mcp

# claude.ai / ChatGPT — add a custom connector with that URL

# stdio-only clients (Codex, older IDEs)
npx mcp-remote https://api.sentient-ui.com/mcp

# local, with a server key
SENTIENTUI_API_KEY=sk_... npx @sentientui/mcp

Tools

list_projects, create_project, get_project_stats, list_components, get_variant_performance, get_persona_breakdown, get_goal_funnel, list_goals, list_guardrail_events, get_layout_stats, get_insights, refresh_insights, get_variant_brief, get_test_brief, get_integration_guide, create_variant, pause_variant.

SentientUI CLI

The official command-line tool, published on npm as @sentientui/cli. It scripts the whole setup, so an agent or a developer can integrate SentientUI without writing an API client first.

npx @sentientui/cli init      # scaffold into an existing React app
npx @sentientui/cli --help    # all commands

init detects the framework (Next.js App or Pages Router, Vite, Remix, CRA), installs @sentientui/react, writes .env.local, and scaffolds an example component. It does not edit your layout — it prints the wrap snippet, and you must wrap the app in <AdaptiveRoot> yourself, or nothing adapts and nothing is tracked.

It runs with no API key in keyless local mode, returning deterministic simulated decisions. Verify the integration by loading the app with ?sentient_persona=buyer and then ?sentient_persona=deal_seeker — the two should render differently.

Packages

Files for agents

Every page on this site also answers Accept: text/markdown with a markdown representation, so an agent never has to parse the app shell.

When to use SentientUI

Use SentientUI when a website or web app should adapt its interface to each visitor to increase conversion — testing and personalizing component variants (headlines, CTAs, layouts) and section ordering without running a fixed A/B test schedule. Use the MCP server when an assistant needs to read experiment performance (conversion rates, personas, funnels, insights) or create and pause variants for a project.

Do not use SentientUI when the task is unrelated to a SentientUI project or to adaptive/experimentation UI. It has no general web-browsing, product-analytics, or CMS capability beyond a connected SentientUI account.