Skip to content

API Reference

Base URL: http://localhost:8000/api/ (dev) — set API_BASE_URL in .env for other envs.

All endpoints require Authorization: Bearer <token> unless marked public.


Auth & Users

Method Path Description
POST /api/auth/login/ Email + password login
POST /api/auth/register/ New user registration
POST /api/auth/token/refresh/ Refresh JWT
GET /api/auth/social/<provider>/ Start social OAuth flow
GET /api/users/me/ Current user profile
PATCH /api/users/me/ Update profile

Documents

Method Path Description
GET /api/docs/ List documents
POST /api/docs/ Create document
GET /api/docs/<id>/ Retrieve document
PATCH /api/docs/<id>/ Update document
DELETE /api/docs/<id>/ Delete document
POST /api/docs/<id>/share/ Share document

Media

Method Path Description
GET /api/media/ List media assets
POST /api/media/upload/ Upload file
GET /api/media/<id>/ Retrieve asset
DELETE /api/media/<id>/ Delete asset

Conversions

Method Path Description
POST /api/convert/image/ Convert image format
POST /api/convert/pdf/ Convert to/from PDF
POST /api/convert/video/ Convert video format

Cloud Integrations

Method Path Description
GET /api/integrations/google/auth/ Start Google Drive OAuth
GET /api/integrations/box/auth/ Start Box OAuth
GET /api/integrations/dropbox/auth/ Start Dropbox OAuth
GET /api/integrations/onedrive/auth/ Start OneDrive OAuth
GET /api/integrations/<provider>/files/ List files from provider
POST /api/integrations/<provider>/sync/ Sync files

Billing

Method Path Description
GET /api/billing/plans/ List subscription plans
GET /api/billing/subscription/ Current subscription
POST /api/billing/subscribe/ Subscribe to a plan
POST /api/billing/cancel/ Cancel subscription

Notifications

Method Path Description
GET /api/notifications/ List notifications
POST /api/notifications/<id>/read/ Mark as read
POST /api/notifications/read-all/ Mark all as read

Note: Paths above are inferred from app names and Django REST patterns. Verify exact paths in indox/config/urls.py and each app's urls.py.