Skip to main content

API Documentation

Complete API reference for the h.work platform.

Base URLsโ€‹

EnvironmentURL
Productionhttps://api.h.work
Staginghttps://api.h852.work

Authenticationโ€‹

All protected endpoints require:

Authorization: Bearer <jwt>

Rate limits: 100 req/min per IP (auth endpoints: 10 req/min).

Endpoint Categoriesโ€‹

CategoryDescriptionPrefix
AuthLogin, registration, 2FA, invites/auth/*
ConversationsMessages, threads, search/conversations/*
Expert QueueReview queue, responses, corrections/expert-queue/*
OrganizationsClient/org management/ops/*, /orgs/*
ChannelsSlack, Email, WhatsApp, Telegram/channels/*
Knowledge BaseKB documents, retrieval (#817/#819/#823)/kb/*
NotificationsAppNotification REST + Socket.io (#915)/notifications/*
BillingLago subscriptions, invoicing (post-#1016/#1069)/client/billing/*, /ops/billing/*, /billing/webhooks/lago
Agentic TasksMulti-step task approval (RIG-backed post-#696)/agentic/*
Tavus AdminTavus replicas + function-call definitions (API module: api/src/tavus/; route prefix renamed to /ops/tavus/* via #1031, with legacy /ops/personas/* returning 308 redirects for ~30 days)/tavus/*, /ops/tavus/function-calls (legacy /ops/personas/function-calls โ†’ 308 redirect)
AdminSuperadmin operations/admin/*
AnalyticsMetrics and reporting/analytics/*

Legacy Route Deprecationโ€‹

LegacyCurrentStatus
/am/* (frontend)/ops/*Frontend redirect in place; API still serves /am/orgs/* etc. โ€” see banner at top of reference.md
/superadmin/* (frontend)/ops/*Frontend redirect in place; API still serves /superadmin/* and /admin/*
/portal/*/client/*Removed 2026-05

See full reference for complete endpoint listing.


Last updated: 2026-06-01 (Pass-2 docs audit sweep โ€” KB/Notifications/Lago categories added; legacy route note qualified frontend-vs-API).