Version 1.1
Connector Overview: This page documents all 116 actions for the 3playmediaconnector v1.1.
Accounts
GET GET files
/v3/files
Retrieve a list of files from your account, optionally filtered by name or other query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filter files whose name contains the specified string. |
|
|
The response format expected from the API (e.g. application/json). |
Additional Routes (4)
GET List Languages
/v3/languages/
Retrieve a list of supported languages available for transcription and captioning.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Translation Service Options
/v3/translation_service_options/
Retrieve the available translation service options, including source and target language pairs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Turnaround Levels
/v3/turnaround_levels/
Retrieve the list of turnaround level options, indicating processing speed and associated costs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Video Platform Integrations
/v3/video_platform_integrations/
Retrieve the list of supported video platform integrations for direct publishing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Admin (4)
POST Configure Project Settings
/v3/admin/projects/configuration/
Update project configuration settings such as flags, transcript style, speaker identification, and caption encoding options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Set the project's flag settings, such as "none", "profanity", or "political". |
|
|
Specify the transcript style, e.g., "clean_read", "verbatim", or "custom". |
|
|
Enable or disable speaker identification; expected values like "true" or "false". |
|
|
Select the voice for audio description, e.g., "male" or "female". |
|
|
Set the speaking rate for audio description, as a percentage string like "100". |
|
|
Define the starting timecode for the project, formatted as "HH:MM:SS:FF". |
|
|
Specify whether to use dropframe timecode; expects "true" or "false". |
|
|
Automatically detect frame rate from the video file header; expects "true" or "false". |
|
|
Manually set the frames per second value if not detected from header. |
|
|
Set the alignment review mode, e.g., "disabled", "optional", or "required". |
|
|
Use single-line captions in encoded output; expects "true" or "false". |
|
|
Specify the font size for encoded captions, e.g., "small", "medium", "large". |
POST Create Project
/v3/admin/projects/
Create a new project, optionally as a sandbox project, with a specified name and API key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Set to "true" to create a sandbox project for testing. |
|
|
Set the API key to associate with the project. |
|
|
Provide a name for the new project. |
GET List Projects
/v3/admin/projects/
Retrieve a list of all projects, optionally filtered by sandbox status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filter projects by sandbox status; expects "true" or "false". |
|
|
The response format expected from the API (e.g. application/json). |
GET List Projects Configurations
/v3/admin/projects/configuration/1/
Retrieve a list of project configurations for the admin.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Audio Description (17)
POST Cancel Audio Description
/v3/audio_descriptions/audio_description_id/cancel/
Cancel a specific audio description order by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Create Audio Descriptions
/v3/audio_descriptions/order/
Create a new audio description order for a media file with optional settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Enable extended audio description options when set to true. |
|
|
The turnaround level ID determining the processing speed. |
|
|
A callback URL to receive notifications when the order is complete. |
DELETE Delete Audio Description Delivery Route
/v3/audio_descriptions/deliveries/audio_description_delivery_route_id/
Permanently delete a specific audio description delivery route.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Download Audio Description Media
/v3/audio_descriptions/audio_description_id/mix/
Download the mixed audio description media file for a given audio description.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The format of the downloaded media file (e.g., mp4, wav). |
|
|
The response format expected from the API (e.g. application/json). |
GET Download Audio Description Media Audio
/v3/audio_descriptions/audio_description_id/audio/
Download only the audio track of an audio description media file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The audio format to download (e.g., mp3, wav). |
|
|
The response format expected from the API (e.g. application/json). |
GET Download Audio Description Text
/v3/audio_descriptions/audio_description_id/text/
Download the text transcript of an audio description in a specified output format.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the output format for the text file (e.g., SRT, VTT). |
|
|
The response format expected from the API (e.g. application/json). |
PUT Edit Audio Description Delivery Route
/v3/audio_descriptions/deliveries/audio_description_delivery_route_id/
Update the settings of an existing audio description delivery route.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
|
|
The asset identifier for the delivery route. |
|
|
Whether the delivery route is enabled (e.g., "true" or "false"). |
GET GET audio_descriptions
/v3/audio_descriptions
Retrieves a list of audio descriptions, optionally filtered by status or media file batch ID, with pagination and sorting.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
Filters audio descriptions by their current status. |
|
|
Filters audio descriptions by the ID of the associated media file batch. |
|
|
Specifies the field by which to sort the results. |
|
|
Sets the number of items to return per page. |
|
|
Specifies the page number to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Audio Description by ID
/v3/audio_descriptions/live_auto_caption_id/
Retrieves the details of a specific audio description by its live auto caption ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Audio Description Delivery Routes
/v3/audio_descriptions/deliveries/
Lists audio description delivery routes, optionally filtered by ID, name, creation date range, method, or enabled status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their unique ID. |
|
|
Filters delivery routes by their name. |
|
|
Filters delivery routes created before a specified date. |
|
|
Filters delivery routes created after a specified date. |
|
|
Filters delivery routes by the delivery method. |
|
|
Filters delivery routes by whether they are enabled. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Audio Description Meeting Formats
/v3/audio_descriptions/audio_formats/
Lists the available audio description meeting formats.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Audio Description Mix Formats
/v3/audio_descriptions/mix_formats/
Lists the available audio description mix formats.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Audio Description Text Formats
/v3/audio_descriptions/text_formats/
Lists the available audio description text formats.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Audio Descriptions
/v3/audio_descriptions/
Lists all audio descriptions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Audio Description Delivery Route
/v3/audio_descriptions/deliveries/
Creates a new audio description delivery route with the specified method, URL, and user ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Specifies the delivery method for the route. |
|
|
Provide a name for the new project. |
|
|
Specifies the URL for the delivery route. |
|
|
Specifies the user ID associated with the delivery route. |
POST Redeliever Audio Description
/v3/audio_descriptions/audio_description_id/redeliver/
Redeliver an existing audio description, triggering a new processing and delivery of the audio description file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Send Immediate Callback
/v3/audio_descriptions/{audio_description_id}/callback/
Immediately send a callback notification for a specific audio description, useful for testing or forcing a callback retry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
The unique identifier of the audio description to trigger the callback for. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Authentication
GET Authenticate
/v3/authenticate
Authenticate with the 3Play Media API using your credentials and retrieve an access token for subsequent requests.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Cheat Sheets (instructions) (4)
POST Create Cheat Sheet
/v3/cheat_sheets/
Create a new cheat sheet (instructions document) for a resource, optionally attaching content or a PDF.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The content type of the request body, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The ID of the resource the cheat sheet is associated with. |
|
|
The type of resource the cheat sheet applies to. |
|
|
The format or category of the cheat sheet content. |
|
|
The type of service the cheat sheet is intended for. |
|
|
The text or HTML content of the cheat sheet. |
|
|
A PDF file attachment to include with the cheat sheet. |
PUT Edit Cheat Sheet
/v3/cheat_sheets/cheat_sheet_id/
Update an existing cheat sheet by its ID, modifying its content, type, or attachments.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The content type of the request body, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The new format or category of the cheat sheet content. |
|
|
The updated service type the cheat sheet applies to. |
|
|
The revised text or HTML content of the cheat sheet. |
|
|
A new PDF file attachment to replace the existing one. |
GET Get Cheat Sheets by ID
/v3/cheat_sheets/cheat_sheet_id/
Retrieve the details of a specific cheat sheet using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Cheat Sheets
/v3/cheat_sheets/
List all cheat sheets, optionally filtered by resource type, content type, or service type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filter cheat sheets by the type of resource they are associated with. |
|
|
Filter cheat sheets by their content format or category. |
|
|
Filter cheat sheets by the service type they are intended for. |
|
|
The response format expected from the API (e.g. application/json). |
Delivery Routes (4)
DELETE Delete Delivery Route
/v3/transcripts/deliveries/delivery_route_id/
Permanently delete a delivery route by its unique identifier, removing the associated delivery configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
PUT Edit Delivery Route
/v3/transcripts/deliveries/delivery_route_id/
Update an existing delivery route by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
|
|
The asset identifier for the delivery route. |
|
|
Whether the delivery route is enabled (e.g., "true" or "false"). |
GET List Delivery Routes
/v3/transcripts/deliveries/
Retrieve a list of all delivery routes configured for your account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their unique ID. |
|
|
Filters delivery routes by their name. |
|
|
Filters delivery routes created before a specified date. |
|
|
Filters delivery routes created after a specified date. |
|
|
Filters delivery routes by the delivery method. |
|
|
Filters delivery routes by whether they are enabled. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Post Delivery Route
/v3/transcripts/deliveries/
Create a new delivery route for automated transcript delivery.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
The asset identifier for the delivery route. |
|
|
Specifies the delivery method for the route. |
|
|
Provide a name for the new project. |
|
|
Specifies the URL for the delivery route. |
|
|
Specifies the user ID associated with the delivery route. |
Dubbing (4)
POST Create Dub (Download Link)
/v3/dubs/
Initiate a new dubbing job by providing a source media URL and target languages, returning a download link upon completion.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
|
|
A human-readable label for the dubbing job. |
|
|
The URL of the source media file to be dubbed. |
|
|
The name of the folder where the dubbed files will be organized. |
|
|
The language code of the source audio (e.g., 'en'). |
|
|
A comma-separated list of target language codes for dubbing. |
|
|
An optional external identifier to associate with the media. |
|
|
A URL that will be notified when the dubbing job completes. |
GET Download Dubbed Media
/v3/dubs/dub_id/download/
Download the dubbed media file for a specific dubbing job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the output format for the text file (e.g., SRT, VTT). |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify a clip range or identifier to download only a portion of the dubbed media. |
|
|
An offset in seconds to start the download from a specific point in the media. |
GET Get Dub by ID
/v3/dubs/26397824/
Retrieve details of a specific dubbing project by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Dubs
/v3/dubs/
List all dubbing jobs associated with your account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Specifies the field by which to sort the results. |
|
|
Sort the results in ascending or descending order; accepted values are 'asc' or 'desc'. |
|
|
The response format expected from the API (e.g. application/json). |
Folders (batches) (7)
POST Create Batch
/v3/batches
Create a new batch folder to organize media files and their transcriptions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
GET GET batches/:id
/v3/batches/240358
Retrieve details of a specific batch folder by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET GET batches/:id/configuration
/v3/batches/batch_id/configuration
Retrieve the configuration settings for a specific batch folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET List batches
/v3/batches
List all batch folders in your account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST POST batches/:id/configuration
/v3/batches/batch_id/configuration
Update the configuration settings for a specific batch folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Set the project's flag settings, such as "none", "profanity", or "political". |
|
|
Specify the transcript style, e.g., "clean_read", "verbatim", or "custom". |
|
|
Enable or disable speaker identification; expected values like "true" or "false". |
|
|
Specify the transcription category to apply, such as 'meeting' or 'interview'. |
|
|
Select the voice for audio description, e.g., "male" or "female". |
|
|
Set the speaking rate for audio description, as a percentage string like "100". |
|
|
Specify whether to use dropframe timecode; expects "true" or "false". |
|
|
Automatically detect frame rate from the video file header; expects "true" or "false". |
|
|
Manually set the frames per second value if not detected from header. |
|
|
Set the alignment review mode, e.g., "disabled", "optional", or "required". |
|
|
Use single-line captions in encoded output; expects "true" or "false". |
|
|
Specify the font size for encoded captions, e.g., "small", "medium", "large". |
POST POST batches/archive
/v3/batches/archive/
Archive a batch folder to remove it from active view while retaining the data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the ID of the batch folder to archive. |
POST POST batches/unarchive
/v3/batches/unarchive/
Unarchive previously archived batches to restore them to active status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their name. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the ID of the batch folder to archive. |
Glossaries (4)
POST Create Glossary
/v3/glossaries/
Create a new glossary with an optional list of words.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The content type of the request body, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The ID of the resource the cheat sheet is associated with. |
|
|
The type of resource the cheat sheet applies to. |
|
|
A JSON array of word objects to include in the glossary. |
|
|
A new PDF file attachment to replace the existing one. |
GET Get Glossary by ID
/v3/glossaries/glossary_id/
Retrieve details of a specific glossary using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Glossaries
/v3/glossaries/
List all glossaries, optionally filtered by a resource ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filter cheat sheets by the type of resource they are associated with. |
|
|
Filter glossaries associated with a specific resource. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update Glossary
/v3/glossaries/glossary_id/
Update an existing glossary's word list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The content type of the request body, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
A JSON array of word objects to replace the glossary's current word list. |
|
|
A new PDF file attachment to replace the existing one. |
Live Auto Captioning (10)
POST Archive Live Auto Caption
/v3/live_auto_captions/live_auto_caption_id/archive/
Archive a live auto captioning session to remove it from active view.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Cancel Live Auto Caption
/v3/live_auto_captions/live_auto_caption_id/cancel/
Cancel an active live auto captioning session.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
PUT Edit Live Auto Captioning
/v3/live_auto_captions/37029/
Update settings for a live auto captioning session, such as latency and event description.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The desired latency level for the captioning stream. |
|
|
A description of the event being captioned. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Finish Live Auto Caption
/v3/live_auto_captions/live_auto_caption_id/finish/
Finish an active live auto caption session, making the captions final and no longer editable. Use this to stop the live stream of captions and save the final state.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Get Live Auto Caption by ID
/v3/live_auto_captions/live_auto_caption_id/
Retrieve details of a specific live auto caption session by its ID, including its status and configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Whether to include the embedded caption data in the response. Provide a string value such as "true" or "false". |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Live Wordlist
/v3/live_auto_captions/live_auto_caption_id/wordlist/
Retrieve the live wordlist for a specific live auto caption session, showing recognized words and their timings. Use this to monitor caption accuracy in real time.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Get Ordering Help
/v3/live_auto_captions/order_help
Get ordering help information for live auto caption services, such as pricing or availability details. Use this to understand how to place an order.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET List Live Auto Captions
/v3/live_auto_captions/
List all live auto caption sessions, optionally filtered by transcript file, public ID, or time range.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their unique ID. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
Filter by the transcript file ID associated with the session. Provide the file's unique identifier. |
|
|
Filters audio descriptions by their current status. |
|
|
Filter by the public ID of the session. Provide the session's public identifier. |
|
|
Filters delivery routes created before a specified date. |
|
|
Filters delivery routes created after a specified date. |
|
|
Filter sessions that started before a given date and time. Provide a timestamp string in ISO 8601 format. |
|
|
Filter sessions that started after a given date and time. Provide a timestamp string in ISO 8601 format. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Live Auto Captioning
/v3/live_auto_captions/order/
Submit a new order for live auto captioning on a media file or live stream, specifying event details, stream information, and contact information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (24)
|
Option Name |
Description |
|---|---|
|
|
The ID of the media file to be captioned, if captioning a recorded file. |
|
|
The scheduled start time for the live captioning session. |
|
|
The URL of the live stream to be captioned. |
|
|
default: 0 |
|
|
default: 240 |
|
|
default: 30 |
|
|
The ID of the transcoder to use for the live stream. |
|
|
The desired latency level for caption delivery. |
|
|
Values: 0, 1, 2, 3. Default: 1 |
|
|
default: 0 |
|
|
default: false |
|
|
A callback URL to receive notifications when the order is complete. |
|
|
The ID of a wordlist file to use for custom terminology. |
|
|
The type of live event being captioned. |
|
|
default: false |
|
|
A description of the event for the captioner. |
|
|
The names of the speakers in the event. |
|
|
The physical or virtual location of the meeting. |
|
|
Any additional instructions for the captioner. |
|
|
The time the captioner should join the event. |
|
|
Indicates whether the event includes a live stream. |
|
|
The name of the contact person for the order. |
|
|
The email address of the contact person. |
|
|
The phone number of the contact person. |
POST Un-Archive Live Auto Caption
/v3/live_auto_captions/live_auto_caption_id/unarchive/
Un-archive a previously archived live auto caption session, making it active again.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
Live Professional Captioning (11)
POST Archive Live Professional Captions
/v3/live_professional_captions/live_professional_caption_id/archive/
Archive a live professional captioning session to remove it from active view while preserving its data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Cancel Live Professional Captions
/v3/live_auto_captions/live_professional_caption_id/cancel/
Cancel a live professional captioning order that has not yet been fulfilled.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
PUT Edit Live Professional Captioning
/v3/live_professional_captions/33177/
Edit an existing live professional captioning session by updating its start time, latency, sensitivity, event timing, stream reconnection, recording, fallback, and live stream settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The desired start time for the live captioning session, specified as a timestamp string. |
|
|
The response format expected from the API (e.g. application/json). |
Options (19)
|
Option Name |
Description |
|---|---|
|
|
The URL of the live stream to be captioned. |
|
|
The target latency in seconds for delivering captions to viewers. |
|
|
A sensitivity level for filtering offensive words, represented as an integer. |
|
|
The maximum time in seconds to wait before the event starts. |
|
|
The maximum duration in seconds for the live event. |
|
|
The time in seconds to wait before attempting to reconnect a lost stream. |
|
|
Whether to record the live stream for later playback. |
|
|
The ID of a wordlist file to use for custom terminology. |
|
|
The type of live event being captioned. |
|
|
Whether to automatically switch to auto-captioning if professional captioning becomes unavailable. |
|
|
A description of the event for the captioner. |
|
|
The names of the speakers in the event. |
|
|
The physical or virtual location of the meeting. |
|
|
Any additional instructions for the captioner. |
|
|
The time the captioner should join the event. |
|
|
Indicates whether the session has an associated live stream. |
|
|
The name of the contact person for the order. |
|
|
The email address of the contact person. |
|
|
The phone number of the contact person. |
POST Finish Live Professional Captions
/v3/live_auto_captions/live_professional_caption_id/finish/
Finish an active live professional captioning session, ending the delivery of captions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Get Live Professional Captions by ID
/v3/live_professional_captions/live_professional_caption_id/
Retrieve details of a specific live professional captioning session using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Whether to include the embedded caption data in the response. Provide a string value such as "true" or "false". |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Live Wordlist
/v3/live_professional_captions/live_professional_caption_id/wordlist/
Retrieve the current wordlist associated with a live professional captioning session, which may include custom terms and spellings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Get Ordering Help
/v3/live_professional_captions/order_help
Get ordering help information for live professional captioning services, such as pricing and setup instructions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET List Live Professional Captions
/v3/live_professional_captions/
Retrieve a list of all live professional captioning jobs. Use this action to view existing caption orders and their statuses.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Filters delivery routes by their unique ID. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
Filter by the transcript file ID associated with the session. Provide the file's unique identifier. |
|
|
Filters audio descriptions by their current status. |
|
|
Filter by the public ID of the session. Provide the session's public identifier. |
|
|
Filters delivery routes created before a specified date. |
|
|
Filters delivery routes created after a specified date. |
|
|
Filter sessions that started before a given date and time. Provide a timestamp string in ISO 8601 format. |
|
|
Filter sessions that started after a given date and time. Provide a timestamp string in ISO 8601 format. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Live Professional Captioning (Streamless)
/v3/live_professional_captions/order/
Order a new streamless live professional captioning session. This action initiates a one-time captioning event without a live stream.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (25)
|
Option Name |
Description |
|---|---|
|
|
The ID of the media file to be captioned, if captioning a recorded file. |
|
|
The scheduled start time for the live captioning session. |
|
|
[in milliseconds] Default: 0 |
|
|
Indicates whether the event includes a live stream. |
|
|
The physical or virtual location of the meeting. |
|
|
Provide the static embed key code associated with your account to authorize the captioning order. This parameter is optional if your account does not require one. |
|
|
The type of live event being captioned. |
|
|
The time the captioner should join the event. |
|
|
The URL of the live stream to be captioned. |
|
|
default: 30 |
|
|
default: 240 |
|
|
The ID of the transcoder to use for the live stream. |
|
|
The desired latency level for caption delivery. |
|
|
Values: 0, 1, 2, 3. Default: 1 |
|
|
default: 0 |
|
|
default: false |
|
|
A callback URL to receive notifications when the order is complete. |
|
|
The ID of a wordlist file to use for custom terminology. |
|
|
default: false |
|
|
A description of the event for the captioner. |
|
|
The names of the speakers in the event. |
|
|
Any additional instructions for the captioner. |
|
|
The name of the contact person for the order. |
|
|
The email address of the contact person. |
|
|
The phone number of the contact person. |
POST Order Recurring Live Professional Captioning (Streamless)
/v3/live_professional_captions/order_recurring/
Order a recurring streamless live professional captioning session. Use this action to set up a repeating captioning schedule for events that occur regularly.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The type of live event being captioned. |
|
|
Specify the estimated duration of each captioning session in minutes. This helps allocate resources appropriately. |
|
|
The physical or virtual location of the meeting. |
|
|
Provide a name for the new project. |
|
|
Provide the static embed key code associated with your account to authorize the recurring captioning order. This parameter is optional if your account does not require one. |
|
|
The name of the contact person for the order. |
|
|
The phone number of the contact person. |
|
|
Any additional instructions for the captioner. |
POST Un-Archive Live Professional Captions
/v3/live_professional_captions/live_professional_caption_id/unarchive/
Restore a previously archived live professional captioning job. Use this action to make an archived captioning job active again.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
Live Transcoders
GET List Transcoders
/v3/live_transcoders/
Retrieve a list of all live transcoders configured in your account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
Media Files (11)
POST Add Source URL to 3Play Media File
/v3/files/9204869/source/set_url
Add a source URL to an existing 3Play Media file to specify the media source.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The URL of the source media to associate with the file. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Archive File(s)
/v3/files/archive
Archive one or more media files to remove them from active use while preserving the data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The response format expected from the API (e.g. application/json). |
POST Create Media File (Download URL)
/v3/files/
Create a new media file by providing a download URL and optional metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
|
|
Optional. The language identifier for the media file's primary language. |
|
|
The URL of the source media file to be dubbed. |
|
|
Provide the ID of the batch folder to archive. |
|
|
Optional. A custom label to identify the media file. |
|
|
Optional. A custom attribute value for the media file. |
|
|
Optional. A second custom attribute value for the media file. |
|
|
Optional. A third custom attribute value for the media file. |
|
|
Optional. An external reference identifier for the media file. |
|
|
Optional. The integration identifier associated with the media file. |
|
|
Optional. The parent identifier for the media file in the VIC system. |
GET Get Media File by ID
/v3/files/media_file_id
Retrieve detailed information about a specific media file using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Media Files
/v3/files/
List all media files associated with your account, with optional filtering via query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Specifies the field by which to sort the results. |
|
|
Sort the results in ascending or descending order; accepted values are 'asc' or 'desc'. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove Source File/Url from 3Play Media File
/v3/files/5649163/source
Remove the source file or URL associated with a specific media file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Set File Language
/v3/files/9204794/set_language
Set the language of a media file by specifying a language ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The numeric identifier of the language to assign to the file. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Set File Settings
/v3/files/9204794/configuration
Update configuration settings for a media file, such as transcription preferences or notification options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Unarchive File(s)
/v3/files/unarchive
Restore archived media files to make them accessible again.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update Media File
/v3/files/media_file_id/
Modify details of an existing media file, such as its name or metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The content type of the request body, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
POST Upload Source File to 3Play Media File
/v3/files/9204797/source
Upload a source video or audio file to an existing 3Play Media file entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
Metadata
GET List turnaround levels
/v3/turnaround_levels
Retrieve a list of available turnaround levels with their associated pricing and delivery times.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
A flag to include pricing information in the response; set to 'true' to include prices. |
|
|
The response format expected from the API (e.g. application/json). |
Orders (bulk)
POST Place Bulk Order
/v3/orders/bulk/
Create a bulk order for multiple files and services in a single request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
An array of file identifiers to include in the bulk order. |
|
|
An array of service identifiers to apply to the files in the bulk order. |
|
|
A callback URL to receive notifications when the order is complete. |
|
|
Provide the ID of the batch folder to archive. |
Subtitles (4)
POST Create Sub (Download Link)
/v3/subs/
Create a subtitle download link for a media file. Use this to generate a URL that can be used to download subtitles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Provide a name for the new project. |
|
|
A human-readable label for the dubbing job. |
|
|
The language code of the source audio (e.g., 'en'). |
|
|
A comma-separated list of target language codes for dubbing. |
|
|
The URL of the source media file to be dubbed. |
|
|
An optional external identifier to associate with the media. |
|
|
The name of the folder where the dubbed files will be organized. |
|
|
A URL that will be notified when the dubbing job completes. |
GET Download Subbed Media
/v3/subs/12345/download/
Download the subtitled media file for a specific subtitle record. Use this to retrieve the media with embedded subtitles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the output format for the text file (e.g., SRT, VTT). |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify a clip range or identifier to download only a portion of the dubbed media. |
|
|
An offset in seconds to start the download from a specific point in the media. |
GET Get Sub by ID
/v3/subs/26398274/
Retrieve details of a single subtitle record by its unique identifier. Use this to get information about a specific subtitle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Subs
/v3/subs/
Retrieve a list of all subtitle records. Use this to browse or search through available subtitles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Specifies the field by which to sort the results. |
|
|
Sort the results in ascending or descending order; accepted values are 'asc' or 'desc'. |
|
|
The response format expected from the API (e.g. application/json). |
Transcripts (23)
POST Cancel Transcript
/v3/transcripts/27343205/cancel/
Cancel a transcript that is currently in progress. Use this to stop an ongoing transcription job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Download Transcript
/v3/transcripts/16832223/download/
Download the transcript file for a specific transcript record. Use this to retrieve the completed transcript text.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the output format for the text file (e.g., SRT, VTT). |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify a clip range or identifier to download only a portion of the dubbed media. |
|
|
An offset in seconds to start the download from a specific point in the media. |
GET Get Available Output Formats
/v3/transcripts/output_formats/
Retrieve a list of output formats available for transcript downloads. Use this to see which file formats are supported.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Get Expiring Editing Link
/v3/transcripts/27343176/expiring_editing_link/
Retrieve an expiring editing link for a transcript, optionally specifying the number of hours until the link expires.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
Specify the number of hours until the editing link expires. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Get Formatted Text for Transcript
/v3/transcripts/16832223/text/
Retrieve the formatted text of a specific transcript.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the output format for the text file (e.g., SRT, VTT). |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify a clip range or identifier to download only a portion of the dubbed media. |
|
|
An offset in seconds to start the download from a specific point in the media. |
GET Get Transacript by ID
/v3/transcripts/transcript_id/
Retrieve details of a specific transcript by its ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Transcripts
/v3/transcripts/
List all transcripts associated with the account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Make Transacript Default
/v3/transcripts/27343206/make_default/
Set a specific transcript as the default transcript for its media file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order ASR Service
/v3/transcripts/order/asr/
Submit an order for automatic speech recognition (ASR) service for a transcript.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A callback URL to receive notifications when the order is complete. |
GET Order ASR Service Help
/v3/transcripts/order/asr/help/
Retrieve help information about ordering the ASR service.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Alignment Service
/v3/transcripts/order/alignment/
Submit an order for alignment service, optionally providing source text for alignment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
Provide the source text to be used for alignment. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Order Alignment Service Help
/v3/transcripts/order/alignment/help/
Retrieve help information about ordering the alignment service.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Caption Import Service
/v3/transcripts/order
Order a caption import service for a transcript. Use this action to submit a request to import captions from an external file or source.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The language identifier for the caption import, specifying the language of the captions. |
|
|
A boolean flag indicating whether to automatically insert paragraph breaks in the imported captions. |
|
|
The path or identifier of the caption file to import. |
GET Order Caption Import Service Help
/v3/transcripts/order/import/help/
Retrieve help information for the caption import service ordering endpoint. Use this action to get guidance on how to use the import service.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Transcript Service
/v3/transcripts/order/transcription/
Order a transcription service for a media file. Use this action to submit a request for automatic or manual transcription.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Order Transcript Service Help
/v3/transcripts/order/transcription/help/
Retrieve help information for the transcription service ordering endpoint. Use this action to get guidance on how to order transcriptions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Translation Service
/v3/transcripts/order/translation/
Order a translation service for an existing transcript. Use this action to submit a request for translation of a transcript into another language.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The identifier of the translation service option to use, such as language pair or service tier. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
GET Order Translation Service Help
/v3/transcripts/order/translation/help/
Retrieve help information for the translation service ordering endpoint. Use this action to get guidance on how to order translations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Order Video Clip Captioning Service
/v3/transcripts/order/vicc/
Order a video clip captioning service. Use this action to submit a request to add captions to a video clip.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The ID of the media file to create audio descriptions for. |
|
|
The identifier of the parent media file that the video clip belongs to. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
A callback URL to receive notifications when the order is complete. |
GET Order Video Clip Captioning Service Help
/v3/transcripts/order/vicc/help/
Retrieve help information for the video clip captioning service ordering endpoint. Use this action to get guidance on how to order video clip captioning.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Retry Rejected Transcript
/v3/transcripts/27343206/retry/
Resubmit a previously rejected transcript for reprocessing. Use this action when a transcript has been marked as rejected and you want to retry the transcription.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Send Immediate Callback
/v3/transcripts/{transcriptid}/callback/
Trigger an immediate callback for a transcript. Provide the unique identifier of the transcript to send the callback notification.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
The unique identifier of the transcript for which to send the callback. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
POST Update Transcript Turnaround Level
/v3/transcripts/27343205/upgrade_turnaround_level/
Change the turnaround level for a specific transcript to expedite or delay its completion. Use this action to adjust the priority of a transcript's processing.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The identifier of the desired turnaround level to apply to the transcript. Pass this value as a query parameter. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Additional options for the delivery route deletion. |
Translation Profile (4)
POST Create Translation Profile
/v3/translation_profile/
Create a new translation profile with specified preferences and settings. Use this action to configure translation vendor, approval rules, branding, and other options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the translation vendor to use for this profile. |
|
|
Indicate whether translations should be automatically approved (true or false). |
|
|
A description of your business to guide translation style. |
|
|
A description of your target audience for the translation. |
|
|
The desired tone of the translated content (e.g., formal, informal). |
|
|
The format in which the translation should be delivered (e.g., SRT, VTT). |
|
|
Specify grammar preferences for the translation. |
|
|
Provide sample translations to guide the vendor's style. |
|
|
Instructions or files for company branding to be applied in the translation. |
|
|
A list of terms and phrases with preferred translations. |
|
|
A URL link to an external glossary for the translation. |
PUT Edit Translation Profile
/v3/translation_profile/
Update an existing translation profile with new settings. Use this action to modify translation preferences without recreating the profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
The identifier of the translation vendor to use for this profile. |
|
|
Indicate whether translations should be automatically approved (true or false). |
|
|
A description of your business to guide translation style. |
|
|
A description of your target audience for the translation. |
|
|
The desired tone of the translated content (e.g., formal, informal). |
|
|
The format in which the translation should be delivered (e.g., SRT, VTT). |
|
|
Specify grammar preferences for the translation. |
|
|
Provide sample translations to guide the vendor's style. |
|
|
Instructions or files for company branding to be applied in the translation. |
|
|
A list of terms and phrases with preferred translations. |
|
|
A URL link to an external glossary for the translation. |
GET List Translation Profile Options
/v3/translation_profile/profile_options/
Retrieve the available options for configuring a translation profile. Use this action to see valid values for translation vendors, formats, and other settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Translation Profiles
/v3/translation_profile/
Retrieve a list of all translation profiles available in your account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide an array of key-value pairs to add custom query parameters to the request. |
|
|
Provide your API key to authenticate the request. |
|
|
The response format expected from the API (e.g. application/json). |