Transcribe an audio/video file

post

https://api.apptek.com/api/v2/transcribe/{model}?[punc=1]&[diar=1]&[channel_layout=0]

Submit audio for transcription, The body of the POST contains the binary audio.

The Content-Type header should be set according to the media type. Most popular audio and video file formats are supported, including the following:

mp3 - audio/mpeg m4a - audio/m4a ogg - audio/ogg flac - audio/x-flac wav - audio/x-wav, audio/wav

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

model

string

required

The ASR model to submit this request to. You can use either the services endpoint or the /transcribe/models endpoint or retrieve the available models.

Query Params

punc

boolean

Defaults to false

If set to a non-zero value, punctuation will be added to the results (if available).

diar

boolean

Defaults to false

If set to a non-zero value, speaker diarization annotations will be added to the results.

custom_vocabulary_id

string

Set the user lexicon id to use during the recognition

channel_layout

string

This is used to define which audio channel(s) in the media file to transcribe. (see the Channel Layout section below)

sentiment

boolean

Defaults to false

Include sentiment scores in the transcription. Sentiment values range from 0.0 (Negative) to 1.0 (Positive)

emotion

boolean

Defaults to false

Include emotion tagging (Happy, Neutral, Angry, etc.)

redact

boolean

Defaults to false

Redact personal information from the transcript and the audio. Text redacted from the transcript is replaced with the identified class. E.g. "[_pers]" being a personal name.

priority

int32

Defaults to 50

An integer priority level between 1 (low priority) and 100 (high priority) for this request. Additional charges may be applied to jobs with higher priority values. Default value is 50.

numeric_output

boolean

Defaults to false

Convert to numbers in word form to digit form. E.g. "two thousand three" converted to "2003"

domain

string

Select a domain specific model. Use the 'services' or 'transcribe/models' API to identify available domains.

Body Params

RAW_BODY

string

required

The body of the POST contains the binary audio data.

Headers

Content-Type

string

required

The content type describing the input. See notes below for the supported content types.

x-token

string

required

API Key

x-callback

string

(optional) A user HTTP callback URL which will be invoked to notify the user when the request completes. See “User request completion callback” for further description.

x-userdata

string

(optional) Any text data the caller wants to associate with this request. This can be used to link this request with some other external tracking information.

Responses

200200

400400

415415

500500