Deepgram Media API

openapi: 3.2.0
info:
  title: REST Media API
  version: 1.0.0
servers:
- url: https://agent.deepgram.com
  description: Production
- url: https://api.deepgram.com
  description: Base
tags:
- name: Media
paths:
  /v1/listen:
    post:
      operationId: media_transcribe
      summary: Transcribe and analyze pre-recorded audio and video
      description: Transcribe audio and video using Deepgram's speech-to-text REST API
      tags:
      - Media
      parameters:
      - name: callback
        in: query
        description: URL to which we'll make the callback request
        required: false
        schema:
          type: string
      - name: callback_method
        in: query
        description: HTTP method by which the callback request will be made
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersCallbackMethod'
          default: POST
      - name: extra
        in: query
        description: Arbitrary key-value pairs that are attached to the API response for usage in downstream processing
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersExtra'
      - name: sentiment
        in: query
        description: Recognizes the sentiment throughout a transcript or text
        required: false
        schema:
          type: boolean
          default: false
      - name: summarize
        in: query
        description: Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersSummarize'
      - name: tag
        in: query
        description: Label your requests for the purpose of identification during usage reporting
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersTag'
      - name: topics
        in: query
        description: Detect topics throughout a transcript or text
        required: false
        schema:
          type: boolean
          default: false
      - name: custom_topic
        in: query
        description: Custom topics you want the model to detect within your input audio or text if present Submit up to `100`.
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersCustomTopic'
      - name: custom_topic_mode
        in: query
        description: Sets how the model will interpret strings submitted to the `custom_topic` param. When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersCustomTopicMode'
          default: extended
      - name: intents
        in: query
        description: Recognizes speaker intent throughout a transcript or text
        required: false
        schema:
          type: boolean
          default: false
      - name: custom_intent
        in: query
        description: Custom intents you want the model to detect within your input audio if present
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersCustomIntent'
      - name: custom_intent_mode
        in: query
        description: Sets how the model will interpret intents submitted to the `custom_intent` param. When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in the `custom_intent` param.
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersCustomIntentMode'
          default: extended
      - name: detect_entities
        in: query
        description: Identifies and extracts key entities from content in submitted audio
        required: false
        schema:
          type: boolean
          default: false
      - name: detect_language
        in: query
        description: Identifies the dominant language spoken in submitted audio
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersDetectLanguage'
      - name: diarize
        in: query
        description: 'Deprecated: use `diarize_model` instead. Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0.'
        required: false
        schema:
          type: boolean
          default: false
        deprecated: true
      - name: diarize_model
        in: query
        description: Select and enable a specific diarization model version. Specifying this parameter enables diarization and selects the model — you do not need to also set the deprecated `diarize=true` parameter. For batch, supported values are `latest` (currently v2), `v1`, and `v2`. For streaming, supported values are `latest` (currently v1) and `v1`; `v2` returns a validation error on streaming requests.
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersDiarizeModel'
      - name: dictation
        in: query
        description: Dictation mode for controlling formatting with dictated speech
        required: false
        schema:
          type: boolean
          default: false
      - name: encoding
        in: query
        description: Specify the expected encoding of your submitted audio
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersEncoding'
      - name: filler_words
        in: query
        description: Filler Words can help transcribe interruptions in your audio, like "uh" and "um"
        required: false
        schema:
          type: boolean
          default: false
      - name: keyterm
        in: query
        description: 'Key term prompting improves recognition of specialized terminology and brands. Only compatible with Nova-3.


          `keyterm` accepts plain terms only. Unlike the legacy `keywords` feature, it does not support weights or intensifiers. Appending one (for example, `keyterm=term:0.15`) is not rejected—the weight is silently ignored and the entire value is treated as a literal keyterm.


          To boost multiple separate keyterms, repeat the `keyterm` parameter (for example, `keyterm=term1&keyterm=term2`). To boost one multi-word phrase as a single keyterm, join the words with `%20` or `+` (for example, `keyterm=customer%20service`). Do not separate keyterms with commas, semicolons, or line breaks.

          '
        required: false
        schema:
          type: array
          items:
            type: string
      - name: keywords
        in: query
        description: Keywords can boost or suppress specialized terminology and brands. `keywords` is not supported with Nova-3 models; use `keyterm` instead.
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersKeywords'
      - name: language
        in: query
        description: The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available
        required: false
        schema:
          type: string
          default: en
      - name: measurements
        in: query
        description: Spoken measurements will be converted to their corresponding abbreviations
        required: false
        schema:
          type: boolean
          default: false
      - name: model
        in: query
        description: AI model used to process submitted audio
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersModel'
          default: base-general
      - name: multichannel
        in: query
        description: Transcribe each audio channel independently
        required: false
        schema:
          type: boolean
          default: false
      - name: numerals
        in: query
        description: Numerals converts numbers from written format to numerical format
        required: false
        schema:
          type: boolean
          default: false
      - name: paragraphs
        in: query
        description: Splits audio into paragraphs to improve transcript readability
        required: false
        schema:
          type: boolean
          default: false
      - name: profanity_filter
        in: query
        description: Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely
        required: false
        schema:
          type: boolean
          default: false
      - name: punctuate
        in: query
        description: Add punctuation and capitalization to the transcript
        required: false
        schema:
          type: boolean
          default: false
      - name: redact
        in: query
        description: Redaction removes sensitive information from your transcripts
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersRedact'
          default: false
      - name: replace
        in: query
        description: Search for terms or phrases in submitted audio and replaces them
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersReplace'
      - name: search
        in: query
        description: Search for terms or phrases in submitted audio
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersSearch'
      - name: smart_format
        in: query
        description: Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability
        required: false
        schema:
          type: boolean
          default: false
      - name: utterances
        in: query
        description: Segments speech into meaningful semantic units
        required: false
        schema:
          type: boolean
          default: false
      - name: utt_split
        in: query
        description: Seconds to wait before detecting a pause between words in submitted audio
        required: false
        schema:
          type: number
          format: double
          default: 0.8
      - name: version
        in: query
        description: Version of an AI model to use
        required: false
        schema:
          $ref: '#/components/schemas/V1ListenPostParametersVersion'
          default: latest
      - name: mip_opt_out
        in: query
        description: Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Returns either transcription results, or a request_id when using a callback.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/listen_v1_media_transcribe_Response_200'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListenV1Response'
      requestBody:
        description: Transcribe an audio or video file
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListenV1RequestUrl'
      security:
      - ApiKeyAuth: []
components:
  schemas:
    SharedTopicsSegmentsItems:
      type: object
      properties:
        text:
          type: string
        start_word:
          type: number
          format: double
        end_word:
          type: number
          format: double
        topics:
          type: array
          items:
            $ref: '#/components/schemas/SharedTopicsSegmentsItemsTopicsItems'
      title: SharedTopicsSegmentsItems
    V1ListenPostParametersCustomTopic:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersCustomTopic
    V1ListenPostParametersSummarize0:
      type: string
      enum:
      - v2
      title: V1ListenPostParametersSummarize0
    listen_v1_media_transcribe_Response_200:
      oneOf:
      - $ref: '#/components/schemas/ListenV1Response'
      - $ref: '#/components/schemas/ListenV1AcceptedResponse'
      title: listen_v1_media_transcribe_Response_200
    ListenV1Response:
      type: object
      properties:
        metadata:
          $ref: '#/components/schemas/ListenV1ResponseMetadata'
        results:
          $ref: '#/components/schemas/ListenV1ResponseResults'
      required:
      - metadata
      - results
      description: The standard transcription response
      title: ListenV1Response
    SharedIntentsSegmentsItemsIntentsItems:
      type: object
      properties:
        intent:
          type: string
        confidence_score:
          type: string
          title: float
      title: SharedIntentsSegmentsItemsIntentsItems
    ListenV1ResponseMetadataIntentsInfo:
      type: object
      properties:
        model_uuid:
          type: string
        input_tokens:
          type: integer
        output_tokens:
          type: integer
      title: ListenV1ResponseMetadataIntentsInfo
    ListenV1AcceptedResponse:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Unique identifier for tracking the asynchronous request
      required:
      - request_id
      description: Accepted response for asynchronous transcription requests
      title: ListenV1AcceptedResponse
    SharedSentiments:
      type: object
      properties:
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SharedSentimentsSegmentsItems'
        average:
          $ref: '#/components/schemas/SharedSentimentsAverage'
      description: Output whenever `sentiment=true` is used
      title: SharedSentiments
    V1ListenPostParametersEncoding:
      type: string
      enum:
      - linear16
      - flac
      - mulaw
      - amr-nb
      - amr-wb
      - opus
      - speex
      - g729
      title: V1ListenPostParametersEncoding
    ListenV1ResponseResultsUtterancesItems:
      type: object
      properties:
        start:
          type: string
          title: float
        end:
          type: string
          title: float
        confidence:
          type: string
          title: float
        channel:
          type: integer
        transcript:
          type: string
        words:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsUtterancesItemsWordsItems'
        speaker:
          type: integer
        id:
          type: string
          format: uuid
      title: ListenV1ResponseResultsUtterancesItems
    ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems:
      type: object
      properties:
        text:
          type: string
        start:
          type: string
          title: float
        end:
          type: string
          title: float
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems
    ListenV1ResponseResultsUtterances:
      type: array
      items:
        $ref: '#/components/schemas/ListenV1ResponseResultsUtterancesItems'
      title: ListenV1ResponseResultsUtterances
    ListenV1ResponseResultsUtterancesItemsWordsItems:
      type: object
      properties:
        word:
          type: string
        start:
          type: string
          title: float
        end:
          type: string
          title: float
        confidence:
          type: string
          title: float
        speaker:
          type: integer
        speaker_confidence:
          type: string
          title: float
        punctuated_word:
          type: string
      title: ListenV1ResponseResultsUtterancesItemsWordsItems
    V1ListenPostParametersKeywords:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersKeywords
    V1ListenPostParametersExtra:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersExtra
    V1ListenPostParametersCallbackMethod:
      type: string
      enum:
      - POST
      - PUT
      default: POST
      title: V1ListenPostParametersCallbackMethod
    SharedIntents:
      type: object
      properties:
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SharedIntentsSegmentsItems'
      description: Output whenever `intents=true` is used
      title: SharedIntents
    ListenV1RequestUrl:
      type: object
      properties:
        url:
          type: string
          format: uri
      required:
      - url
      description: Audio file URL to transcribe
      title: ListenV1RequestUrl
    SharedTopicsSegmentsItemsTopicsItems:
      type: object
      properties:
        topic:
          type: string
        confidence_score:
          type: string
          title: float
      title: SharedTopicsSegmentsItemsTopicsItems
    ListenV1ResponseResultsChannelsItems:
      type: object
      properties:
        search:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsSearchItems'
        alternatives:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItems'
        detected_language:
          type: string
      title: ListenV1ResponseResultsChannelsItems
    SharedIntentsSegmentsItems:
      type: object
      properties:
        text:
          type: string
        start_word:
          type: number
          format: double
        end_word:
          type: number
          format: double
        intents:
          type: array
          items:
            $ref: '#/components/schemas/SharedIntentsSegmentsItemsIntentsItems'
      title: SharedIntentsSegmentsItems
    ListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems:
      type: object
      properties:
        summary:
          type: string
        start_word:
          type: string
          title: float
        end_word:
          type: string
          title: float
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems
    V1ListenPostParametersDiarizeModel:
      type: string
      enum:
      - latest
      - v1
      - v2
      title: V1ListenPostParametersDiarizeModel
    ListenV1ResponseMetadataSentimentInfo:
      type: object
      properties:
        model_uuid:
          type: string
        input_tokens:
          type: integer
        output_tokens:
          type: integer
      title: ListenV1ResponseMetadataSentimentInfo
    V1ListenPostParametersCustomIntent:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersCustomIntent
    ListenV1ResponseResultsChannels:
      type: array
      items:
        $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItems'
      title: ListenV1ResponseResultsChannels
    ListenV1ResponseMetadataTopicsInfo:
      type: object
      properties:
        model_uuid:
          type: string
        input_tokens:
          type: integer
        output_tokens:
          type: integer
      title: ListenV1ResponseMetadataTopicsInfo
    V1ListenPostParametersTag:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersTag
    ListenV1ResponseMetadataDiarizeInfo:
      type: object
      properties:
        model_uuid:
          type: string
          description: The diarizer model UUID
        arch:
          type: string
          description: The diarizer arch, such as `v1` or `v2`
      required:
      - model_uuid
      - arch
      description: The diarizer that produced the speaker labels. Present only when a diarizer ran.
      title: ListenV1ResponseMetadataDiarizeInfo
    V1ListenPostParametersModel0:
      type: string
      enum:
      - nova-3
      - nova-3-general
      - nova-3-medical
      - nova-2
      - nova-2-general
      - nova-2-meeting
      - nova-2-finance
      - nova-2-conversationalai
      - nova-2-voicemail
      - nova-2-video
      - nova-2-medical
      - nova-2-drivethru
      - nova-2-automotive
      - nova
      - nova-general
      - nova-phonecall
      - nova-medical
      - enhanced
      - enhanced-general
      - enhanced-meeting
      - enhanced-phonecall
      - enhanced-finance
      - base
      - meeting
      - phonecall
      - finance
      - conversationalai
      - voicemail
      - video
      description: Our public models available to all accounts
      title: V1ListenPostParametersModel0
    ListenV1ResponseResultsChannelsItemsAlternativesItems:
      type: object
      properties:
        transcript:
          type: string
        confidence:
          type: string
          title: float
        words:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems'
        paragraphs:
          $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs'
        entities:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems'
        summaries:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsSummariesItems'
        topics:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems'
      title: ListenV1ResponseResultsChannelsItemsAlternativesItems
    V1ListenPostParametersCustomTopicMode:
      type: string
      enum:
      - extended
      - strict
      default: extended
      title: V1ListenPostParametersCustomTopicMode
    ListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems:
      type: object
      properties:
        text:
          type: string
        start_word:
          type: string
          title: float
        end_word:
          type: string
          title: float
        topics:
          type: array
          items:
            type: string
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsTopicsItems
    ListenV1ResponseMetadataModelInfo:
      type: object
      properties: {}
      title: ListenV1ResponseMetadataModelInfo
    ListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems:
      type: object
      properties:
        word:
          type: string
        start:
          type: string
          title: float
        end:
          type: string
          title: float
        confidence:
          type: string
          title: float
        speaker:
          type: integer
          description: The speaker of the word, present when diarization is enabled
        speaker_confidence:
          type: string
          title: float
          description: Confidence in the speaker assignment. Returned only for pre-recorded diarization; not available for streaming
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsWordsItems
    ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs:
      type: object
      properties:
        transcript:
          type: string
        paragraphs:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems'
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphs
    ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems:
      type: object
      properties:
        sentences:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItemsSentencesItems'
        speaker:
          type: integer
        num_words:
          type: integer
        start:
          type: string
          title: float
        end:
          type: string
          title: float
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsParagraphsParagraphsItems
    ListenV1ResponseResultsSummary:
      type: object
      properties:
        result:
          type: string
        short:
          type: string
      title: ListenV1ResponseResultsSummary
    ListenV1ResponseMetadata:
      type: object
      properties:
        transaction_key:
          type: string
          default: deprecated
          deprecated: true
        request_id:
          type: string
          format: uuid
        sha256:
          type: string
        created:
          type: string
          format: date-time
        duration:
          type: number
          format: double
        channels:
          type: integer
        models:
          type: array
          items:
            type: string
        model_info:
          $ref: '#/components/schemas/ListenV1ResponseMetadataModelInfo'
        diarize_info:
          $ref: '#/components/schemas/ListenV1ResponseMetadataDiarizeInfo'
          description: The diarizer that produced the speaker labels. Present only when a diarizer ran.
        summary_info:
          $ref: '#/components/schemas/ListenV1ResponseMetadataSummaryInfo'
        sentiment_info:
          $ref: '#/components/schemas/ListenV1ResponseMetadataSentimentInfo'
        topics_info:
          $ref: '#/components/schemas/ListenV1ResponseMetadataTopicsInfo'
        intents_info:
          $ref: '#/components/schemas/ListenV1ResponseMetadataIntentsInfo'
        tags:
          type: array
          items:
            type: string
      required:
      - request_id
      - sha256
      - created
      - duration
      - channels
      - models
      - model_info
      title: ListenV1ResponseMetadata
    ListenV1ResponseMetadataSummaryInfo:
      type: object
      properties:
        model_uuid:
          type: string
        input_tokens:
          type: integer
        output_tokens:
          type: integer
      title: ListenV1ResponseMetadataSummaryInfo
    ListenV1ResponseResultsChannelsItemsSearchItemsHitsItems:
      type: object
      properties:
        confidence:
          type: string
          title: float
        start:
          type: string
          title: float
        end:
          type: string
          title: float
        snippet:
          type: string
      title: ListenV1ResponseResultsChannelsItemsSearchItemsHitsItems
    V1ListenPostParametersSearch:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersSearch
    ListenV1ResponseResultsChannelsItemsSearchItems:
      type: object
      properties:
        query:
          type: string
        hits:
          type: array
          items:
            $ref: '#/components/schemas/ListenV1ResponseResultsChannelsItemsSearchItemsHitsItems'
      title: ListenV1ResponseResultsChannelsItemsSearchItems
    V1ListenPostParametersDetectLanguage:
      oneOf:
      - type: boolean
        default: false
      - type: array
        items:
          type: string
      title: V1ListenPostParametersDetectLanguage
    SharedSentimentsSegmentsItems:
      type: object
      properties:
        text:
          type: string
        start_word:
          type: number
          format: double
        end_word:
          type: number
          format: double
        sentiment:
          type: string
        sentiment_score:
          type: number
          format: double
      title: SharedSentimentsSegmentsItems
    ListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems:
      type: object
      properties:
        label:
          type: string
        value:
          type: string
        raw_value:
          type: string
        confidence:
          type: string
          title: float
        start_word:
          type: string
          title: float
        end_word:
          type: string
          title: float
      title: ListenV1ResponseResultsChannelsItemsAlternativesItemsEntitiesItems
    V1ListenPostParametersVersion:
      oneOf:
      - $ref: '#/components/schemas/V1ListenPostParametersVersion0'
      - type: string
      title: V1ListenPostParametersVersion
    V1ListenPostParametersSummarize:
      oneOf:
      - $ref: '#/components/schemas/V1ListenPostParametersSummarize0'
      - type: boolean
        default: false
      title: V1ListenPostParametersSummarize
    V1ListenPostParametersRedact:
      oneOf:
      - type: string
      - $ref: '#/components/schemas/V1ListenPostParametersRedact1'
      title: V1ListenPostParametersRedact
    V1ListenPostParametersRedactSchemaOneOf1Items:
      type: string
      enum:
      - pci
      - pii
      - numbers
      title: V1ListenPostParametersRedactSchemaOneOf1Items
    V1ListenPostParametersRedact1:
      type: array
      items:
        $ref: '#/components/schemas/V1ListenPostParametersRedactSchemaOneOf1Items'
      title: V1ListenPostParametersRedact1
    V1ListenPostParametersReplace:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      title: V1ListenPostParametersReplace
    SharedTopics:
      type: object
      properties:
        segments:
          type: array
          items:
            $ref: '#/components/schemas/SharedTopicsSegmentsItems'
      description: Output whenever `topics=true` is used
      title: SharedTopics
    ListenV1ResponseResults:
      type: object
      properties:
        channels:
          $ref: '#/components/schemas/ListenV1ResponseResultsChannels'
        utterances:
          $ref: '#/components/schemas/ListenV1ResponseResultsUtterances'
        summary:
          $ref: '#/components/schemas/ListenV1ResponseResultsSummary'
        topics:
          $ref: '#/components/schemas/SharedTopics'
        intents:
          $ref: '#/components/schemas/SharedIntents'
        sentiments:
          $ref: '#/components/schemas/SharedSentiments'
      required:
      - channels
      title: ListenV1ResponseResults
    V1ListenPostParametersCustomIntentMode:
      type: string
      enum:
      - extended
      - strict
      default: extended
      title: V1ListenPostParametersCustomIntentMode
    V1ListenPostParametersModel:
      oneOf:
      - $ref: '#/components/schemas/V1ListenPostParametersModel0'
      - type: string
      title: V1ListenPostParametersModel
    SharedSentimentsAverage:
      type: object
      properties:
        sentiment:
          type: string
        sentiment_score:
          type: number
          format: double
      title: SharedSentimentsAverage
    V1ListenPostParametersVersion0:
      type: string
      enum:
      - latest
      description: Use the latest version of a model
      title: V1ListenPostParametersVersion0
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use `Authorization: Token <API_KEY>`

        Example: `Authorization: Token 12345abcdef`

        '
    JwtAuth:
      type: http
      scheme: bearer
      description: 'Use `Authorization: Bearer <JWT>`

        Example: `Authorization: Bearer eyJhbGciOiJ...`

        '