Sign in
latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Create summary

Creates a new summary for the specified transcription.

Session summaries are currently in Beta and available to selected customers only. Email us at embedded@whereby.com to join our pilot program (terms and conditions apply).

post/summaries

Path parameters

transcriptionIdstring required

Transcription ID.

Request body

transcriptionIdstring required

The transcription ID for which the summary should be created.

template'SOAP' | 'Extended SOAP' | 'General Narrative' | 'General Bulleted' | 'Educational Lecture' | 'Educational Tutoring'

The template that the summary should be created from. The following summary templates are currently available:

  • General Bulleted
  • General Narrative
  • SOAP
  • Extended SOAP
  • General Narrative
  • Educational Lecture
  • Educational Tutoring

Example request

{
  "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
  "template": "General Narrative"
}

Response

The summary job was scheduled successfully.

{"stackTrail":"paths:/summaries:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}