Documentation

Everything you need to launch YapMap.

Quickstarts, API docs, security, and compliance resources—updated alongside every release.

Browser extension quickstart

Get your team live in minutes.

Install

  1. Install the extension from the Chrome Web Store (Edge and Brave supported).
  2. Sign in with Supabase magic link or OAuth (Google, Microsoft).
  3. Issue an extension token via the YapMap dashboard or command palette.
  4. Paste token in the extension options page.

Configure

  • Enable auto-highlight capture (optional).
  • Adjust dimensional thresholds (strict, balanced, exploratory).
  • Enable/disable lesson generation per domain.
  • Connect to your Supabase instance for usage analytics.

API reference overview

All endpoints accept JSON, return JSON, and require bearer authentication. Rate limit default: 120 requests / minute / token.

/v1/analyze

Dimensional analysis (formality, tone, function, frequency, region) + confidence + notes.

POST /v1/analyze {"text":"That was lit"} → { "simplified": "...", "usage_dimensions": {...} }

/v1/rewrite & /v1/check

Rewrite register (formal/informal/neutral/regional) and evaluate learner attempts with pass/fix/explain verdicts.

/v1/lesson & /v1/review

Generate mini-lessons and quick review sets. Submit results via /v1/review/submit to update streaks.

Webhooks & integrations

Forward usage events to Slack, Teams, or your BI warehouse.

Available events

  • analysis.created — triggered on analyze completion.
  • lesson.completed — fired when a learner finishes a mini-lesson.
  • review.submitted — includes score, dimensions, streak impact.
  • usage.summary — daily digest for admins.

Sample workflow

Need to trigger a Jira ticket when tone misalignment occurs?

  1. Create a Cloudflare Worker receiving analysis.created.
  2. Check data.confidence_label or usage_dimensions.tone.
  3. Post to Slack or open a Jira issue with recommended rewrite.