Dictate — From audio file
POST/dictate
Generate a dictation from an audio file. Only audio/* mime types are supported. The maximum duration is 10 minutes. If you have longer files, please use the asynchronous equivalent.
Request
Responses
- 200
Results of processing the audio file.
Operation spec
{
"method": "post",
"path": "/dictate",
"operationId": "dictate",
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"request_parameters": {
"type": "object",
"description": "The object containing all the information needed along with the audio file for which you want dictation.",
"properties": {
"dictation_locale": {
"type": "string",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"FRENCH_FR"
],
"example": "ENGLISH_US",
"title": "dictate_locale"
},
"punctuation_mode": {
"type": "string",
"enum": [
"EXPLICIT"
],
"description": "Specifies how punctuation is handled. Possible values are:<br/> • `EXPLICIT`: speaker must explicitly dictate punctuation (e.g. \"comma\" or \"quotation mark\").",
"title": "punctuation_mode"
},
"specialty": {
"type": "string",
"description": "The medical specialty of the provider.",
"nullable": true,
"enum": [
"ADDICTION_MEDICINE",
"PAIN_MEDICINE",
"ALLERGY_AND_IMMUNOLOGY",
"ANESTHESIOLOGY",
"ONCOLOGY",
"CARDIOLOGY",
"SURGERY",
"DERMATOLOGY",
"DIABETOLOGY",
"ENDOCRINOLOGY",
"GENETICS",
"GERIATRICS",
"GYNECOLOGY",
"HEMATOLOGY",
"HEPATOLOGY",
"GASTROENTEROLOGY",
"SPORTS_MEDICINE",
"OCCUPATIONAL_MEDICINE",
"GENERAL_MEDICINE",
"FORENSIC_MEDICINE",
"PHYSICAL_MEDICINE_AND_REHABILITATION",
"NEPHROLOGY",
"NEUROLOGY",
"NUTRITION",
"DIETETICS",
"OPHTHALMOLOGY",
"ENT",
"PEDIATRICS",
"PULMONOLOGY",
"PSYCHIATRY",
"RHEUMATOLOGY",
"RADIOLOGY",
"IMMUNOLOGY",
"INFECTIOUS_DISEASE",
"SEXUAL_MEDICINE",
"TOXICOLOGY",
"UROLOGY",
"MIDWIFE",
"EMERGENCY_MEDICINE",
"NURSE",
"PSYCHOLOGY",
"PSYCHOTHERAPY",
"INTERNAL_MEDICINE",
"FAMILY_MEDICINE",
"DENTIST",
"VETERINARIAN",
"PHYSIOTHERAPY",
"CHIROPRACTIC",
"OSTEOPATHIC_MEDICINE",
"ORTHOPEDICS",
"OTHER",
"LACTATION_CONSULTANT",
"PODIATRY",
"GENERAL_PRACTICE",
"HOSPITAL_MEDICINE",
"BEHAVIORAL_HEALTH",
"MENTAL_HEALTH",
"SUBSTANCE_USE_DISORDER",
"VASCULAR_MEDICINE",
"LIFESTYLE_MEDICINE",
"PREVENTIVE_MEDICINE",
"PUBLIC_HEALTH",
"ADOLESCENT_MEDICINE",
"WOUND_CARE",
"NEUROSURGERY",
"PLASTIC_SURGERY",
"PALLIATIVE_CARE",
"TRANSPLANT_MEDICINE",
"OBESITY_MEDICINE",
"CASE_MANAGEMENT",
"CARE_MANAGEMENT",
"CARE_COORDINATION",
"SOCIAL_WORK",
"PATHOLOGY",
"RADIATION_ONCOLOGY",
"SLEEP_MEDICINE",
"AUDIOLOGY",
"REPRODUCTIVE_ENDOCRINOLOGY",
"PHARMACIST",
"OCCUPATIONAL_THERAPY",
"SPEECH_LANGUAGE_PATHOLOGY"
],
"example": "GENERAL_PRACTICE",
"title": "specialty_kind"
}
},
"required": [
"dictation_locale",
"punctuation_mode"
],
"title": "dictate_request"
},
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"request_parameters",
"file"
]
}
}
}
},
"responses": {
"200": {
"description": "Results of processing the audio file.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dictation": {
"type": "string"
}
},
"required": [
"dictation"
],
"title": "dictate_response"
}
}
}
}
}
}