Speechmatics CLI Tool¶

CLI for Speechmatics products.

usage: speechmatics [-h] [-v] [--debug] [--ctrl CTRL] {rt,batch,transcribe,config} ...

Named Arguments¶

-v

Set the log level for verbose logs. The number of flags indicate the level, eg. -v is INFO and -vv is DEBUG.

Default: 0

--debug

Prints useful symbols to represent the messages on the wire. Symbols are printed to STDERR, use only when STDOUT is redirected to a file.

Default: False

--ctrl

Speechmatics internal use.

Mode¶

mode: Possible choices: rt, batch, transcribe, config

Sub-commands¶

rt¶

Real-time commands

speechmatics rt [-h] {transcribe} ...

Commands¶

command: Possible choices: transcribe

Sub-commands¶

transcribe¶

Transcribe an audio file or stream in real time and output the results to the console.

speechmatics rt transcribe [-h] [--streaming-mode] [--enable-partials] [--enable-transcription-partials] [--enable-translation-partials] [--punctuation-sensitivity PUNCTUATION_SENSITIVITY] [--speaker-diarization-max-speakers SPEAKER_DIARIZATION_MAX_SPEAKERS]
                           [--speaker-change-sensitivity SPEAKER_CHANGE_SENSITIVITY] [--speaker-change-token] [--max-delay MAX_DELAY] [--max-delay-mode {fixed,flexible}] [--raw ENCODING] [--sample-rate SAMPLE_RATE] [--chunk-size CHUNK_SIZE]
                           [--buffer-size BUFFER_SIZE] [--print-json] [--diarization {none,speaker,speaker_change}] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] [--config-file CONFIG_FILE]
                           [--lang LANGUAGE] [--operating-point {standard,enhanced}] [--domain DOMAIN] [--output-locale LOCALE] [--additional-vocab [ADDITIONAL_VOCAB [ADDITIONAL_VOCAB ...]]] [--additional-vocab-file VOCAB_FILEPATH]
                           [--punctuation-permitted-marks PUNCTUATION_PERMITTED_MARKS] [--enable-entities] [--translation-langs TRANSLATION_TARGET_LANGUAGES] [--langid-langs LANGID_EXPECTED_LANGUAGES]
                           FILEPATHS [FILEPATHS ...]

Positional Arguments¶

FILEPATHS: File(s) to process.

Named Arguments¶

--streaming-mode

Whether to run the engine in streaming mode. Internal Speechmatics use only.

Default: False

--enable-partials

Whether to return partials for both transcripts and translation which can be updated by later,final transcripts.

Default: False

--enable-transcription-partials

Whether to return partial transcripts which can be updated by later,final transcripts.

Default: False

--enable-translation-partials

Whether to return partial translation which can be updated by later,final translation.

Default: False

--punctuation-sensitivity

Sensitivity level for advanced punctuation.

--speaker-diarization-max-speakers

Enforces the maximum number of speakers allowed in a single audio stream. Min: 2, Max: 20, Default: 20.

--speaker-change-sensitivity

Sensitivity level for speaker change.

--speaker-change-token

Shows a <sc> token where a speaker change was detected.

Default: False

--max-delay

Maximum acceptable delay before sending a piece of transcript.

--max-delay-mode

Possible choices: fixed, flexible

How to interpret the max-delay size if speech is inthe middle of an unbreakable entity like a number.

Default: “flexible”

--raw

Indicate that the input audio is raw, provide the encodingof this raw audio, eg. pcm_f32le.

--sample-rate

The sample rate in Hz of the input audio, if in raw format.

Default: 44100

--chunk-size

How much audio data, in bytes, to send to the server in each websocket message. Larger values can increase latency, but values which are too small create unnecessary overhead.

Default: 4096

--buffer-size

Maximum number of messages to send before waiting foracknowledgements from the server.

Default: 512

--print-json

Print the JSON partial & final transcripts received rather than plaintext messages.

Default: False

--diarization

Possible choices: none, speaker, speaker_change

Which type of diarization to use.

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--config-file

Read the transcription config from a file. If you provide this, all other config options work as overrides.

--lang, --language

Language (ISO 639-1 code, e.g. en, fr, de).

--operating-point

Possible choices: standard, enhanced

Selects the acoustic model configuration. “enhanced” is more computationally expensive than “standard” but should result in a more accurate transcript.

--domain

Optionally request a specialized language pack, e.g. ‘finance’

--output-locale

Locale of the output of transcripts. eg. en-US.

--additional-vocab

Space separated list of additional vocab. Expected format: <content (required)>:<sounds like (optional)>,<anymore sounds like> Simple vocab list example: ‘Speechmatics gnocchi’. Vocab list with sounds like example: ‘gnocchi:nokey,nochi’.

--additional-vocab-file

File with additional vocab in JSON format.

--punctuation-permitted-marks

Space-separated list of permitted punctuation marks for advanced punctuation.

--enable-entities

Whether to output additional information about recognisedentity classes (JSON output only).

Default: False

--translation-langs, --translation-languages

Comma-separated list of languages to translate the transcription into

--langid-langs, --langid-languages

Comma-separated list of expected languages for language identification

batch¶

Batch commands

speechmatics batch [-h] {transcribe,submit,list-jobs,get-results,delete,job-status} ...

Commands¶

command: Possible choices: transcribe, submit, list-jobs, get-results, delete, job-status

Sub-commands¶

transcribe¶

Transcribe one or more audio files using batch mode, while waiting for results.

speechmatics batch transcribe [-h] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] [--config-file CONFIG_FILE] [--lang LANGUAGE] [--operating-point {standard,enhanced}] [--domain DOMAIN]
                              [--output-locale LOCALE] [--additional-vocab [ADDITIONAL_VOCAB [ADDITIONAL_VOCAB ...]]] [--additional-vocab-file VOCAB_FILEPATH] [--punctuation-permitted-marks PUNCTUATION_PERMITTED_MARKS] [--enable-entities]
                              [--translation-langs TRANSLATION_TARGET_LANGUAGES] [--langid-langs LANGID_EXPECTED_LANGUAGES] [--output-format {txt,json,json-v2,srt}] [--speaker-diarization-sensitivity SPEAKER_DIARIZATION_SENSITIVITY]
                              [--diarization {none,speaker,channel,channel_and_speaker_change}] [--channel-diarization-labels CHANNEL_DIARIZATION_LABELS [CHANNEL_DIARIZATION_LABELS ...]] [--summarize] [--summary-content-type {informative,conversational,auto}]
                              [--summary-length {brief,detailed}] [--summary-type {paragraphs,bullets}] [--sentiment-analysis] [--topic-detection] [--topic-detection-topics TOPICS]
                              FILEPATHS [FILEPATHS ...]

Positional Arguments¶

FILEPATHS: File(s) to process.

Named Arguments¶

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--config-file

Read the transcription config from a file. If you provide this, all other config options work as overrides.

--lang, --language

Language (ISO 639-1 code, e.g. en, fr, de).

--operating-point

Possible choices: standard, enhanced

Selects the acoustic model configuration. “enhanced” is more computationally expensive than “standard” but should result in a more accurate transcript.

--domain

Optionally request a specialized language pack, e.g. ‘finance’

--output-locale

Locale of the output of transcripts. eg. en-US.

--additional-vocab

Space separated list of additional vocab. Expected format: <content (required)>:<sounds like (optional)>,<anymore sounds like> Simple vocab list example: ‘Speechmatics gnocchi’. Vocab list with sounds like example: ‘gnocchi:nokey,nochi’.

--additional-vocab-file

File with additional vocab in JSON format.

--punctuation-permitted-marks

Space-separated list of permitted punctuation marks for advanced punctuation.

--enable-entities

Whether to output additional information about recognisedentity classes (JSON output only).

Default: False

--translation-langs, --translation-languages

Comma-separated list of languages to translate the transcription into

--langid-langs, --langid-languages

Comma-separated list of expected languages for language identification

--output-format

Possible choices: txt, json, json-v2, srt

Transcript output format.

Default: “txt”

--speaker-diarization-sensitivity

The sensitivity of the speaker detection. Default is 0.5 .

--diarization

Possible choices: none, speaker, channel, channel_and_speaker_change

Which type of diarization to use.

--channel-diarization-labels

Add your own speaker or channel labels to the transcript. Example usage: –channel-diarization-labels label1 label2

--summarize

Whether to generate transcript summarization

Default: False

--summary-content-type

Possible choices: informative, conversational, auto

--summary-length

Possible choices: brief, detailed

--summary-type

Possible choices: paragraphs, bullets

--sentiment-analysis

Perform sentiment analysis on the transcript

Default: False

--topic-detection

Whether to detect topics in transcript

Default: False

--topic-detection-topics

Comma-separated list of topics for topic detection

submit¶

Submit one or more files for transcription.

speechmatics batch submit [-h] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] [--config-file CONFIG_FILE] [--lang LANGUAGE] [--operating-point {standard,enhanced}] [--domain DOMAIN]
                          [--output-locale LOCALE] [--additional-vocab [ADDITIONAL_VOCAB [ADDITIONAL_VOCAB ...]]] [--additional-vocab-file VOCAB_FILEPATH] [--punctuation-permitted-marks PUNCTUATION_PERMITTED_MARKS] [--enable-entities]
                          [--translation-langs TRANSLATION_TARGET_LANGUAGES] [--langid-langs LANGID_EXPECTED_LANGUAGES] [--output-format {txt,json,json-v2,srt}] [--speaker-diarization-sensitivity SPEAKER_DIARIZATION_SENSITIVITY]
                          [--diarization {none,speaker,channel,channel_and_speaker_change}] [--channel-diarization-labels CHANNEL_DIARIZATION_LABELS [CHANNEL_DIARIZATION_LABELS ...]] [--summarize] [--summary-content-type {informative,conversational,auto}]
                          [--summary-length {brief,detailed}] [--summary-type {paragraphs,bullets}] [--sentiment-analysis] [--topic-detection] [--topic-detection-topics TOPICS]
                          FILEPATHS [FILEPATHS ...]

Positional Arguments¶

FILEPATHS: File(s) to process.

Named Arguments¶

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--config-file

Read the transcription config from a file. If you provide this, all other config options work as overrides.

--lang, --language

Language (ISO 639-1 code, e.g. en, fr, de).

--operating-point

Possible choices: standard, enhanced

Selects the acoustic model configuration. “enhanced” is more computationally expensive than “standard” but should result in a more accurate transcript.

--domain

Optionally request a specialized language pack, e.g. ‘finance’

--output-locale

Locale of the output of transcripts. eg. en-US.

--additional-vocab

Space separated list of additional vocab. Expected format: <content (required)>:<sounds like (optional)>,<anymore sounds like> Simple vocab list example: ‘Speechmatics gnocchi’. Vocab list with sounds like example: ‘gnocchi:nokey,nochi’.

--additional-vocab-file

File with additional vocab in JSON format.

--punctuation-permitted-marks

Space-separated list of permitted punctuation marks for advanced punctuation.

--enable-entities

Whether to output additional information about recognisedentity classes (JSON output only).

Default: False

--translation-langs, --translation-languages

Comma-separated list of languages to translate the transcription into

--langid-langs, --langid-languages

Comma-separated list of expected languages for language identification

--output-format

Possible choices: txt, json, json-v2, srt

Transcript output format.

Default: “txt”

--speaker-diarization-sensitivity

The sensitivity of the speaker detection. Default is 0.5 .

--diarization

Possible choices: none, speaker, channel, channel_and_speaker_change

Which type of diarization to use.

--channel-diarization-labels

Add your own speaker or channel labels to the transcript. Example usage: –channel-diarization-labels label1 label2

--summarize

Whether to generate transcript summarization

Default: False

--summary-content-type

Possible choices: informative, conversational, auto

--summary-length

Possible choices: brief, detailed

--summary-type

Possible choices: paragraphs, bullets

--sentiment-analysis

Perform sentiment analysis on the transcript

Default: False

--topic-detection

Whether to detect topics in transcript

Default: False

--topic-detection-topics

Comma-separated list of topics for topic detection

list-jobs¶

Retrieve json of last 100 jobs submitted within the last 7 days for the SaaS or all of the jobs for the batch appliance

speechmatics batch list-jobs [-h] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE]

Named Arguments¶

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

get-results¶

Retrieve results of a transcription job.

speechmatics batch get-results [-h] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] [--output-format {txt,json,json-v2,srt}] --job-id JOB_ID

Named Arguments¶

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--output-format

Possible choices: txt, json, json-v2, srt

Transcript output format.

Default: “txt”

--job-id

Job ID.

delete¶

Delete the results of a transcription job.

speechmatics batch delete [-h] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] [--output-format {txt,json,json-v2,srt}] --job-id JOB_ID [--force]

Named Arguments¶

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--output-format

Possible choices: txt, json, json-v2, srt

Transcript output format.

Default: “txt”

--job-id

Job ID.

--force

Force deletion of a running job

Default: False

job-status¶

Retrieve status of a transcription job.

speechmatics batch job-status [-h] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] --job-id JOB_ID

Named Arguments¶

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--job-id

Job ID.

transcribe¶

Real-time commands. RETAINED FOR LEGACY COMPATIBILITY.

speechmatics transcribe [-h] [--streaming-mode] [--enable-partials] [--enable-transcription-partials] [--enable-translation-partials] [--punctuation-sensitivity PUNCTUATION_SENSITIVITY] [--speaker-diarization-max-speakers SPEAKER_DIARIZATION_MAX_SPEAKERS]
                        [--speaker-change-sensitivity SPEAKER_CHANGE_SENSITIVITY] [--speaker-change-token] [--max-delay MAX_DELAY] [--max-delay-mode {fixed,flexible}] [--raw ENCODING] [--sample-rate SAMPLE_RATE] [--chunk-size CHUNK_SIZE]
                        [--buffer-size BUFFER_SIZE] [--print-json] [--diarization {none,speaker,speaker_change}] [--url URL] [--auth-token AUTH_TOKEN] [--ssl-mode {regular,insecure,none}] [--generate-temp-token] [--profile PROFILE] [--config-file CONFIG_FILE]
                        [--lang LANGUAGE] [--operating-point {standard,enhanced}] [--domain DOMAIN] [--output-locale LOCALE] [--additional-vocab [ADDITIONAL_VOCAB [ADDITIONAL_VOCAB ...]]] [--additional-vocab-file VOCAB_FILEPATH]
                        [--punctuation-permitted-marks PUNCTUATION_PERMITTED_MARKS] [--enable-entities] [--translation-langs TRANSLATION_TARGET_LANGUAGES] [--langid-langs LANGID_EXPECTED_LANGUAGES]
                        FILEPATHS [FILEPATHS ...]

Positional Arguments¶

FILEPATHS: File(s) to process.

Named Arguments¶

--streaming-mode

Whether to run the engine in streaming mode. Internal Speechmatics use only.

Default: False

--enable-partials

Whether to return partials for both transcripts and translation which can be updated by later,final transcripts.

Default: False

--enable-transcription-partials

Whether to return partial transcripts which can be updated by later,final transcripts.

Default: False

--enable-translation-partials

Whether to return partial translation which can be updated by later,final translation.

Default: False

--punctuation-sensitivity

Sensitivity level for advanced punctuation.

--speaker-diarization-max-speakers

Enforces the maximum number of speakers allowed in a single audio stream. Min: 2, Max: 20, Default: 20.

--speaker-change-sensitivity

Sensitivity level for speaker change.

--speaker-change-token

Shows a <sc> token where a speaker change was detected.

Default: False

--max-delay

Maximum acceptable delay before sending a piece of transcript.

--max-delay-mode

Possible choices: fixed, flexible

How to interpret the max-delay size if speech is inthe middle of an unbreakable entity like a number.

Default: “flexible”

--raw

Indicate that the input audio is raw, provide the encodingof this raw audio, eg. pcm_f32le.

--sample-rate

The sample rate in Hz of the input audio, if in raw format.

Default: 44100

--chunk-size

How much audio data, in bytes, to send to the server in each websocket message. Larger values can increase latency, but values which are too small create unnecessary overhead.

Default: 4096

--buffer-size

Maximum number of messages to send before waiting foracknowledgements from the server.

Default: 512

--print-json

Print the JSON partial & final transcripts received rather than plaintext messages.

Default: False

--diarization

Possible choices: none, speaker, speaker_change

Which type of diarization to use.

--url

Websocket for RT or for batch API URL (e.g. wss://192.168.8.12:9000/ or https://asr.api.speechmatics.com/v2 respectively).

--auth-token

Pre-shared authentication token to authorize the client.Applies to Speechmatics SaaS products.

--ssl-mode

Possible choices: regular, insecure, none

Use a preset configuration for the SSL context. With regular mode a valid certificate is expected. With insecure mode a self signed certificate is allowed. With none then SSL is not used.

Default: “regular”

--generate-temp-token

Automatically generate a temporary token for authentication.Non-enterprise customers must set this to True.Enterprise customers should set this to False.

--profile

Determines the local config toml profile to use.Profiles can be used to maintain multiple different user accounts and setups locally.

Default: “default”

--config-file

Read the transcription config from a file. If you provide this, all other config options work as overrides.

--lang, --language

Language (ISO 639-1 code, e.g. en, fr, de).

--operating-point

Possible choices: standard, enhanced

Selects the acoustic model configuration. “enhanced” is more computationally expensive than “standard” but should result in a more accurate transcript.

--domain

Optionally request a specialized language pack, e.g. ‘finance’

--output-locale

Locale of the output of transcripts. eg. en-US.

--additional-vocab

Space separated list of additional vocab. Expected format: <content (required)>:<sounds like (optional)>,<anymore sounds like> Simple vocab list example: ‘Speechmatics gnocchi’. Vocab list with sounds like example: ‘gnocchi:nokey,nochi’.

--additional-vocab-file

File with additional vocab in JSON format.

--punctuation-permitted-marks

Space-separated list of permitted punctuation marks for advanced punctuation.

--enable-entities

Whether to output additional information about recognisedentity classes (JSON output only).

Default: False

--translation-langs, --translation-languages

Comma-separated list of languages to translate the transcription into

--langid-langs, --langid-languages

Comma-separated list of expected languages for language identification

config¶

Config commands. Used to handle local config.

speechmatics config [-h] {set,unset} ...

commands¶

command: Possible choices: set, unset

Sub-commands¶

set¶

Set config for the local CLI environment.

speechmatics config set [-h] [--auth-token AUTH_TOKEN] [--realtime-url REALTIME_URL] [--batch-url BATCH_URL] [--generate-temp-token] [--profile PROFILE]

Named Arguments¶

--auth-token

Auth token to use as default for all requests.

--realtime-url, --rt-url

Default URL to use for RT transcription. Overriden by the –url flag.

--batch-url

Default URL to use for Batch transcription. Overriden by the –url flag.

--generate-temp-token

Sets generate_temp_token to true in the config file.This will set the –generate-temp-token to true globally wherever it is a valid command line flag.

Default: False

--profile

Specifies the profile to set the config for.Profiles can be used to maintain multiple different sets of config locally.

Default: “default”

unset¶

Remove specified config values from the CLI config file.

speechmatics config unset [-h] [--auth-token] [--generate-temp-token] [--profile PROFILE] [--realtime-url] [--batch-url]

Named Arguments¶

--auth-token

If flag is set, removes the auth token value from the config file.

Default: False

--generate-temp-token

If flag is set, removes the generate temp token value from the config file.

Default: False

--profile

Specifies the profile to unset the config for.Profiles can be used to maintain multiple different sets of config locally.

Default: “default”

--realtime-url, --rt-url

Remove the default URL to use for RT transcription.

Default: False

--batch-url

Remove the default URL to use for Batch transcription.

Default: False

Speechmatics CLI Tool¶

Named Arguments¶

Mode¶

Sub-commands¶

rt¶

Commands¶

Sub-commands¶

transcribe¶

Positional Arguments¶

Named Arguments¶

batch¶

Commands¶

Sub-commands¶

transcribe¶

Positional Arguments¶

Named Arguments¶

submit¶

Positional Arguments¶

Named Arguments¶

list-jobs¶

Named Arguments¶

get-results¶

Named Arguments¶

delete¶

Named Arguments¶

job-status¶

Named Arguments¶

transcribe¶

Positional Arguments¶

Named Arguments¶

config¶

commands¶

Sub-commands¶

set¶

Named Arguments¶

unset¶

Named Arguments¶

Navigation

Related Topics