Bitfocus AS
logo
logo
Bitfocus AS
logo
logo
Sign upSign in

Loading...

Bitfocus

Subscribe to our newsletter

The latest news, articles, and resources, sent to your inbox.

FacebookInstagramGitHubYouTubeLinkedIn

Products

  • Buttons
  • Companion

Integrations

  • Supported Devices
  • Developer Community
  • Connection Development

Support

  • Support Overview
  • Documentation
  • Video Tutorials
  • Community Forum

Sales

  • Resellers & Integrators
  • Buttons Pricing

Updates

  • Case Studies
  • Events & Trade Shows
  • Press Releases
  • Product Updates
  • Webinars

Legal

  • Legal Overview
  • Privacy Policy
  • Buttons EULA
  • Terms & Cookie Policy

Company

  • About us
  • Press kit
  • Careers

© 2026 Bitfocus AS. All rights reserved.

  1. Connections
  2. CaptionKit - API

CaptionKit

API

Communityv1.2.0Updated 3 months ago
DocumentationReport an issueView on GitHub

Documentation

CaptionKit

CaptionKit provides realtime captions and translations for your church, to help provide accessible services with multilingual and hard-of-hearing congregations.

This module will allow you to use CaptionKit signals to remotely control your CaptionKit dashboard or app. You can use signals to start and stop captions, set the language, control caption visibility and more.

To get started, create an API key in the CaptionKit dashboard. Then, in Companion, add this module under Connections, and in the connection configuration paste the API key.

There are CaptionKit presets provided for all signals, or you can use the "Send signal" and "Set transcription language" actions as part of more complex buttons.

Live session status

The module polls your account's caption session status (every 5 seconds by default — configurable in the connection settings) and exposes it as feedbacks and variables:

  • Caption session is live feedback — turns a button red while captions are running. The "Caption status" preset gives you a ready-made tally button, and the start/stop caption presets light up while live.
  • Variables for the session status (status_text, language, translations, session_id, started_at) that you can place on any button label.

Major Changes

  • v1.0.x - Initial release
  • v1.1.x - Obtain list of input languages from CaptionKit's API, rather than them being hard-coded
  • v1.2.x - Live caption session status: status polling, feedbacks, variables and a status preset; API calls now target api.captionkit.com

Details

Manufacturer
CaptionKit
Product
API
Latest Version
v1.2.0
Author
Richard Huss
Contributors
hussra(23)
james-hunt(1)

Open Issues and Requests

iAmCLY#44 [Feature]: Set voice translation language from the APIhussra#25 [Feature]: "Starting soon" and "Captions hidden" feedbacks

To file a new issue, you need to sign up for a user on GitHub.

Go to GitHub issues →

In other news

Buttons v1.8 Main with text

Buttons v1.8

October 2, 2026

Buttons v1.8 IBC award win

Bitfocus wins IBC2026 Best of Show Award for latest Buttons enhancements

September 21, 2026

Buttons v1.8 grey background

Biggest functionality boost yet makes Buttons the perfect platform for broadcast and media management

September 10, 2026

Vivid Buttons on screen

Bitfocus Buttons makes complex OB production feel simple

August 10, 2026

View all news →