Skip to content

API Reference

The Convergio AI API is a REST API built on Express 5. It accepts JSON request bodies and returns JSON responses. Full OpenAPI 3.0.3 documentation is available at /api-docs when the server is running.

Base URL:

http://localhost:3001/api

Production (via Netlify proxy):

https://convergioai.netlify.app/api

Authentication

Most endpoints use JWT Bearer authentication. See Authentication for details.

Authorization: Bearer <jwt_token>

Endpoint groups

Section Endpoints Auth Description
Authentication 5 Mixed Register, login, refresh, logout, profile
Emails 4 No Email CRUD, AI analysis
Tasks 4 No Task management
AI 6 No Model selection, content generation, chat, intelligence
Calendar 12 No Events, Cal.com sync, meeting detection
Settings 25+ JWT Profile, security, billing, tokens
StreamBoost 10+ No Stream state, captions, credentials, milestones
Error Handling — — Status codes and error format

Quick reference

# Health check
curl http://localhost:3001/api/health

# Login
curl -X POST http://localhost:3001/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "demo@digitechnomads.com", "password": "demo123"}'

# List emails
curl http://localhost:3001/api/emails?tag=Hello&limit=10

# Dashboard stats
curl http://localhost:3001/api/stats