bozonx-stt-gateway-microservice

n8n node for synchronous transcription via STT Gateway microservice (AssemblyAI)

Package Information

Released: 11 mo ago
Downloads: 0 weekly / 36 monthly
Latest Version: 1.0.0
Author: Ivan

Documentation

n8n Node: Bozonx STT Gateway Microservice

Community node for n8n that performs synchronous speech-to-text transcription from a public audio URL via the STT Gateway microservice (default provider: AssemblyAI).

n8n is a fair-code licensed workflow automation platform.

Sections:

Installation

Follow the official community nodes installation guide: https://docs.n8n.io/integrations/community-nodes/installation/

How it works

The node sends a POST request to the microservice endpoint:

POST {{gatewayUrl}}/{{basePath}}/transcribe
Content-Type: application/json

{
  "audioUrl": "https://example.com/audio.mp3",
  "provider": "assemblyai",  
  "restorePunctuation": true,
  "language": "en",
  "formatText": true,
  "apiKey": "YOUR_ASSEMBLYAI_KEY"
}
  • gatewayUrl comes from Credentials. It must include protocol (http/https) and have no trailing slash.
  • basePath is a node parameter. Leading/trailing slashes are ignored. Default: stt/api/v1.
  • If an API Token is provided in Credentials, the node will send Authorization: Bearer <token>. If not provided, no Authorization header is added.

Example successful response (200)

{
  "text": "Transcribed text...",
  "provider": "assemblyai",
  "requestId": "abc123",
  "durationSec": 123.45,
  "language": "en",
  "confidenceAvg": 0.92,
  "wordsCount": 204,
  "processingMs": 8421,
  "punctuationRestored": true
}

Parameters

  • Base Path (string)
    Default: api/v1. Appended to the Gateway URL. Leading/trailing slashes are ignored.

  • Audio URL (string, required)
    Public HTTP(S) URL to the audio file.

  • Provider (options, optional)
    Speech-to-text provider. If omitted, the microservice uses its default provider. Available: assemblyai.

  • Restore Punctuation (boolean)
    Ask the provider to restore punctuation when supported. Default: true.

  • Language (string, optional)
    Explicit language code for the audio, e.g., en, ru, en-US. Value is trimmed and forwarded to the provider as-is. Leave empty to let the provider auto-detect when supported. See AssemblyAI's supported languages: https://www.assemblyai.com/docs/pre-recorded-audio/supported-languages.

  • Format Text (boolean)
    Whether to format text output (punctuation, capitalization). Default: true. When omitted the service still sends format_text: true to AssemblyAI.

  • Provider API Key (string, optional)
    Direct provider API key (BYO) when allowed by service policy.

Credentials

Use the Bozonx Microservices API credentials:

  • Gateway URL (required)
    Base URL of your API Gateway, without the base path (no trailing slash). Example: https://api.example.com.

  • API Token (optional)
    When set, it is added as Authorization: Bearer <token>. If empty, no Authorization header is sent.

You can use expressions and environment variables, e.g.:

  • Gateway URL: {{$env.API_GATEWAY_URL}}
  • API Token: {{$env.API_TOKEN}}

Advanced

  • Continue On Fail is supported in the node Settings. On error the item will return { "error": "..." } and processing will continue for other items.
  • Default headers include Accept: application/json. Request body is JSON.

Compatibility

Built and tested with n8n 1.60.0+.

Resources

Discussion