This API returns you a formatted transcript in Markdown format. You can use this markdown payload as is, in any of your markdown compatible UI components or simply store in your database. The API can break down the transcript into paragraphs, highlight key phrases and attach speaker identities in the transcript.
Raw Markdown payload
Markdown format looks like
Speaker 1: Good morning Mr. Lewis.
Speaker 1: It's good to see you again.
Speaker 2: Thanks a lot.
Speaker 1: Start Let us talk about the pricing of your accounting software.
Speaker 1: How much does it cost to the customer?
Speaker 2: The software is sold as a yearly subscription the full cost to the customer is two thousand five hundred dollars per.
Speaker 1: Okay.
When showSpeakerSeparation is false
showSpeakerSeparation is true
|Yes||Your authentication token|
|Yes||Accepted value application/json|
|Yes||Content Type of response.|
|No||This boolean parameter specifies whether or not the transcription for the Conversation should be broken down into logical paragraphs.|
|No||This is a json field which accepts two values |
|No||When set to |
If the value is
true the paragraphs will be generated on the basis of existing
Messages and references to these messages (through
If the value is
false then the content will be returned as is without any line breaks.
This object specifies highlighting related to phrases detected for different entities by the backend. It mainly contains two properties:
highlightOnlyInsightKeyPhrases- Will generate highlighting syntax according to the contentType only for the key phrases detected for Insights if passed as
highlightAllKeyPhrases- Will generate highlighting syntax according to the contentType only for the key phrases detected for all the entities (both Insights and Messages) if passed as
true. For messages key phrases to be detected and highlighting please pass
truein Async APIs.
The highlighted text is present in the response structure with
showSpeakerSeparation only works when speaker information must be passed while
sending the conversation information.
In Async API - Diarization must be turned on.
|This json field contain two fields payload and contentType.|
|The transcription content formatted according to the contentType and other request attributes passed in the request.|
|The contentType passed in the request body of the transcription.|