TranscriptParams: {
    audio_url: string;
} & TranscriptOptionalParams

The parameters for creating a transcript

Type declaration

  • audio_url: string

    The URL of the audio or video file to transcribe.

{
"speech_model": null,
"language_code": "en_us",
"audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
"punctuate": true,
"format_text": true,
"dual_channel": true,
"webhook_url": "https://your-webhook-url/path",
"webhook_auth_header_name": "webhook-secret",
"webhook_auth_header_value": "webhook-secret-value",
"auto_highlights": true,
"audio_start_from": 10,
"audio_end_at": 280,
"word_boost": [
"aws",
"azure",
"google cloud"
],
"boost_param": "high",
"filter_profanity": true,
"redact_pii": true,
"redact_pii_audio": true,
"redact_pii_audio_quality": "mp3",
"redact_pii_policies": [
"us_social_security_number",
"credit_card_number"
],
"redact_pii_sub": "hash",
"speaker_labels": true,
"speakers_expected": 2,
"content_safety": true,
"iab_categories": true,
"language_detection": false,
"custom_spelling": [],
"disfluencies": false,
"sentiment_analysis": true,
"auto_chapters": true,
"entity_detection": true,
"speech_threshold": 0.5,
"summarization": true,
"summary_model": "informative",
"summary_type": "bullets",
"custom_topics": true,
"topics": []
}