API Reference
UserLens Insights is a multi-tenant UX research platform backed by Azure CosmosDB and an Anthropic Claude–powered AI assistant called Scout AI. These API reference documents cover two distinct integration layers: the Scout AI REST API, which exposes 11 endpoints for chat, research synthesis, and artifact generation; and the CosmosDB Service Module, a data access layer documenting 60+ methods across 11 service domains. Both were built from scratch through source code analysis — no prior documentation existed — and organized by domain to match how developers actually navigate and integrate, rather than how the code happens to be structured.
CosmosDB Service Module
Documentation for the cosmosService.js module, which provides a data access layer for Azure CosmosDB in the InsightHub platform. Includes API reference for organizations, teams, projects, participants, documents, synthesis, billing, and feedback management.
Document Comments API
API for managing documents and comments within a project
Feedback API
The Feedback API handles user feedback submissions and admin management of those submissions.
Invitations API
The Invitations API manages team invitation workflows, including verification, acceptance, and listing of pending invitations.
Scout AI REST API
The Scout AI REST API provides endpoints for managing AI agents, including creation, retrieval, updating, deletion, and execution of agents within a project.
Scout AI Client SDK Reference
Comprehensive reference for the ScoutAIClient class, including all methods, parameters, return types, and error handling. Use this guide to understand how to interact with the Scout AI API through the client SDK.