Configure Batch

post

https://api.3playmedia.com/v3/batches/{id}/configuration

Configure settings for the batch with the provided ID

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

ID of the batch against which the configurations are to be updated

Body Params

flag_settings

string

enum

Whether flags & uncertain terms should be marked with [? ?] or resolved. 'Standard' allows flags; 'Clean' resolves flags.

Allowed:

transcript_style

string

enum

Whether unnecessary utterances should be removed or kept. 'Clean Read' removes all; 'Verbatim' removes none. 'Verbatim Light' is for Entertainment & Media content.

Allowed:

speaker_identification

string

enum

How to identify speakers

transcription_category

string

enum

Category of the transcription

Allowed:

audio_description_speaker

string

enum

Speaker name for audio description voice synthesis

audio_description_speaking_rate

string

enum

Audio description voice synthesis speaking rate

Allowed:

starting_timecode

string

Default starting timecode for files in this batch. Formatted as hh:mm:ss:ms.

dropframe

boolean

Whether captions are encoded with dropframe timing

frame_rate_from_header

boolean

Whether frame rate should be inferred from the source file header

fps

number

Manually set the frame rate of source files

alignment_review_mode

string

enum

Applicable to alignment service only, determines how to handle possibly suspect automated alignment

Allowed:

encoded_captions_single_line

boolean

Applicable to caption encoding only, determines whether encoded captions should be displayed on a single line only

encoded_captions_font_size

integer

Applicable to open caption encoding only, determines font size for encoded captions

Responses

405

Invalid input

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success