Skip to main content

API reference

This section is generated from contracts and limited to external API-key surfaces.

Core pages pair generated schemas with maintained request examples, response examples, usage notes, and links back to workflow docs.

Start here​

  • Quickstart - Recommended SDK-first path to a first successful report.
  • Direct API workflow - Raw HTTP upload -> job -> result flow.
  • Webhooks - Production completion path with signature verification.

Base URL​

https://api.mappa.ai

Auth header​

Use Mappa-Api-Key on every request.

curl https://api.mappa.ai/v1/health/ping \
  -H "Mappa-Api-Key: $CONDUIT_API_KEY"

Resources​

  • Health - Connectivity and service liveness endpoint.
  • Files - Upload and manage media files used in async analysis jobs.
  • Reports - Create report jobs and fetch generated report payloads.
  • Matching - Compare a target to a group with async matching jobs.
  • Jobs - Track, stream, and cancel asynchronous jobs.
  • Entities - List, retrieve, and label workspace-scoped speaker entities.
  • Feedback - Submit feedback for report or matching outputs.