REST API Overview

Explore the Koldan REST API for speech-to-text, AI summarization, real-time streaming management, and more.

REST API Reference

Authentication

Token exchange, refresh, and logout endpoints.

Authentication API
API Keys

Create, list, and revoke scoped API keys.

API Keys API
Users

User profile, preferences, and account management.

Users API
Languages

Query available languages and model-language mappings.

Languages API
Subscriptions

Check your subscription status and browse available plans.

Subscriptions API
Quota

View and manage user and tenant usage quotas.

Quota API
Rate Limits

View rate limit configurations and current usage counters.

Rate Limits API
Files

Upload, list, and manage media files and listening audio derivatives.

Files API
Transcriptions

Create transcription jobs, check status, retrieve results, and export.

Transcriptions API
Streaming Sessions

Access session history, download recordings, and manage session data.

Streaming API
WebSocket Streaming

Real-time speech recognition protocol, message formats, and lifecycle.

WebSocket Reference
Summaries

Generate and retrieve AI-powered summaries from transcriptions.

Summaries API
Translations

Translate transcriptions between supported languages.

Translations API
Prompt Templates

Manage prompt templates for AI summarization.

Prompt Templates API
Models & Aliases

Query available speech models, their capabilities, and model alias resolution.

Models API

Users

Manage user accounts, assign roles and subscriptions, configure quotas and rate limits.

Admin Users
Subscriptions

Create, update, and manage subscription plans.

Admin Subscriptions
Tenants

Create and configure tenants, manage identity providers and tenant settings.

Admin Tenants
Models & Aliases

Register, upload, and manage speech models and model aliases.

Admin Models
Roles

Create and manage system and custom roles with granular permission scopes.

Admin Roles
Rate Limits

Configure and manage rate limit policies across the platform.

Admin Rate Limits
Audit Logs

Query audit trail events for compliance and troubleshooting.

Admin Audit Logs
Impersonation

Impersonate users for support and debugging purposes.

Admin Impersonation

Profiles and Preferences

Manage Koldan Desktop user profiles and application preferences.

Profiles Management
Models and Presets

Configure desktop speech models and transcription presets.

Models and Presets
Logs

Access and manage Koldan Desktop client logs.

Desktop Logs