Skip to main content

​
Welcome to the API Reference

This section provides comprehensive documentation for all WaterrAI API endpoints. The API is organized into core areas:

​
Pre-Setup

Users (Active Workspace)

Start here! Get your active workspace and membership ID required for creating meetings and other APIs

​
Core APIs

Personas

Manage AI personas with personality traits and voice characteristics

Scenarios

Create and manage conversation scenarios with embed support

Meetings

Create meetings from scenarios and manage meeting sessions

Analysis

Get analysis results for meetings and scenarios

Recordings

Access meeting recordings for playback and review

API Secrets

Create and manage API secrets for secure authentication

Transcripts

Access meeting transcripts (sentence transcripts recommended)

​
Authentication

All API endpoints require authentication. You can use either JWT tokens or API secrets: JWT Tokens: 
Authorization: Bearer YOUR_JWT_TOKEN
API Secrets (recommended for automation): 
Authorization: Bearer wai_abc123def456...
API secrets never expire and are ideal for server-to-server communication. See the API Secrets documentation for details.

​
Base URL

All API requests should be made to: 
https://api.waterrai.com

​
Response Format

All API responses follow a consistent format: Success Response: 
{
  "status": "success",
  "data": { ... }
}
Error Response: 
{
  "status": "error",
  "message": "Error description",
  "details": "Additional error details"
}

​
Rate Limits

API rate limits are applied per API token. Check response headers for current rate limit information:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets
Getting Started? Check out our quickstart guide to create your first persona, scenario, and meeting in minutes.