> ## Documentation Index
> Fetch the complete documentation index at: https://docs.finvera.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Real Time Transcripts

> Enable users to interact with your websockets



## AsyncAPI

````yaml asyncapi/transcripts.yaml stream
id: stream
title: Stream
description: Channel for sending and receiving WebSocket messages
servers:
  - id: production
    protocol: wss
    host: api.finvera.news/delivery
    bindings: []
    variables: []
address: stream
parameters: []
bindings: []
operations:
  - &ref_1
    id: stream.publish
    title: Stream.publish
    description: Send commands to the server
    type: receive
    messages:
      - &ref_3
        id: publish.message
        contentType: application/json
        payload:
          - name: WebSocket Command
            description: Actions to interact with the transcript stream
            type: object
            properties:
              - name: action
                type: string
                enumValues:
                  - list
                  - subscribe
                  - unsubscribe
                  - subscribed
                  - echo
                  - ping
                required: true
              - name: ticker
                type: string
                description: Stock ticker symbol (e.g., AAPL) or '*' for all
                required: false
              - name: message
                type: string
                description: Optional message for echo testing
                required: false
              - name: mock
                type: boolean
                description: Optional boolean for mock testing when no live transcripts.
                required: false
        headers: []
        jsonPayloadSchema:
          type: object
          properties:
            action:
              type: string
              enum:
                - list
                - subscribe
                - unsubscribe
                - subscribed
                - echo
                - ping
              x-parser-schema-id: <anonymous-schema-2>
            ticker:
              type: string
              description: Stock ticker symbol (e.g., AAPL) or '*' for all
              x-parser-schema-id: <anonymous-schema-3>
            message:
              type: string
              description: Optional message for echo testing
              x-parser-schema-id: <anonymous-schema-4>
            mock:
              type: boolean
              description: Optional boolean for mock testing when no live transcripts.
              x-parser-schema-id: <anonymous-schema-5>
          required:
            - action
          x-parser-schema-id: <anonymous-schema-1>
        title: WebSocket Command
        description: Actions to interact with the transcript stream
        example: |-
          {
            "action": "list"
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: publish.message
    bindings: []
    extensions: &ref_0
      - id: x-parser-unique-object-id
        value: stream
  - &ref_2
    id: stream.subscribe
    title: Stream.subscribe
    description: Receive real-time transcript data
    type: send
    messages:
      - &ref_4
        id: subscribe.message
        contentType: application/json
        payload:
          - name: Real-time Transcript
            description: Transcript message received after subscribing
            type: object
            properties:
              - name: call_id
                type: string
                required: false
              - name: transcript_id
                type: string
                required: false
              - name: call_title
                type: string
                required: false
              - name: sentence
                type: string
                required: false
              - name: start_time
                type: string
                required: false
              - name: end_time
                type: string
                required: false
              - name: symbol
                type: string
                required: false
              - name: exchange
                type: string
                required: false
              - name: isin
                type: string
                required: false
              - name: cusip
                type: string
                required: false
              - name: name
                type: string
                required: false
              - name: sequence
                type: integer
                required: false
              - name: status
                type: string
                enumValues:
                  - IN_PROGRESS
                  - COMPLETE
                required: false
              - name: words
                type: array
                required: false
                properties:
                  - name: confidence
                    type: number
                    required: false
                  - name: start
                    type: integer
                    required: false
                  - name: end
                    type: integer
                    required: false
                  - name: text
                    type: string
                    required: false
              - name: confidence
                type: number
                required: false
              - name: speaker
                type: string
                required: false
              - name: type
                type: string
                enumValues:
                  - LIVE
                required: false
              - name: language
                type: string
                required: false
              - name: participants
                type: array
                required: false
                properties:
                  - name: item
                    type: object
                    required: false
              - name: created_time
                type: string
                required: false
        headers: []
        jsonPayloadSchema:
          type: object
          properties:
            call_id:
              type: string
              x-parser-schema-id: <anonymous-schema-7>
            transcript_id:
              type: string
              format: uuid
              x-parser-schema-id: <anonymous-schema-8>
            call_title:
              type: string
              x-parser-schema-id: <anonymous-schema-9>
            sentence:
              type: string
              x-parser-schema-id: <anonymous-schema-10>
            start_time:
              type: string
              format: date-time
              x-parser-schema-id: <anonymous-schema-11>
            end_time:
              type: string
              format: date-time
              x-parser-schema-id: <anonymous-schema-12>
            symbol:
              type: string
              x-parser-schema-id: <anonymous-schema-13>
            exchange:
              type: string
              x-parser-schema-id: <anonymous-schema-14>
            isin:
              type: string
              x-parser-schema-id: <anonymous-schema-15>
            cusip:
              type: string
              x-parser-schema-id: <anonymous-schema-16>
            name:
              type: string
              x-parser-schema-id: <anonymous-schema-17>
            sequence:
              type: integer
              x-parser-schema-id: <anonymous-schema-18>
            status:
              type: string
              enum:
                - IN_PROGRESS
                - COMPLETE
              x-parser-schema-id: <anonymous-schema-19>
            words:
              type: array
              items:
                type: object
                properties:
                  confidence:
                    type: number
                    x-parser-schema-id: <anonymous-schema-22>
                  start:
                    type: integer
                    x-parser-schema-id: <anonymous-schema-23>
                  end:
                    type: integer
                    x-parser-schema-id: <anonymous-schema-24>
                  text:
                    type: string
                    x-parser-schema-id: <anonymous-schema-25>
                x-parser-schema-id: <anonymous-schema-21>
              x-parser-schema-id: <anonymous-schema-20>
            confidence:
              type: number
              x-parser-schema-id: <anonymous-schema-26>
            speaker:
              type: string
              x-parser-schema-id: <anonymous-schema-27>
            type:
              type: string
              enum:
                - LIVE
              x-parser-schema-id: <anonymous-schema-28>
            language:
              type: string
              x-parser-schema-id: <anonymous-schema-29>
            participants:
              type: array
              items:
                type: object
                x-parser-schema-id: <anonymous-schema-31>
              nullable: true
              x-parser-schema-id: <anonymous-schema-30>
            created_time:
              type: string
              format: date-time
              x-parser-schema-id: <anonymous-schema-32>
          x-parser-schema-id: <anonymous-schema-6>
        title: Real-time Transcript
        description: Transcript message received after subscribing
        example: No examples found
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: subscribe.message
    bindings: []
    extensions: *ref_0
sendOperations:
  - *ref_1
receiveOperations:
  - *ref_2
sendMessages:
  - *ref_3
receiveMessages:
  - *ref_4
extensions:
  - id: x-parser-unique-object-id
    value: stream
securitySchemes:
  - id: apiKey
    name: apikey
    type: httpApiKey
    in: query
    extensions: []

````