Endpoints
Sign Up
Response —
201 Created
Login
Response —
200 OK
Logout
Refresh Token
200 OK
Check Auth Status
401 if not authenticated.
Forgot Password
Sends a password reset link to the provided email.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Authentication endpoints — sign up, login, token refresh, OAuth
POST /api/auth/signup
| Field | Type | Required | Description |
|---|---|---|---|
username | string | Yes | Min. 3 characters |
email | string | Yes | Valid email |
password | string | Yes | Min. 6 characters |
referralCode | string | No | Optional referral code |
201 Created
{
"user": { "id": 1, "username": "john", "email": "john@example.com" },
"accessToken": "eyJ..."
}
POST /api/auth/login
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email or username |
password | string | Yes | — |
200 OK
{
"user": { "id": 1, "username": "john", "email": "john@example.com" },
"accessToken": "eyJ..."
}
POST /api/auth/logout
POST /api/auth/refresh
200 OK
{ "accessToken": "eyJ..." }
GET /api/auth/check
401 if not authenticated.
POST /api/auth/forgot-password
| Field | Type | Required |
|---|---|---|
email | string | Yes |
GET /api/auth/google/url # Get Google OAuth redirect URL
GET /api/auth/google/callback # OAuth callback (handled by Google redirect)
GET /api/auth/twitter/url # Get Twitter OAuth redirect URL
GET /api/auth/twitter/callback # OAuth callback (handled by Twitter redirect)