Documentation

Everything you need to integrate VoxParse into your application. From quick start to advanced features.

Getting Started

🚀
Quick Start
Get your API key and make your first transcription request in under 60 seconds.
🔐
Authentication
API key management, request signing, and session-based dashboard authentication.
⚠️
Error Codes
Complete error reference with HTTP status codes, error IDs, and troubleshooting steps.

Transcription API

🎙️
Create Transcription
Upload audio files, configure analysis features, and receive structured JSON results in a single API call.
🔄
Transcription Modes
Verbatim and polished modes. Choose how your transcript is formatted and processed.
🛡️
PII Redaction
Automatically detect and redact personally identifiable information from transcripts - names, SSNs, credit cards, and more.
🧠
Custom Instructions
Inject custom AI prompts for QA scorecards, compliance checks, and domain-specific analysis.

Analysis Features

🏴
Feature Flags
Toggle individual AI analysis features on or off per request - sentiment, compliance, financials, and more.
🔍
Topic Detection
Automatically identify and classify discussion topics within your calls and meetings.
👥
Entity Detection
Extract named entities - people, organizations, products, dates, and monetary values from transcripts.
Content Moderation
Flag inappropriate language, profanity, or policy violations automatically.
📑
Auto Chapters
Automatically segment calls into titled chapters with summaries and timestamps.
🌐
Translation
Translate transcripts to 50+ languages while preserving speaker labels and timestamps.
📚
Custom Vocabulary
Boost accuracy for industry jargon, product names, and domain-specific terminology.

Jobs & Results

📋
List Jobs
Retrieve all transcription jobs with pagination, filtering by status, and date ranges.
🔎
Get Job Status
Check the status, duration, and metadata of a specific transcription job by ID.
📥
Get Result
Download the full transcription result including text, segments, words, and AI analysis.
📄
Response Schema
Complete JSON schema reference for the AI analysis object, sentiment scores, and structured outputs.
Webhooks
Receive HMAC-signed notifications when transcriptions complete. Async mode, automatic retries, and delivery logs.

Account & Billing

💳
Billing API
Check balance, view top-up history, and manage prepaid credits via the API.
💰
Get Pricing
Retrieve current pricing tiers, per-hour rates and plan details via the API.
⏱️
Rate Limits
Per-endpoint rate limits, retry strategies, and best practices for high-volume usage.
💻
Code Examples
Copy-paste examples in Python, Node.js, PHP, and curl for every endpoint.

Looking for the complete single-page API reference?

View Full API Reference →