API Endpoint Reference
Last updated June 30, 2023
The Speechly API provides a comprehensive set of endpoints that allow developers to integrate voice recognition and natural language understanding capabilities into their applications. This article serves as a reference guide to the various API endpoints available, their functionalities, and the expected request and response formats.
API Endpoint List:
- POST /speech:
- Endpoint for sending audio data to the Speechly API for speech recognition and natural language processing.
- Provides real-time or batch processing of audio data for extracting transcriptions and intents.
- Accepts audio data in various formats, such as WAV, FLAC, or Opus.
- GET /models:
- Endpoint for retrieving the list of available language models supported by the Speechly API.
- Provides information about the language models, including their unique identifiers, supported languages, and other metadata.
- POST /models/{model_id}/parse:
- Endpoint for parsing user queries against a specific language model.
- Allows you to send a text query to the API, which will be processed and analyzed based on the specified language model.
- Returns the recognized intent and entities extracted from the user query.
- GET /models/{model_id}/entities:
- Endpoint for retrieving information about the entities supported by a specific language model.
- Provides a list of entities, their types, possible values, and other relevant metadata.
- POST /models/{model_id}/feedback:
- Endpoint for submitting feedback to the Speechly API to improve recognition accuracy and performance.
- Allows developers to provide feedback on recognized intents and entities, helping to train the underlying models.
- GET /models/{model_id}/usage:
- Endpoint for retrieving usage statistics and analytics for a specific language model.
- Provides insights into usage patterns, request volume, and performance metrics for monitoring and optimization purposes.
It is important to refer to the official Speechly API documentation for detailed information about the endpoint functionalities, required request parameters, authentication methods, and response formats. Familiarize yourself with the specific usage guidelines and best practices to ensure seamless integration and optimal utilization of the API endpoints within your applications.
When using the API endpoints, make sure to handle errors and exceptions gracefully and implement proper error handling mechanisms. Monitor the performance and response times of the API requests to ensure a smooth user experience.