Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.profclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
POST /api/auth/signup

Create a new account with email and password. Rate limit: 5 requests / 60 seconds 
curl -X POST http://localhost:3000/api/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "SecurePassword1",
    "name": "Alice",
    "inviteCode": "abc123"
  }'
Request body
FieldTypeRequiredNotes
emailstringYesValid email, max 255 chars
passwordstringYesMin 8 chars, must contain letter and number
namestringYesMax 100 chars
inviteCodestringNoRequired when registrationMode is invite
Response 200 
{
  "user": { "id": "usr_01", "email": "user@example.com", "name": "Alice", "role": "user" },
  "message": "Account created successfully"
}
Sets profclaw_session cookie (httpOnly, 30-day expiry).

​
POST /api/auth/login

Sign in with email and password. Rate limit: 10 requests / 60 seconds 
curl -X POST http://localhost:3000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "SecurePassword1"}'
Response 200 
{
  "user": { "id": "usr_01", "email": "user@example.com", "name": "Alice" },
  "message": "Logged in successfully"
}

​
POST /api/auth/logout

Invalidate the current session. 
curl -X POST http://localhost:3000/api/auth/logout --cookie "profclaw_session=<token>"
Response 200: { "message": "Logged out successfully" }

​
GET /api/auth/me

Get the current authenticated user. 
curl http://localhost:3000/api/auth/me --cookie "profclaw_session=<token>"
Response 200 
{
  "authenticated": true,
  "authMode": "cloud",
  "user": {
    "id": "usr_01",
    "email": "user@example.com",
    "name": "Alice",
    "role": "user",
    "connectedAccounts": ["github"],
    "hasGitHubToken": true
  }
}
Response 401 (unauthenticated): 
{ "authenticated": false, "authMode": "local" }

​
PATCH /api/auth/me

Update the current user’s profile. 
curl -X PATCH http://localhost:3000/api/auth/me \
  -H "Content-Type: application/json" \
  --cookie "profclaw_session=<token>" \
  -d '{"name": "Alice B.", "timezone": "America/New_York"}'
Request body (all fields optional): name, avatarUrl, bio, timezone, locale, onboardingCompleted

​
GitHub OAuth

GET /api/auth/github           # Redirect to GitHub
GET /api/auth/github/callback  # OAuth callback (sets session cookie)
GET /api/auth/github/url       # Get authorization URL for SPA
POST /api/auth/github/token    # Exchange code for session (SPA)

​
Jira / Linear OAuth

GET /api/auth/jira             # Redirect to Jira
GET /api/auth/jira/callback    # Jira OAuth callback
GET /api/auth/linear           # Redirect to Linear
GET /api/auth/linear/callback  # Linear OAuth callback

​
POST /api/auth/verify-access-key

Verify an access key in local auth mode to create a session. 
curl -X POST http://localhost:3000/api/auth/verify-access-key \
  -H "Content-Type: application/json" \
  -d '{"key": "your-access-key"}'
Response 200: { "success": true, "message": "Access verified" }

​
PUT /api/auth/access-key

Set or clear the access key (admin only, local mode only). 
curl -X PUT http://localhost:3000/api/auth/access-key \
  -H "Content-Type: application/json" \
  --cookie "profclaw_session=<admin-token>" \
  -d '{"key": "new-access-key"}'
Pass "key": null to remove the access key requirement.