Skip to main content

Radio API

API docs by Redocly

SYNQ Radio API (1.0.0)

Download OpenAPI specification:Download

APIs for interacting with SYNQ Radio.

Play text as audio

This endpoint allows you to play text as audio on the edge device.

Authorizations:
ApiKey
Request Body schema: application/json
required
edgeId
required
string

Unique identifier for the SYNQ Radio edge device.

text
required
string

The text to convert to speech and play as audio.

actor
required
string

The name of the actor responsible for this audio.

process
boolean
Default: false

Indicated whether to process all voice handlers for this message.

Responses

Request samples

Content type
application/json
{
  • "edgeId": "6803a571-8904-441d-b2ec-6886e9307635",
  • "text": "The store will be closing in 10 minutes.",
  • "actor": "My External Application",
  • "process": false
}

Response samples

Content type
application/json
{
  • "success": true
}