StreamStateDto

Vatis Tech Documentation

Here you will find everything you need to know to get started with Vatis Streams.

Getting started

Get the API key to gain access to the Vatis Streams API

Get API access

Auto-detect and switch between spoken language in your audio content

Multilingual Code Switch

Use the utterance end flag to detect the end of speech

Utterance End

Summarization

Perform sentiment analysis over your content

Sentiment Analysis

Ask Anything

Data retention policy of the Vatis Streams API

Data retention

Overview of the stream configuration templates

Stream templates

Customizing stream execution with configuration patches

Configuration patches

Listen to events on your resources with webhooks.

Webhooks

Export results from one or multiple streams in various formats

Export

Perform real-time operations with Vatis Streams websocket API

Websocket

Introduction

Authentication

Authenticate

Upload

Find all streams the current user has access to in a paginated manner

Find all

Find by id

Cancels a stream. This operation can be performed by a gateway, on behalf of the user

Cancel

Get components

Finds all webhook endpoints of the current user.

Create/update

Enables or disables a webhook endpoint. A disabled webhook won't be notified.

Toggle endpoint

Find by ID

Delete

Finds all supported events for webhook endpoints.

Get available event type

Exports results of one or more streams in various formats

Get the usage of all processors in a stream

Stream usage

Retrieve usage report for a given time interval

Usage report

Retrieves all the stream configuration templates the user can access in a paginated manner

Retrieves the stream configuration template with patches applied.

Patch by id

Retrieves all the processor declarations the user can access in a paginated manner

API Reference

Blog

Dashboard

Support

Get started with the Vatis Streams API for pre-recorded content

Getting Started

Overview of the Pre-recorded API features.

Features

List of supported transcription languages

Transcription languages

Pre-recorded transcription specifications using the Vatis Streams API

Pre-recorded Transcription

Pre-recorded transcription with speaker diarization specifications using the Vatis Streams API

Speaker Diarization

Start using the Vatis Streams API for real-time processing

Real-time transcription specifications using the Vatis Streams API

Real-time Transcription

Debug a failed stream by inspecting its errors

Inspect errors

Overview of the main flows and components of the system

System overview

Overview of the possible methods to export results from a batch job

API Documentation

Schemas

Authentication

Gateway

Streams

Webhooks

Export

Usage

Stream configuration

Processor

StreamStateDto