API Overview

The GuideMode API provides programmatic access to session data, metrics, and analytics.

Base URL

https://your-guidemode-server.com/api

Authentication

All API requests require authentication using an API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://your-guidemode-server.com/api/sessions

Rate Limiting

API requests are rate-limited to:

• 100 requests per minute for authenticated users
• 10 requests per minute for unauthenticated requests

Endpoints

Sessions

• GET /api/sessions - List all sessions
• GET /api/sessions/:id - Get session details
• POST /api/sessions - Create a new session
• DELETE /api/sessions/:id - Delete a session

Metrics

• GET /api/metrics - Get aggregated metrics
• GET /api/sessions/:id/metrics - Get metrics for a specific session

Users

• GET /api/users/me - Get current user
• PATCH /api/users/me - Update current user

API Keys

• GET /api/keys - List API keys
• POST /api/keys - Create new API key
• DELETE /api/keys/:id - Revoke API key

Response Format

All responses are in JSON format:

{
  "data": { ... },
  "meta": {
    "page": 1,
    "perPage": 20,
    "total": 100
  }
}

Error Handling

Errors follow standard HTTP status codes:

• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 429 - Too Many Requests
• 500 - Internal Server Error

Error responses include details:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid session ID"
  }
}