Postman Collection
API Reference

Create Live Event

post
https://api.3playmedia.com/v3/live/events

Schedule a new live captioning event.

Routing rules:

  • Automatic captioning requires an rtmp_stream audio source with embed destinations only
  • Professional captioning accepts an rtmp_stream audio source with embed destinations, or a phone, url, or icap audio source with encoder destinations (icap, telnet)
  • Encoder destinations cannot be combined with an rtmp_stream audio source
  • embed destinations are only delivered for rtmp_stream events. With a phone, url, or icap audio source they are ignored and not returned.
  • wordlists, speaker_names, and offensive_words_sensitivity have no effect with a phone, url, or icap audio source

Machine translation: machine_translation_languages orders real-time machine translation for viewers of the 3Play embed. Viewers choose a language in the embed's accessibility menu. Translation is available only for rtmp_stream events with embed destinations, and must be enabled for the account by 3Play. Translations are machine-generated and are not a substitute for human translation.

Validation errors return 422 with one item per problem. Machine translation errors use field machine_translation_languages:

MessageCause
is not enabled for this projectMachine translation is not enabled for the account
is only available for events with an rtmp_stream audio source and embed destinationsThe event uses a phone, url, or icap audio source or an encoder destination
must be supported translation languages (unsupported: ...)A code is not in the supported list
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Type of captioning service

Allowed:
string
required

Display name for the event

string
required

Event start time in ISO 8601 format

integer
required

Expected event length in minutes. Must be greater than 0.

integer
≥ 0

Minutes the system or captioner should be ready before the event starts (default 0)

string
enum
required

Genre of the event

audio_source
required

Audio source configuration. Automatic captioning requires rtmp_stream.

destinations
array of objects
required
length ≥ 1

Where captions are delivered. At least one destination is required.

destinations*

3Play caption embed player destination

string
enum
required
Allowed:
integer
2 to 60

Delay in seconds before captions appear (2–60)

string

Key of an existing project static embed key to reuse, so the embed code stays the same across events. Create only; ignored on update. Ignored if no matching key exists in the project.

string

Free-text event description

speaker_names
array of strings

Names of event speakers

speaker_names
wordlists
array of strings

Custom vocabulary words for improved recognition accuracy

wordlists
contact
object

Event contact information. When provided in a request, name is required and at least one of email or phone must be included.

string

Source language code (default en). Supported codes depend on the event:

  • Automatic captioning: en, plus any additional source languages enabled for the account
  • Professional captioning with an rtmp_stream audio source: not accepted; any value returns is not supported for this order type
  • Professional captioning with a phone, url, or icap audio source: the languages supported for that event type

An unsupported code returns a 422 that lists the supported codes.

string

Target language code (default en). Validated against the same codes as source_language.

machine_translation_languages
array of strings

Target languages for real-time machine translation, as language codes. Duplicates and blank values are ignored.

CodeLanguage
es-ESSpanish (Spain)
es-419Spanish (Latin America)
pt-BRPortuguese (Brazil)
pt-PTPortuguese (Portugal)
fr-FRFrench (France)
fr-CAFrench (Canada)
zh-CNChinese (Simplified)
koKorean
viVietnamese
ruRussian
tlTagalog
hawHawaiian
arArabic
machine_translation_languages
string
enum

Sensitivity level for filtering offensive words

Allowed:
string

HTTP or HTTPS URL that receives a POST when the event finishes. The body is the event object, including downloads and usage, without the code/data response envelope. On update, a blank value removes the callback.

Responses

Updated 10 days ago

Did this page help you?
Language
Credentials
Query
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?