> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heify.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Heify is an AI-powered audio intelligence platform. Turn voice recordings into structured data, quality scores, and deep analytics — automatically.

Heify processes voice recordings — calls, meetings, interviews, training sessions — and converts them into structured data, quality metrics, and actionable insights. It's not just a transcription tool: it's a full conversation analysis system that listens, understands, extracts, evaluates, and reports — all configurable without code.

## The Heify Pipeline

Every recording flows through a modular pipeline. Each component is independent and optional — combine them as your use case requires.

<CardGroup cols={2}>
  <Card title="Configurations" icon="gear" href="/api-reference/configuration/create">
    The core template. Defines what to extract from audio: structured fields, AI summary, custom vocabulary, language, and webhooks. Required for every transcription.
  </Card>

  <Card title="Evaluators" icon="clipboard-check" href="/api-reference/evaluators/create">
    Quality-scoring rubrics. Define weighted criteria — Heify scores every conversation against them automatically and flags critical failures.
  </Card>

  <Card title="Participants" icon="user" href="/api-reference/participants/create">
    Person profiles — support agents, job candidates, salespeople, or any individual. Attach a participant to track their performance across transcriptions over time.
  </Card>

  <Card title="Transcriptions" icon="microphone" href="/api-reference/transcription/submit">
    The result. Full transcript with speaker labels, extracted fields, AI summary, evaluation score — all in one object.
  </Card>
</CardGroup>

<Note>
  Only a **Configuration** is required. Evaluators and Participants are optional layers you activate when you need quality scoring or per-person performance tracking.
</Note>

***

## Two Ways to Use Heify

### Heify API

A programmatic interface for developers. Integrate transcription, extraction, quality scoring, and analytics directly into your applications and workflows.

**Key capabilities:**

* **Manage all modules** — create, update, and delete Configurations, Evaluators, and Participants programmatically
* **Submit audio via URL or direct upload** — public URL or presigned S3 upload
* **Extract structured fields** from conversations using AI — define any schema you need
* **Automatic AI summaries** with custom instructions per configuration
* **Quality scoring** — attach an Evaluator to score every call automatically
* **Per-person tracking** — attach a Participant (agent, candidate, salesperson) to build individual performance analytics
* **Webhooks** — get notified the moment a transcription completes or fails
* **Analytics endpoints** — AI-powered corpus analysis across configurations, evaluators, and participants

### Heify Sandbox

A browser-based interface for business teams, QA analysts, and anyone who wants to explore Heify without writing code.

**Key features:**

* **No-code configuration builder** with extraction field templates and quick-action shortcuts
* **Drag & drop audio upload** or paste a URL — results appear in minutes
* **Evaluator designer** — build quality rubrics with weighted criteria visually
* **Participant management** — register agents, candidates, or any person and track their performance over time
* **AI Analytics dashboards** — patterns, anomalies, correlations, and rankings across your entire call corpus
* **Workflow groups** — organize transcriptions into Pending Review, Under Review, or Archived
* **Team access** — admins can invite collaborators who access the same workspace via OTP
* **PDF export** — download full transcription reports and analytics dashboards

***

## API Overview

The Heify API is organized around these principles:

* **JSON-based**: All requests and responses use JSON format
* **HTTP methods**: All endpoints use `POST`
* **API Key authentication**: Secure access with API keys via the `x-api-key` header
* **Rate limiting**: Fair usage policies applied per endpoint to ensure service stability

<Note>
  **Base URL**: `https://api.heify.com`
</Note>

***

## Explore the Docs

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Your first transcription in minutes — Sandbox or API, your choice
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    API Keys, passwordless login, and session management
  </Card>

  <Card title="Configurations API" icon="gear" href="/api-reference/configuration/create">
    Create and manage reusable processing templates
  </Card>

  <Card title="Transcriptions API" icon="microphone" href="/api-reference/transcription/submit">
    Submit audio and retrieve full results
  </Card>

  <Card title="Evaluators API" icon="clipboard-check" href="/api-reference/evaluators/create">
    Build quality-scoring rubrics and audit conversations at scale
  </Card>

  <Card title="Participants API" icon="user" href="/api-reference/participants/create">
    Track individual performance (agents, candidates, salespeople) across transcriptions and evaluators
  </Card>
</CardGroup>
