# rails docs

> Developer and agent documentation for the rails platform.

## Documentation

- [Overview](https://docs.rails.sh/markdown/overview.md): What rails is, the two ways to work (agent conversation vs. API/CLI/SDK integration), the platform map, and where to start.
- [Quick Start](https://docs.rails.sh/markdown/quick-start.md): Sign up, create a program, mint an API key, send an event, and read a member's balance — plus the CLI alternative.
- [Authentication](https://docs.rails.sh/markdown/authentication.md): Route-family auth model for integration API keys, operator access, end-user JWTs, agent auth, tier/trial gating, webhooks, and deprecated surfaces.
- [Programs API](https://docs.rails.sh/markdown/programs-api.md): Create and manage loyalty programs: lifecycle, settings, and program-scoped resources.
- [API Reference](https://docs.rails.sh/markdown/api-reference.md): Current backend API surfaces, route inventory, and auth regimes.
- [Events API](https://docs.rails.sh/markdown/events-api.md): Event ingestion, idempotency, transaction.completed conventions, async processing, and CLI smoke tests.
- [Members API](https://docs.rails.sh/markdown/members-api.md): Member identity, external ID lookup, balances, wallet identifiers, member lifecycle (suspend/reactivate), and browser-safe host route patterns.
- [Rules API](https://docs.rails.sh/markdown/rules-api.md): Rules engine concepts, rule lifecycle, conditions, simulation, builder metadata, and operator-auth APIs.
- [Games API](https://docs.rails.sh/markdown/games-api.md): Game runtime and setup APIs for resolve, sessions, actions, experiences, campaigns, and generated session tokens.
- [Campaigns API](https://docs.rails.sh/markdown/campaigns-api.md): Create, target, schedule, and manage campaigns.
- [CLI](https://docs.rails.sh/markdown/cli.md): Command guide for auth, programs, keys, rules, events, members, games, recipes, and the local integration agent.
- [CLI Reference](https://docs.rails.sh/markdown/cli-reference.md): Source-generated command, option, environment, and local-state reference for the rails CLI.
- [Integration Recipes](https://docs.rails.sh/markdown/integration-recipes.md): How reviewed code-generation recipes wire backend routes and frontend components safely.
- [Next.js App Router](https://docs.rails.sh/markdown/nextjs-app-router.md): Existing-app recipe for generating server-owned rails routes and React surfaces in Next.js App Router.
- [Shopify Hydrogen](https://docs.rails.sh/markdown/shopify-hydrogen.md): Hydrogen storefront recipe for Shopify customer identity, balance, campaigns, game sessions, and optional order webhooks.
- [Rule Vendor Actions](https://docs.rails.sh/markdown/rule-vendor-actions.md): Configure rule outcomes that queue durable outbound actions for SFMC, mParticle, Braze, and future webhook runtimes.
- [Generic Webhook Outcomes](https://docs.rails.sh/markdown/webhook-outcomes.md): Draft generic webhook rule outcomes without embedding destination URLs, tokens, or signing secrets in rule config.
- [Braze Rollout Recipe](https://docs.rails.sh/markdown/braze-rollout-recipe.md): Agentic operator rollout recipe for Braze rule outcomes, simulation, snapshots, and live dispatch gates.
- [mParticle Rollout Recipe](https://docs.rails.sh/markdown/mparticle-rollout-recipe.md): Agentic operator rollout recipe for mParticle rule outcomes, simulation, snapshots, and live dispatch gates.
- [Salesforce Marketing Cloud Rollout Recipe](https://docs.rails.sh/markdown/salesforce-marketing-cloud-rollout-recipe.md): Agentic operator rollout recipe for SFMC Journey Builder rule outcomes, simulation, snapshots, and live dispatch gates.
- [SDK Components](https://docs.rails.sh/markdown/sdk-components.md): Platform-agnostic React loyalty components, canonical props, framework guides, and recipe wiring.
- [TierProgress](https://docs.rails.sh/markdown/tier-progress.md): Platform-agnostic React tier progress component contract, framework notes, accessibility, and migration caveats.
- [PointsBalance](https://docs.rails.sh/markdown/points-balance.md): Platform-agnostic React points balance component contract, framework notes, accessibility, and migration caveats.
- [CampaignTiles](https://docs.rails.sh/markdown/campaign-tiles.md): Campaign tile component target based on the SDK offer grid lineage and rails recipe surfaces.
- [SDK API Client Migration](https://docs.rails.sh/markdown/sdk-api-client.md): Split SDK migration notes for reusable React components and the future platform API client.
- [Agent Guide](https://docs.rails.sh/markdown/agent-guide.md): How developers and operators interact with the LangGraph admin agent and the local CLI integration agent.
- [Agent Tools Reference](https://docs.rails.sh/markdown/agent-tools-reference.md): Source-generated tool, safety, endpoint, settings, and agent service API reference.
- [Gamification](https://docs.rails.sh/markdown/gamification.md): Experiences, mechanics, sessions, campaigns, prize pools, and generated app runtime surfaces.
- [Gamification Builder](https://docs.rails.sh/markdown/gamification-builder.md): Builder concepts, mechanics, drafts, publish gates, display config, visual theme, and admin UX status.
- [Experiences](https://docs.rails.sh/markdown/gamification-experiences.md): Experience model, mechanic configs, session policy, runtime surface APIs, and generated app recipe boundaries.
- [Campaigns](https://docs.rails.sh/markdown/gamification-campaigns.md): Campaign model, audience config, budget config, campaign selection, activation, campaign tiles, and agent workflows.
- [Content Intelligence](https://docs.rails.sh/markdown/content-intelligence.md): Generated content, approval queues, content scopes, resolve-time cache behavior, and adaptive difficulty recommendations.
- [Stablecoin Rewards](https://docs.rails.sh/markdown/stablecoin-rewards.md): Reward assets, fake-value settlement, stablecoin modes, and safety gates.
- [Reward Assets](https://docs.rails.sh/markdown/reward-assets.md): Stablecoin reward asset model, modes, award flow, fake-value terminology, and production gates.
- [Issuance And Settlement](https://docs.rails.sh/markdown/issuance-settlement.md): Reward authorization, fake-value settlement lifecycle, idempotency, reserves, liability, and operational safety.
- [Wallets And Custody](https://docs.rails.sh/markdown/wallets-custody.md): Wallet models, deterministic member wallet identifiers, Privy/ERC-4337 assumptions, external wallets, and custody boundaries.
- [Agentic Docs](https://docs.rails.sh/markdown/agentic-docs.md): Markdown, download, llms.txt, and MCP-oriented documentation requirements.

## OpenAPI Specs

- [rails CLI OpenAPI](https://docs.rails.sh/openapi.json)