Overview

Use BrainEngine's REST API to

• Automate the transcription and redaction of audio files.

• Automate the real-time transcription and redaction of streaming audio.

• Examine or modify a BrainEngine installation using API calls that

  • Initializes the platform based on redaction requirements.

  • Retrieve, update, or delete project configuration.

  • List redaction rules for a given project.

  • Validate insight trigger and response search expressions.

  • Retrieve status information about the health of the platform and underlying services.

  • Search transcription records by folder or organization to identify, count, and retrieve record matches.

BrainEngine HTTP endpoints are RESTful, and consume and return JSON. In addition, the API is identical for both on-premises and cloud-based deployments. To review all API functions, refer to Endpoints.

Versioning

Our API is currently at v1. A new version of the API will be released when backwards-incompatible changes are made to the API.