Creates an instance of AssemblyClient.
Your API key to authenticate to AssemblyAI.
a new AssemblyClient.
The Axios http client used to make requests to the AssemblyAI API.
Create a transcript. The transcript can then be downloaded via getTranscript, pollForTranscript, getTranscriptSentences, getTranscriptParagraphs, and getAllTranscripts.
A TranscriptRequest with your transcription options.
A TranscriptResponse of an incomplete transcript.
Permanently delete a transcript by id. The record of the transcript will exist and remain queryable, however, all fields containing sensitive data (like text transcriptions) will be permanently deleted.
The unique identifier of your transcription.
List all your transcripts.
Max results to return in a single response, between 1 and 200 inclusive.
Filter by transcript status, "processing", "queued", "completed", or "error".
Only return transcripts created on this date; format: "YYYY-MM-DD".
Return transcripts that were created before this transcript id.
Return transcripts that were created after this transcript id.
Only return throttled transcripts, overrides status filter.
A paginated AllTranscriptsResponse with {@link limit} transcript results.
Get the detailed information of a specific transcript by id.
The unique identifier of your transcription.
A TranscriptResponse of the full transcript object no matter it's status.
Query for just the paragraphs of a transcript.
The unique identifier of your transcription.
A PartialTranscriptResponse with the paragraphs of the transcript as a list of utterances.
Query for just the sentences of a transcript.
The unique identifier of your transcription.
A PartialTranscriptResponse with the sentences of the transcript as a list of utterances.
Poll for a transcript.
The unique identifier of your transcription.
The amount of time to poll for before timing out.
The amount of time in ms to wait between each call to see if the transcript is complete.
A TranscriptResponse when the transcript TranscriptResponse.status === completed.
If you're working with short bursts of audio, less than 15 seconds, you can send the audio data directly to the /v2/stream endpoint which will return a transcript to you within a few hundred milliseconds, directly in the request-response loop.
The audio data you send to this endpoint has to comply with a strict format. This is because we don't do any transcoding to your data, we send it directly to the model for transcription. You can send the content of a .wav file to this endpoint, or raw data read directly from a microphone. Either way, you must record your audio in the following format to use this endpoint:
A StreamResponse. Depending on how much audio data you send, the API will respond within 100-750 milliseconds.
Upload an audio file to AssemblyAI for transcription. The transcript can then be downloaded via getTranscript, pollForTranscript, getTranscriptSentences, getTranscriptParagraphs, and getAllTranscripts.
A URL that points to your audio file, accessible only by AssemblyAI's servers.
An UploadRequestResponse with the audio_url used.
Generated using TypeDoc
The AssemblyAI client that allows you to call the AssemblyAI V2 endpoints via various functions.