Notable changes made to the Wordly API

Version: 1.5.2

Release date: June 23, 2023


  • Minor internal changes with no impact to users.

Version: 1.5.1

Release date: June 8, 2023


  • Added more robust error handling when API key authorization fails.

Version: 1.5.0

Release date: April 21, 2023

What’s New

  • Security and dependency updates.

Version: 1.4.0

Release date: March 17, 2023

What’s New

  • Added a Captions API that will generate live captions from an ongoing Wordly session that will be distributed to a provided webhook URL. See the REST API help page and API reference for more information on captioning.
  • API service version is now visible on the reference page.

Version: 1.3.1

Release date: March 7, 2023


  • Fixed an issue where certain internal server errors would generate the wrong API error response for consumers.

Version: 1.3.0

Release date: February 16, 2023

What’s New

  • Added a voicePackId field to the Sessions API that allows for a voice pack to be optionally specified when creating and updating sessions. See the REST API help page and API reference for more information on voice packs.

    Existing sessions created before this change will automatically use a default voice pack.

Version: 1.2.0

Release date: January 30, 2023

What’s New

  • Added a field to the glossary section object called substitutedPhrases. This field holds a map of replacement rules that can be seen in the Replace tab in the Portal.
  • Check out the API reference for more information.

Version: 1.1.2

Release date: September 23, 2022

What’s New

  • Added support for five new languages listed in the table below. These languages can now be used when creating/updating sessions, glossaries, or streams.
Language Language Code
Czech cs
Indonesian id
Romanian ro
Thai th
Vietnamese vi

Version: 1.1.1

Release date: September 16, 2022


  • (BREAKING) Updated the POST /sessions request so that the language code is now required.
  • Updated the documentation for the streaming API found on the API reference page. The documentation now includes more detailed information.
  • The default limit for both GET /sessions and GET /glossaries is now 10.
  • Updated the error message when a blank search term is provided when sending a GET /glossaries or GET /sessions request.


  • Fixed an issue with the POST /sessions API where an error was returned when a user submitted a scheduledStart value in the request body that included a timezone offset (e.g., 2022-09-22T10:00:00-0700). Now, start times that include a timezone offset should work and no longer return an error.
  • Added constraints to the GET /sessions request so that an error is returned if the page or limit query parameter is set to a value less than 1.

Version: 1.1.0

Release date: September 9, 2022

What’s New

  • Added a new API for streaming media content to Wordly. Check out the API reference for more information.

Version: 1.0.0

Release date: August 15, 2022

What’s New

  • 🎉 Initial release! CRUD operations for sessions and glossaries.