{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"audioUrl": {
"type": "string",
"description": "URL of audio or video file to transcribe"
},
"model": {
"type": "string",
"enum": [
"nova-3",
"nova-3-general",
"nova-3-medical",
"nova-2",
"nova-2-general",
"nova-2-meeting",
"nova-2-phonecall",
"nova-2-voicemail",
"nova-2-finance",
"nova-2-conversationalai",
"nova-2-video",
"nova-2-medical",
"nova-2-drivethru",
"nova-2-automotive",
"nova",
"enhanced",
"base",
"whisper-tiny",
"whisper-base",
"whisper-small",
"whisper-medium",
"whisper-large"
],
"default": "nova-3",
"description": "Deepgram model. Nova-3 is current best; required for keyterm."
},
"language": {
"type": "string",
"default": "en-US",
"description": "BCP-47 language code (e.g. en-US, es, fr)"
},
"detectLanguage": {
"type": "boolean",
"description": "Auto-detect language instead of using `language`"
},
"punctuate": {
"type": "boolean",
"default": true,
"description": "Add punctuation"
},
"smartFormat": {
"type": "boolean",
"default": true,
"description": "Smart formatting: dates, times, numbers, etc. Recommended for most use cases."
},
"numerals": {
"type": "boolean",
"description": "Convert numbers to numerals (e.g. \"one\" → \"1\")"
},
"profanityFilter": {
"type": "boolean",
"description": "Filter profanity"
},
"dictation": {
"type": "boolean",
"description": "Interpret spoken punctuation commands (e.g. \"period\", \"comma\")"
},
"measurements": {
"type": "boolean",
"description": "Normalize measurement abbreviations"
},
"fillerWords": {
"type": "boolean",
"description": "Include \"um\" / \"uh\" / etc. in transcript"
},
"diarize": {
"type": "boolean",
"description": "Enable speaker diarization"
},
"diarizeVersion": {
"type": "string",
"description": "Pin diarization algorithm version (e.g. \"2023-09-15\")"
},
"utterances": {
"type": "boolean",
"description": "Group output into utterances with start/end timestamps. Often combined with diarize."
},
"uttSplit": {
"type": "number",
"description": "Silence threshold (seconds) for splitting utterances. Default 0.8."
},
"paragraphs": {
"type": "boolean",
"description": "Group output into paragraphs with start/end timestamps."
},
"multichannel": {
"type": "boolean",
"description": "Transcribe each audio channel separately. Critical for stereo call recordings."
},
"alternatives": {
"type": "number",
"description": "Return N transcription candidates per channel with confidence"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Keyword boosting. Each entry may be \"word\" or \"word:intensifier\" (e.g. \"Pinkfish:2\"). Pre-Nova-3 models."
},
"keyterm": {
"type": "array",
"items": {
"type": "string"
},
"description": "Nova-3 keyterm boosting (superior to `keywords`). Multi-word phrases supported. English-only."
},
"search": {
"type": "array",
"items": {
"type": "string"
},
"description": "Search for phrases; returns hits with timestamps"
},
"replace": {
"type": "array",
"items": {
"type": "string"
},
"description": "Find-and-replace in transcript. Format: \"find:replace\" per entry."
},
"summarize": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": [
"v2"
]
}
],
"description": "Generate summary. Pass true (v2) or \"v2\"."
},
"detectTopics": {
"type": "boolean",
"description": "Detect topics"
},
"customTopics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom topics to detect (requires detectTopics)"
},
"intents": {
"type": "boolean",
"description": "Detect intents"
},
"customIntents": {
"type": "array",
"items": {
"type": "string"
},
"description": "Custom intents to detect (requires intents)"
},
"sentiment": {
"type": "boolean",
"description": "Sentiment analysis per segment"
},
"redact": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pci",
"pii",
"phi",
"numbers",
"ssn",
"aggressive_numbers",
"credit_card",
"credit_card_expiration",
"cvv",
"email_address",
"phone_number",
"account_number",
"age",
"date",
"date_interval",
"dob",
"driver_license",
"healthcare_number",
"ip_address",
"location",
"location_address",
"location_zip",
"location_coordinate",
"money",
"numerical_pii",
"passport_number",
"password",
"time",
"vehicle_id",
"statistics",
"bank_account",
"routing_number"
]
},
"description": "Redaction options. Common: pci, pii, phi, numbers, ssn. Also supports specific entity types."
},
"mipOptOut": {
"type": "boolean",
"description": "Opt out of Deepgram model improvement program (compliance)"
},
"tag": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels for Deepgram console analytics filtering"
},
"extra": {
"type": "array",
"items": {
"type": "string"
},
"description": "Arbitrary key:value metadata passthrough. Format: \"key:value\" per entry."
}
},
"required": [
"PCID",
"audioUrl"
]
}
