DashboardOnboarding
Quick Start

API

Read your phrases and matches from your own code with an API key.

API

Programs read your ListeningKit data with an API key made on the dashboard's API tab. The API is read-only: a key can read your plan, your phrases and your matches, and cannot change anything.

curl "https://<your deployment>.convex.site/api/v1/matches?limit=5" \
  -H "Authorization: Bearer lk_api_..."
  • Everything about keys, endpoints, paging, limits and errors is in The API.
  • The earlier mock API this page used to describe is kept as the Legacy mock API.

Quick Start

The full setup walkthrough — platforms, extension, tokens — in under five minutes.

Chrome Extension

Where the ListeningKit extension comes from and how to set it up.

On this page

API