Overview

Complete REST API documentation for Elmo's administrative API.

Elmo provides a REST API for managing brands, prompts, and snapshots programmatically. All endpoints require Bearer token authentication.

Base URL: /api/v1

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API keys are configured server-side via the ADMIN_API_KEYS environment variable.

Browse the available endpoints in the sidebar, grouped by resource:

Brands — manage brand records

Tools — one-shot helpers (e.g. brand analysis) that don't persist anything

Prompts — manage brand prompts

Competitors — manage brand competitors

Snapshots — aggregated analytics snapshots for prompts

Reports — generate and retrieve AI Share of Voice reports

Was this page helpful?