API Overview

Capacity

Capacity Private Cloud provides a well-defined set of public APIs that give developers and integrators programmatic access to the full breadth of the platform's speech, biometrics, management, and reporting capabilities. These APIs are the primary integration surface for building applications on top of the platform, whether you are consuming speech services, managing deployments, or extracting operational data.

The following APIs are available:

• Speech API — The Speech API is used for functionality working with Capacity Private Cloud speech products. This collection of APIs can be used to consume the speech products: ASR, Transcription, TTS, CPA & AMD.
• Biometrics API — This collection is used for Capacity Private Cloud Voice Biometrics products. It is used to perform active voice biometrics enrollment and verification transactions.
• Management API — A REST API that provides external access to the Deployment, Configuration, and Engine Resource Services. Used to manage configuration and deployment parameters, which can also be managed via the Admin Portal and the Deployment Portal.
• Reporting API — This collection of APIs is used to extract session and transactional data from the platform. There is currently a Reporting API for speech, and a Reporting Bio API for voice biometrics. The Reporting API for speech is a gRPC API (served by reporting-api); the Reporting Bio API for voice biometrics is a REST API (served by reporting-bio-api).

For more information on the APIs and how client applications can interact with them, see the API reference for the protocol definitions and API specifications, and API Access, Authentication and Required Headers for how to call them.

Related Articles

• Architecture Summary
• Infrastructure Prerequisites
• Additional Recommended External Components
• Licensing & Usage Reporting
• Model Resources
• Capacity Private Cloud Containerized Microservices