# Speechmatics Docs > Developer documentation for Speechmatics APIs - [Speechmatics Docs](/index.md) ## search - [Search the documentation](/search.md) ## administration ### accounts Sign up, manage sign-in methods, update your profile and security settings, and delete your account. - [Accounts](/administration/accounts.md): Sign up, manage sign-in methods, update your profile and security settings, and delete your account. ### api-keys Create, view, and revoke the API keys that authenticate your applications to Speechmatics. - [API keys](/administration/api-keys.md): Create, view, and revoke the API keys that authenticate your applications to Speechmatics. ### billing Manage your payment card, understand how credits are used, and view and download invoices. - [Billing](/administration/billing.md): Manage your payment card, understand how credits are used, and view and download invoices. ### domain-verification Verify a domain so users from your organization join your workspace automatically. - [Domain verification](/administration/domain-verification.md): Verify a domain so users from your organization join your workspace automatically. ### manage-members Invite users to your workspace, change their roles, and remove access. - [Manage members](/administration/manage-members.md): Invite users to your workspace, change their roles, and remove access. ### management-tokens Automate workspace administration with tokens that create projects and manage API keys programmatically. - [Management tokens](/administration/management-tokens.md): Automate workspace administration with tokens that create projects and manage API keys programmatically. ### plans Understand the Free, Pro, and Enterprise plans and how each one is billed. - [Plans](/administration/plans.md): Understand the Free, Pro, and Enterprise plans and how each one is billed. ### projects Organize work inside a workspace, scope API keys to projects, and track usage per project. - [Projects](/administration/projects.md): Organize work inside a workspace, scope API keys to projects, and track usage per project. ### regions Choose where Speechmatics processes your audio across the available regions. - [Regions](/administration/regions.md): Choose where Speechmatics processes your audio across the available regions. ### security-and-compliance Find Speechmatics security certifications and request compliance documentation. - [Security and compliance](/administration/security-and-compliance.md): Find Speechmatics security certifications and request compliance documentation. ### sso Configure single sign-on for your workspace so users authenticate through your identity provider. - [Single sign-on (SSO)](/administration/sso.md): Configure single sign-on for your workspace so users authenticate through your identity provider. ### usage Track transcription usage by processing mode and model in the portal and through the API. - [Usage](/administration/usage.md): Track transcription usage by processing mode and model in the portal and through the API. ### workspaces-concepts Understand how workspaces organize users, projects, billing, and access on the Speechmatics platform. - [Workspaces concepts](/administration/workspaces-concepts.md): Understand how workspaces organize users, projects, billing, and access on the Speechmatics platform. ## api-ref Browse API reference for Speechmatics APIs - [API reference](/api-ref.md): Browse API reference for Speechmatics APIs ### batch - [Create a new job](/api-ref/batch/create-a-new-job.md): Create a new job - [Delete a job](/api-ref/batch/delete-a-job.md): Delete a job and remove all associated resources. - [Get job details](/api-ref/batch/get-job-details.md): Get job details, including progress and any error reports. - [Get the log file for a job.](/api-ref/batch/get-the-log-file-for-a-job.md): Get the log file for a job. - [Get the transcript for a transcription job](/api-ref/batch/get-the-transcript-for-a-transcription-job.md): Get the transcript for a transcription job - [Get usage statistics](/api-ref/batch/get-usage-statistics.md): Get usage statistics - [List all jobs](/api-ref/batch/list-all-jobs.md): List all jobs - [Speechmatics ASR REST API](/api-ref/batch/speechmatics-asr-rest-api.md): The Speechmatics Automatic Speech Recognition REST API is used to submit ASR jobs and receive the results. The supported job type is transcription of audio files. ### management - [Create an API key](/api-ref/management/create-an-api-key.md): Create an API key in your workspace, authenticated with a [management token](/administration/management-tokens). - [Delete a project](/api-ref/management/delete-a-project.md): Delete a project - [Delete an API key](/api-ref/management/delete-an-api-key.md): Delete an API key - [Get a project by ID](/api-ref/management/get-a-project-by-id.md): Get a project by ID - [Get all API keys](/api-ref/management/get-all-api-keys.md): Get all API keys - [Get all projects](/api-ref/management/get-all-projects.md): Get all projects - [Management API](/api-ref/management/management-api.md): The Management API lets you manage projects and API keys in your workspace programmatically. Authenticate each request with a [management token](/administration/management-tokens), which is scoped to the workspace. - [Post a new project](/api-ref/management/post-a-new-project.md): Post a new project - [Update a project](/api-ref/management/update-a-project.md): Update a project ### realtime-transcription-websocket API Reference for the Realtime Websocket API - [Realtime API Reference](/api-ref/realtime-transcription-websocket.md): API Reference for the Realtime Websocket API ## deployments Learn about the different ways to use our APIs, including cloud services and on-prem containers. - [Overview](/deployments.md): Learn about the different ways to use our APIs, including cloud services and on-prem containers. ### container - [Accessing images](/deployments/container/accessing-images.md): Learn how to access images in the Speechmatics Container system - [Additional security features](/deployments/container/additional-security.md): Learn about the Speechmatics container system security - [Batch persistent worker](/deployments/container/batch-persistent-worker.md): Run a long-lived HTTP transcription worker that accepts multiple jobs without restarting, reducing turnaround time and improving CPU/GPU utilisation. - [CPU Speech to text container](/deployments/container/cpu-speech-to-text.md): Learn about the Speechmatics CPU container system - [GPU Speech to text container (Standard and Enhanced)](/deployments/container/gpu-speech-to-text.md): Learn about the Speechmatics Transcription GPU container system - [GPU Speech to text container (Melia 1)](/deployments/container/gpu-speech-to-text-melia-1.md): Learn about the Speechmatics Melia 1 GPU container system - [Translation GPU inference container](/deployments/container/gpu-translation.md): Learn about the Speechmatics Translation GPU container system - [Language ID container](/deployments/container/language-id.md): Learn about the Speechmatics language ID Container - [Licensing](/deployments/container/licensing.md): Learn about the licensing for Speechmatics containers - [Performance and cost](/deployments/container/performance-and-cost.md): Get an overview of the performance and cost of Speechmatics container deployments - [Speaker identification secrets](/deployments/container/speaker-identification.md): Prepare and manage Speaker Identification secrets for Speechmatics deployments - [Troubleshooting](/deployments/container/troubleshooting.md): Troubleshooting for Speechmatics containers ### kubernetes Learn about the Kubernetes deployment options for Speechmatics - [Kubernetes](/deployments/kubernetes.md): Learn about the Kubernetes deployment options for Speechmatics - [Prerequisites](/deployments/kubernetes/prerequisites.md): Prerequisites for deploying Realtime on Kubernetes - [Realtime](/deployments/kubernetes/realtime.md): Learn about the Kubernetes deployment options for Realtime ### usage-reporting Learn about the usage reporting for on-prem deployments - [Usage reporting](/deployments/usage-reporting.md): Learn about the usage reporting for on-prem deployments - [Automatic usage reporting](/deployments/usage-reporting/automatic.md): Learn about automatic usage reporting for on-prem deployments - [Offline usage reporting](/deployments/usage-reporting/offline.md): Learn about offline usage reporting for on-prem deployments ### virtual-appliance Deploy Speechmatics to your own hardware. - [Virtual Appliance](/deployments/virtual-appliance.md): Deploy Speechmatics to your own hardware. - [Adding Languages](/deployments/virtual-appliance/administration/adding-languages.md): Add languages to a Virtual Appliance deployment - [Language Identification](/deployments/virtual-appliance/administration/language-identification.md): Configure Language Identification on a Virtual Appliance deployment - [Logcli Help](/deployments/virtual-appliance/administration/logcli-help.md): Usage manual for the `logcli` command-line tool. - [Monitoring](/deployments/virtual-appliance/administration/monitoring.md): Monitor the appliance resources. - [Networking](/deployments/virtual-appliance/administration/networking.md): Configure the appliance's network settings. - [Remote Access](/deployments/virtual-appliance/administration/remote-access.md): Configure remote access to the appliance. - [Virtual appliance scaling](/deployments/virtual-appliance/administration/scaling.md): Increase appliance performance by scaling the number of threads. - [Security](/deployments/virtual-appliance/administration/security.md): Configure security settings for the appliance. - [Services](/deployments/virtual-appliance/administration/services.md): Configure services for the appliance. - [SSL configuration](/deployments/virtual-appliance/administration/ssl-configuration.md): Configure SSL settings for the appliance. - [Using a GPU](/deployments/virtual-appliance/administration/using-a-gpu.md): Enable GPU processing for the appliance - [Download and import](/deployments/virtual-appliance/installation/download-and-import.md): Get started with your Virtual Appliance deployment. - [Licensing features](/deployments/virtual-appliance/installation/license-features.md): Ensure the appliance is licensed for your use case. - [Licensing](/deployments/virtual-appliance/installation/licensing.md): Ensure you have a valid license for your deployment. - [Network configuration](/deployments/virtual-appliance/installation/network-config.md): Set up the appliance's network configuration. - [System requirements](/deployments/virtual-appliance/installation/system-requirements.md): Ensure your system is ready to run the appliance. - [Verify and go](/deployments/virtual-appliance/installation/verify-and-go.md): Confirm the appliance is working properly. ## get-started ### authentication Learn about how the Speechmatics API handles authentication - [Authentication](/get-started/authentication.md): Learn about how the Speechmatics API handles authentication ### quickstart Take your first steps with the Speechmatics API. - [Quickstart](/get-started/quickstart.md): Take your first steps with the Speechmatics API. ## integrations-and-sdks Discover which integrations and SDKs to add Speechmatics' STT, TTS or voice agents to your applications. - [Overview](/integrations-and-sdks.md): Discover which integrations and SDKs to add Speechmatics' STT, TTS or voice agents to your applications. ### livekit Build a voice AI agent with Speechmatics STT and TTS using LiveKit Agents. - [LiveKit quickstart](/integrations-and-sdks/livekit.md): Build a voice AI agent with Speechmatics STT and TTS using LiveKit Agents. - [LiveKit speech to text](/integrations-and-sdks/livekit/stt.md): Transcribe live audio in your LiveKit voice agents with Speechmatics STT. - [LiveKit text to speech](/integrations-and-sdks/livekit/tts.md): Use Speechmatics text-to-speech voices in your LiveKit voice agents. ### pipecat Build a local voice bot with Speechmatics STT and TTS using Pipecat. - [Pipecat quickstart](/integrations-and-sdks/pipecat.md): Build a local voice bot with Speechmatics STT and TTS using Pipecat. - [Pipecat speech to text](/integrations-and-sdks/pipecat/stt.md): Transcribe live audio in your Pipecat voice bots with Speechmatics STT. - [Pipecat text to speech](/integrations-and-sdks/pipecat/tts.md): Use Speechmatics text to speech voices in your Pipecat voice bots. ### sdks Learn how to use the Speechmatics SDKs - [SDKs](/integrations-and-sdks/sdks.md): Learn how to use the Speechmatics SDKs ### vapi Learn how to integrate Speechmatics STT with Vapi. - [Vapi integration](/integrations-and-sdks/vapi.md): Learn how to integrate Speechmatics STT with Vapi. ### zapier Transcribe audio in your Zapier workflow - no code required. - [Zapier integration](/integrations-and-sdks/zapier.md): Transcribe audio in your Zapier workflow - no code required. ## private ### melia-1-realtime Melia 1 delivers code-switching for 56 languages, in Realtime. - [Melia 1 Realtime Preview - Multilingual transcription](/private/melia-1-realtime.md): Melia 1 delivers code-switching for 56 languages, in Realtime. ### next-gen-model Get started with our next-generation model - [Next-generation Model](/private/next-gen-model.md): Get started with our next-generation model ### preview-mode Get early access to features - [Preview Mode](/private/preview-mode.md): Get early access to features ### voice-agent-api Early access to the Voice Agent API — a turn-based API built for voice agents - [Voice Agent API](/private/voice-agent-api.md): Early access to the Voice Agent API — a turn-based API built for voice agents ## speech-to-text Learn how to turn audio into text. - [Speech to Text overview](/speech-to-text.md): Learn how to turn audio into text. ### accuracy-benchmarking How to calculate Word Error Rate - [Accuracy benchmarking](/speech-to-text/accuracy-benchmarking.md): How to calculate Word Error Rate ### app-analytics Track usage by adding an application ID to your requests. - [App analytics](/speech-to-text/app-analytics.md): Track usage by adding an application ID to your requests. ### batch - [Alignment](/speech-to-text/batch/alignment.md): Learn about the Speechmatics transcription alignment product - [Batch diarization](/speech-to-text/batch/batch-diarization.md): Learn how to use the Speechmatics API to separate speakers in Batch - [Input](/speech-to-text/batch/input.md): Learn about configuration and supported input audio formats for the Speechmatics Batch API - [Language identification (SaaS)](/speech-to-text/batch/language-identification.md): Learn about Speechmatics Language ID - [Limits – Batch](/speech-to-text/batch/limits.md): Learn about rate limiting and usage limits for the Speechmatics Batch API - [Notifications](/speech-to-text/batch/notifications.md): Learn how Speechmatics notifications work - [Output](/speech-to-text/batch/output.md): Learn about the supported output formats for the Speechmatics Batch API - [Quickstart](/speech-to-text/batch/quickstart.md): Learn how to transcribe pre-recorded audio and video files. - [Batch speaker identification](/speech-to-text/batch/speaker-identification.md): Learn how to use the Speechmatics API to identify speakers in Batch - [Chapters](/speech-to-text/batch/speech-intelligence/auto-chapters.md): Learn how to use Speechmatics' Chapters. - [Sentiment analysis](/speech-to-text/batch/speech-intelligence/sentiment-analysis.md): Learn about the sentiment analysis offering for the Speechmatics Batch API - [Summarization](/speech-to-text/batch/speech-intelligence/summarization.md): Learn how to use Speechmatics's summarization feature. - [Topics](/speech-to-text/batch/speech-intelligence/topic-detection.md): Learn how to use Speechmatics' Topics. - [SRT formatting](/speech-to-text/batch/srt-format.md): Learn how to get Speechmatics transcriptions in an SRT format - [Synchronous transcription](/speech-to-text/batch/synchronous.md): Wait for a transcription job to finish synchronously via HTTP - [Troubleshooting](/speech-to-text/batch/troubleshooting.md): Guides to help with troubleshooting the Speechmatics API - [Usage reporting](/speech-to-text/batch/usage.md): Learn how to get information about your API usage ### features - [Audio events](/speech-to-text/features/audio-events.md): Learn how to utilize the Audio Events feature in your media processing workflows - [Audio filtering](/speech-to-text/features/audio-filtering.md): Learn how to utilize Audio Filtering to remove background speech - [Custom dictionary](/speech-to-text/features/custom-dictionary.md): Learn how to use the Speechmatics custom dictionary - [Diarization](/speech-to-text/features/diarization.md): Learn how Speechmatics diarization separates speakers in audio - [Feature discovery](/speech-to-text/features/feature-discovery.md): Learn how to use Speechmatics' Discovery API. - [Speaker identification](/speech-to-text/features/speaker-identification.md): Learn how Speechmatics identifies speakers in audio - [Translation](/speech-to-text/features/translation.md): Translate your audio into multiple languages with a single API call. ### formatting Control how numbers, punctuation, and special text appear in your transcripts. - [Formatting](/speech-to-text/formatting.md): Control how numbers, punctuation, and special text appear in your transcripts. ### languages See which languages Speechmatics supports for transcription and translation, including bilingual packs. - [Languages](/speech-to-text/languages.md): See which languages Speechmatics supports for transcription and translation, including bilingual packs. ### models Compare the Enhanced, Standard, and Melia 1 models and choose the right one for your audio. - [Models](/speech-to-text/models.md): Compare the Enhanced, Standard, and Melia 1 models and choose the right one for your audio. ### realtime - [Python using FFMPEG](/speech-to-text/realtime/guides/python-using-ffmpeg.md): Use ffmpeg to pipe microphone input into the Speechmatics Realtime API - [Python microphone input](/speech-to-text/realtime/guides/python-using-microphone.md): Use the Speechmatics Python library to transcribe your voice using a microphone. - [Input](/speech-to-text/realtime/input.md): Learn about the supported input audio formats for the Speechmatics Realtime API - [Limits – Realtime](/speech-to-text/realtime/limits.md): Learn about the limits for the Speechmatics Realtime API - [Output](/speech-to-text/realtime/output.md): Learn about latency in the Speechmatics Realtime server - [Quickstart](/speech-to-text/realtime/quickstart.md): Learn how to transcribe streaming audio to text in real-time. - [Realtime diarization](/speech-to-text/realtime/realtime-diarization.md): Learn how to use the Speechmatics API to separate speakers in real-time - [Realtime speaker identification](/speech-to-text/realtime/speaker-identification.md): Learn how to use the Speechmatics API to identify speakers in real-time - [Turn detection](/speech-to-text/realtime/turn-detection.md): Learn how to detect the end of speech ## text-to-speech ### quickstart Learn how to convert text to speech using our API. - [Quickstart](/text-to-speech/quickstart.md): Learn how to convert text to speech using our API. ## voice-agents ### overview Learn how to build voice agents with Speechmatics integrations and the Voice SDK. - [Voice agents overview](/voice-agents/overview.md): Learn how to build voice agents with Speechmatics integrations and the Voice SDK. ### voice-sdk Learn how to use the Voice SDK. - [Voice SDK](/voice-agents/voice-sdk.md): Learn how to use the Voice SDK.