COcommpeak
Speech

Submit an audio recording for asynchronous speech recognition

Creates a speech recognition (transcription) task for an audio recording and returns its id immediately with HTTP 201; processing happens in the background. The recording is uploaded as a multipart file in recording. Languages, channel handling, speaker diarization and the task type are set in the request body; remote_identifier and metadata let you correlate the task with your own records. When webhook_url is set the result is posted there once the task completes, otherwise poll the result method with the returned id. A recognition token of the authenticated account may be passed in the X-Recognition-Token header (or as a token query parameter); API keys allowed to use Speech Recognition may omit it. Processing is charged from the account balance. Returns 400 with validation errors when the task cannot be created.

post/speech/recognize

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/speech/recognize
  • Auth
    API key in header Authorization

Request body multipart/form-data

recordingstring binary

Audio recording file (multipart upload).

parse_channelinteger

Index of channel to parse (0 = all channels, 1 = first channel).

languagesstring[]

List of language codes (or underscore-separated, e.g. "en_es").

remote_identifierstring

Caller-provided identifier returned with the result.

webhook_urlstring

URL to be notified when recognition is complete.

task_typestring

Type of recognition task (transcribe | translate | transcribe_and_translate).

metadataobject

Free-form metadata stored with the task.

Response

Successful Response

Changes

No recorded changes to this operation across all 1 revision of this API.