API Reference

Endpoint-by-endpoint reference for the Beyou REST API, grouped by controller, with the OpenAPI contract for each one.

• Authentication Controller API

  API endpoints for user authentication, registration, password reset, and OAuth.

• Auth Verification Controller API

  Issues and consumes the e-mail verification token that unlocks login.

• User Controller API

  API endpoints for managing user profile, preferences, and settings.

• User Photo Controller API

  Uploading a profile photo, removing it, and serving it back only to a signed URL.

• User Export Controller API

  The account's full data export.

• Category Controller API

  API endpoints for managing categories of habits, tasks, and goals.

• Habit Controller API

  API endpoints for managing habits, their checks, and progress.

• Task Controller API

  API endpoints for managing tasks, including one-time and recurring tasks.

• Goal Controller API

  API endpoints for creating, updating, and tracking goals.

• Routine Controller API

  API endpoints for diary routines, sections, and schedule.

• Schedule Controller API

  API endpoints for scheduling routines on specific days.

• Snapshot Controller API

  Immutable daily routine snapshots and late check-ins with XP decay.

• Check History Controller API

  Per-day check outcomes for habits, tasks, routines, and the account.

• XP History Controller API

  Per-day XP series for the user, categories, habits, and routines, dense over the requested window.

• AI Agent Controller API

  Agent chat CRUD and the SSE streaming endpoint behind the assistant.

• Onboarding Controller API

  Typed AI suggestions for each step of the onboarding wizard.

• Feedback Controller API

  API endpoints for submitting user feedback with image attachments, and for admin triage and replies.

• Feedback Admin Controller API

  Admin-only triage: list, read, reply to, and update feedback.

• Architecture Docs Controller API

  API endpoints for retrieving architecture documentation topics.

• Blog Docs Controller API

  API endpoints for retrieving blog posts and topics.

• API Docs Controller API

  API endpoints for retrieving API documentation topics.

• Project Docs Controller API

  API endpoints for retrieving project documentation topics.

• Search Docs Controller API

  Cross-area documentation search with match highlights.

• Docs Import Controller API

  API endpoints for importing documentation from GitHub repositories.

• Notification Preferences Controller API

  The engagement-mail switch, and the unsubscribe link's public endpoint.