MIRAMira|Docs

Getting Started

The Mira API gives you programmatic access to meetings, coaching reports, templates, and team analytics from your Mira workspace.

Subscription Required

The Mira API is available exclusively on Business and Enterprise subscription plans. Pay-as-you-go token purchases do not include API access. Contact your admin to upgrade if you don't have access.

Base URL

All API requests are made to the following base URL. Every endpoint path in this documentation is relative to this base.

text
https://your-domain.com/api/v1

Quickstart

Follow these steps to make your first API call:

  1. Create an API key — Go to Settings → API Keys in your admin dashboard and generate a new key.
  2. Copy the key — You will only see the full key once. Store it securely (e.g. in an environment variable).
  3. Make a request — Use the key as a Bearer token in the Authorization header.

Your First Request

bash
curl -X GET "https://your-domain.com/api/v1/meetings?limit=5" \
  -H "Authorization: Bearer mira_live_xxxxxxxxxxxx"

Response Format

All API responses follow a consistent JSON envelope. Successful responses include a data field, while errors include an error message.

Success Response

json
{
  "data": [ ... ],
  "error": null,
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 142
  }
}

Error Response

json
{
  "data": null,
  "error": "Invalid or missing API key",
  "meta": null
}

Pagination

List endpoints support page and limit query parameters. The maximum limit is 100 items per page. The meta object contains pagination details.

Next Steps