GET /live/v2/instances
|
Action
Retrieves list of LEXI Translate instances available to your credential set.
get_history |
If set to 1, or omitted, the response will include Translate job history for each
instance. If set to 0, the response will omit Translate job history. Any other value
will return a BAD REQUEST error.
|
|
POST /live/v2/instances/
|
Action
Creates a new instance. Returns a JSON-Serialized instance on completion.
Parameters (JSON)
name (string) |
The LEXI Translate instance name.
While it is not required that the name be unique within your billing group, it is
strongly recommended to avoid operator confusion.
|
engine (string)
|
The LEXI Translate engine.
Currently the following choices are available: google-translate, deepl-translate.
|
translate_from (string) |
The language to translate from. For English, use:
|
translate_to (string) |
The language to translate to. For example, for French:
|
custom_model (string)
|
The Do Not Translate model
defined in your EEG Cloud account to use.
|
glossary_model (string)
|
The Glossary model
defined in your EEG Cloud account to use.
|
translate_decode_608_service (string) |
The source caption service to use.
*Note - Must be different than the destination service.
Values to use:
|
cc_service (string) |
The destination caption service to use.
*Note - Must be different than the source service.
Values to use:
|
display_style (string)
|
Determines the caption advance style - roll-up ("rollup") or pop-on ("popon"). If
not specified, the default output mode is "rollup".
Values to use:
|
all_caps (string) |
Whether captions should be rendered in ALL CAPS or sentence case. *Note - Value must
be sent as a string.
Values to use:
|
tone (string)
|
Adjust the tone of your translations to formal or informal for languages:
de (German), fr (French), it (Italian), ja (Japanese), es (Spanish), nl (Dutch), pl
(Polish), pt (Portuguese Brazilian), and pt-pt (Portuguese European).
Values to use:
- formal (default)
- informal
|
num_rows (string) |
The number of rollup caption rows to use in output captions. *Note - Value must be
sent as a string.
Values to use:
|
base_row (string) |
The base caption row for display.
*Note - Value must be sent as a string.
Values are 1 (top) through 15 (bottom). Please note that the base row will be the
maximum of this value and "num_rows"
|
col_indent (string) |
The number of columns to indent from the left-hand side of screen. Columns are
numbered 1-32 from left to right.
*Note - Value must be sent as a string.
|
icapaccesscode (string) |
The iCap Access Code to use for caption delivery.
*Note - Access Code must be shared with EEGASR / EEG Lexi ASR before LEXI Translate
service can be used.
|
timeout (string) |
The number of seconds (integer value) of silence allowed before iCap will
auto-terminate a job (to reduce billing charges).
*Note - Value must be sent as a string.
Values to use:
- -1 - No timeout. Jobs will run indefinitely until terminated by user.
-
1 and higher - Jobs will auto-terminate if audio is not present for a
specified period of seconds.
|
Denotes an optional parameter.
|
GET /live/v2/instances/:instance_id
|
Action
Retrieves the specified instance.
Parameters (Path)
:instance_id |
The instance_id to retrieve. |
Parameters (Query)
get_history |
If set to 1, or omitted, the response will include Translate job history for this
instance. If set to 0, the response will omit Translate job history. No other values
are supported.
|
|
PUT /live/v2/instances/:instance_id
|
Action
Updates an existing instance and replaces the existing settings. Returns a JSON-Serialized
instance on completion.
Parameters (JSON)
Parameters are identical to the POST request used to create instances (above).
Parameters (Query)
get_history |
If set to 1, or omitted, the response will include Translate job history for this
instance. If set to 0, the response will omit Translate job history. No other values
are supported.
|
|
PATCH /live/v2/instances/:instance_id
|
Action
Modifies an existing instance with select settings. Returns a JSON-Serialized instance on
completion.
Parameters (JSON)
Parameters are identical to the POST request used to create instances (above).
Parameters (Query)
get_history |
If set to 1, or omitted, the response will include Translate job history for this
instance. If set to 0, the response will omit Translate job history. No other values
are supported.
|
|
DELETE /live/v2/instances/:instance_id
|
Action
Deletes the specified instance.
*Note: Instances consume no resources to simply exist, but deleting them can cause you to
lose track of transcripts and job/audit history.
Consider renaming an instance to "{Old Name} - Unused" for 30 days before deleting
instances entirely.
Parameters (Path)
:instance_id |
The instance_id to delete. |
|
POST /live/v2/instances/:instance_id/turn_on
|
Action
Activates the specified :instance_id (instance) to start caption service.
Parameters (Path)
:instance_id |
The instance_id to activate. |
Parameters (JSON)
These are optional parameters that are carried with the instance job into the activity
reports.
initialization_origin (string) |
The origin of the API call. Recommended value: Application/Daemon name. |
initialization_reason (string) |
The reason of the API call. Recommended values: "User initialized" or "Scheduled
Start".
|
Parameters (Query)
get_history |
If set to 1, or omitted, the response will include Translate job history for this
instance. If set to 0, the response will omit Translate job history. No other values
are supported.
|
|
POST /live/v2/instances/:instance_id/turn_off
|
Action
Terminates the specified :instance_id (instance) to cease caption service.
Parameters (Path)
:instance_id |
The instance_id to terminate. |
Parameters (JSON)
These are optional parameters that are carried with the instance job into the activity
reports.
termination_origin (string) |
The origin of the API call. Recommended value: Application/Daemon name. |
termination_reason (string) |
The reason of the API call. Recommended values: "User initialized" or "Scheduled
End".
|
Parameters (Query)
get_history |
If set to 1, or omitted, the response will include Translate job history for this
instance. If set to 0, the response will omit Translate job history. No other values
are supported.
|
|