---
title: "WebSocket API"
slug: "websocket-api"
updated: 2026-02-26T08:22:22Z
published: 2026-02-26T08:22:22Z
---

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

# WebSocket API

Composer provides a WebSocket API for real-time, bidirectional communication between Composer and external applications. This is ideal for scenarios requiring live updates or continuous data streams.

Composer currently exposes WebSocket communication for [Inputs & Audio](/v1/docs/inputs-audio) and [Log files](/v1/docs/log-files).

Please refer to [Settings - Web API](/v1/docs/settings-web-api) for information on enabling and configuring websockets.

Integration Guide

For an overview of the different options for integrating Composer, see the [Integration Guide](/v1/docs/integration-guide).

## Examples

Please refer to the [Vindral Composer WebSocket client](https://github.com/vindral-oss/vindral-composer-ws-client) web application to try it out yourself. It shows how to connect, subscribe, and handle incoming and outgoing messaging.

![2026-01-20_2202x1085_scrot.png](https://cdn.document360.io/94808959-fd66-406c-ab5e-4691ce952a14/Images/Documentation/2026-01-20_2202x1085_scrot.png)

It is especially useful to help understand how to construct message objects for writing.

## Notes

### Remote WS access

Due to limitations in the underlying WS-library; the **Hostname** must be set to the IP address in the [Settings - Web API](/v1/docs/settings-web-api).

### Using secure WebSockets

In order to use secure websockets (WSS); use our (Docker) [nginx proxypass solution](https://github.com/RealSprint/composer-wss-nginx-proxypass).