API Reference

User

Get User Details

  • API Name: Get User Details
  • API Route: GET /api/v1/user/details
  • Request:
    • Auth: Session required
  • What it does: Returns the full profile details of the currently authenticated user, including their name, email, role, and other account information.
  • Returns: The user object { id, name, email, role, ... }. Returns an empty object {} if the user record is not found. 401 if not authenticated.

Get User Plan

  • API Name: Get User Organization Plan
  • API Route: GET /api/v1/user/plan
  • Request:
    • Auth: Session required
  • What it does: Returns the subscription plan for the user's organization (e.g., free, pro, enterprise).
  • Returns: { "plan": "string" }

Get or Create Default Project

  • API Name: Get or Create Default Project
  • API Route: GET /api/v1/user/default-project
  • Request:
    • Auth: Session required
  • What it does: Returns the user's default project. If no default project exists yet, one is created automatically. This is used to bootstrap the personal AI chat workspace for new users.
  • Returns: The default project object.