About EVERYWORD API

EVERYWORD API Documentation v0.1.90

Overview

This comprehensive API documentation provides detailed information about all available endpoints, authentication methods, request/response formats, and implementation examples. The EVERYWORD API is a modern, secure REST API that supports user management, subscription services, and promotional features.

API Features

Secure Authentication: Cryptographically secure opaque tokens with database session management
Multi-Session Support: Users can be logged in from multiple devices simultaneously
Token Refresh: Automatic token renewal with 6-month sliding window refresh tokens
CSRF Protection: Cross-Site Request Forgery protection for all mutation operations
Email Verification: Secure user registration with email verification codes
User Management: Complete user lifecycle management with profile updates
Subscription Integration: Full Stripe integration for subscription management
Coupon System: Promotional code management and validation
Session Management: Advanced session control with device tracking and revocation
RESTful Design: Consistent API design patterns and response formats
Server Resilience: Persistent authentication across server restarts
Comprehensive Error Handling: Detailed error responses with actionable codes

Documentation Sections

🔐 Authentication API

User login, registration, password reset, email verification, and token management.

👥 Session Management

Multi-device session control, session listing, and security management.

👤 User Management

User profiles, account management, and administrative operations.

💳 Subscription API

Stripe integration, subscription management, billing operations, and plan changes.

🎟️ Coupon Management

Coupon creation, validation, discount management, and trial extensions.

🏷️ Promotion Codes

Promotional code creation, application, validation, and campaign management.

🤖 AI Integration

AI model query endpoint for intelligent content generation and responses.

📊 Survey Management

Survey question management, answer submission, user responses, and analytics aggregation.

🔧 Maintenance

System statistics, database information, subscription management, and administrative operations.

Getting Started

To use the API, you'll need to:

Register for an account using the /api/auth/register endpoint
Verify your email with the code sent to your email address
Authenticate using the /api/auth/login endpoint to obtain an access token
Include this token in the Authorization header for subsequent requests
For mutation operations (POST, PUT, DELETE), include the CSRF token in the x-csrf-token header

API Test Console

To test API endpoints directly, visit the API Test Console section.