Partial-field update
curl --request PATCH \
--url http://127.0.0.1:{port}/modes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"preset": "<string>",
"language": "<string>",
"model": "<string>",
"punctuation": true,
"capitalization": true,
"profanityFilter": true,
"customInstructions": "<string>",
"userSystemPrompt": "<string>",
"isDefault": true,
"sortOrder": 123,
"languageModel": "<string>",
"cloudTranscriptionModel": "<string>",
"cloudProvider": "<string>",
"postProcessingMode": 123,
"postProcessingProvider": "<string>",
"englishSpelling": "<string>",
"useStreamingTranscription": true,
"cloudAccuracyTier": "<string>",
"removeTrailingPeriod": true,
"enableScreenOCR": true,
"geminiCustomPrompt": "<string>",
"cloudPostProcessingModel": "<string>",
"cloudTranscriptionDomain": "<string>",
"localEngine": "<string>",
"localParakeetModel": "<string>",
"localPostProcessingModel": "<string>",
"customVocabulary": [
"<string>"
],
"providerType": "<string>"
}
'import requests
url = "http://127.0.0.1:{port}/modes/{id}"
payload = {
"name": "<string>",
"preset": "<string>",
"language": "<string>",
"model": "<string>",
"punctuation": True,
"capitalization": True,
"profanityFilter": True,
"customInstructions": "<string>",
"userSystemPrompt": "<string>",
"isDefault": True,
"sortOrder": 123,
"languageModel": "<string>",
"cloudTranscriptionModel": "<string>",
"cloudProvider": "<string>",
"postProcessingMode": 123,
"postProcessingProvider": "<string>",
"englishSpelling": "<string>",
"useStreamingTranscription": True,
"cloudAccuracyTier": "<string>",
"removeTrailingPeriod": True,
"enableScreenOCR": True,
"geminiCustomPrompt": "<string>",
"cloudPostProcessingModel": "<string>",
"cloudTranscriptionDomain": "<string>",
"localEngine": "<string>",
"localParakeetModel": "<string>",
"localPostProcessingModel": "<string>",
"customVocabulary": ["<string>"],
"providerType": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
preset: '<string>',
language: '<string>',
model: '<string>',
punctuation: true,
capitalization: true,
profanityFilter: true,
customInstructions: '<string>',
userSystemPrompt: '<string>',
isDefault: true,
sortOrder: 123,
languageModel: '<string>',
cloudTranscriptionModel: '<string>',
cloudProvider: '<string>',
postProcessingMode: 123,
postProcessingProvider: '<string>',
englishSpelling: '<string>',
useStreamingTranscription: true,
cloudAccuracyTier: '<string>',
removeTrailingPeriod: true,
enableScreenOCR: true,
geminiCustomPrompt: '<string>',
cloudPostProcessingModel: '<string>',
cloudTranscriptionDomain: '<string>',
localEngine: '<string>',
localParakeetModel: '<string>',
localPostProcessingModel: '<string>',
customVocabulary: ['<string>'],
providerType: '<string>'
})
};
fetch('http://127.0.0.1:{port}/modes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://127.0.0.1:{port}/modes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'preset' => '<string>',
'language' => '<string>',
'model' => '<string>',
'punctuation' => true,
'capitalization' => true,
'profanityFilter' => true,
'customInstructions' => '<string>',
'userSystemPrompt' => '<string>',
'isDefault' => true,
'sortOrder' => 123,
'languageModel' => '<string>',
'cloudTranscriptionModel' => '<string>',
'cloudProvider' => '<string>',
'postProcessingMode' => 123,
'postProcessingProvider' => '<string>',
'englishSpelling' => '<string>',
'useStreamingTranscription' => true,
'cloudAccuracyTier' => '<string>',
'removeTrailingPeriod' => true,
'enableScreenOCR' => true,
'geminiCustomPrompt' => '<string>',
'cloudPostProcessingModel' => '<string>',
'cloudTranscriptionDomain' => '<string>',
'localEngine' => '<string>',
'localParakeetModel' => '<string>',
'localPostProcessingModel' => '<string>',
'customVocabulary' => [
'<string>'
],
'providerType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:{port}/modes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"preset\": \"<string>\",\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"punctuation\": true,\n \"capitalization\": true,\n \"profanityFilter\": true,\n \"customInstructions\": \"<string>\",\n \"userSystemPrompt\": \"<string>\",\n \"isDefault\": true,\n \"sortOrder\": 123,\n \"languageModel\": \"<string>\",\n \"cloudTranscriptionModel\": \"<string>\",\n \"cloudProvider\": \"<string>\",\n \"postProcessingMode\": 123,\n \"postProcessingProvider\": \"<string>\",\n \"englishSpelling\": \"<string>\",\n \"useStreamingTranscription\": true,\n \"cloudAccuracyTier\": \"<string>\",\n \"removeTrailingPeriod\": true,\n \"enableScreenOCR\": true,\n \"geminiCustomPrompt\": \"<string>\",\n \"cloudPostProcessingModel\": \"<string>\",\n \"cloudTranscriptionDomain\": \"<string>\",\n \"localEngine\": \"<string>\",\n \"localParakeetModel\": \"<string>\",\n \"localPostProcessingModel\": \"<string>\",\n \"customVocabulary\": [\n \"<string>\"\n ],\n \"providerType\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://127.0.0.1:{port}/modes/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"preset\": \"<string>\",\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"punctuation\": true,\n \"capitalization\": true,\n \"profanityFilter\": true,\n \"customInstructions\": \"<string>\",\n \"userSystemPrompt\": \"<string>\",\n \"isDefault\": true,\n \"sortOrder\": 123,\n \"languageModel\": \"<string>\",\n \"cloudTranscriptionModel\": \"<string>\",\n \"cloudProvider\": \"<string>\",\n \"postProcessingMode\": 123,\n \"postProcessingProvider\": \"<string>\",\n \"englishSpelling\": \"<string>\",\n \"useStreamingTranscription\": true,\n \"cloudAccuracyTier\": \"<string>\",\n \"removeTrailingPeriod\": true,\n \"enableScreenOCR\": true,\n \"geminiCustomPrompt\": \"<string>\",\n \"cloudPostProcessingModel\": \"<string>\",\n \"cloudTranscriptionDomain\": \"<string>\",\n \"localEngine\": \"<string>\",\n \"localParakeetModel\": \"<string>\",\n \"localPostProcessingModel\": \"<string>\",\n \"customVocabulary\": [\n \"<string>\"\n ],\n \"providerType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:{port}/modes/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"preset\": \"<string>\",\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"punctuation\": true,\n \"capitalization\": true,\n \"profanityFilter\": true,\n \"customInstructions\": \"<string>\",\n \"userSystemPrompt\": \"<string>\",\n \"isDefault\": true,\n \"sortOrder\": 123,\n \"languageModel\": \"<string>\",\n \"cloudTranscriptionModel\": \"<string>\",\n \"cloudProvider\": \"<string>\",\n \"postProcessingMode\": 123,\n \"postProcessingProvider\": \"<string>\",\n \"englishSpelling\": \"<string>\",\n \"useStreamingTranscription\": true,\n \"cloudAccuracyTier\": \"<string>\",\n \"removeTrailingPeriod\": true,\n \"enableScreenOCR\": true,\n \"geminiCustomPrompt\": \"<string>\",\n \"cloudPostProcessingModel\": \"<string>\",\n \"cloudTranscriptionDomain\": \"<string>\",\n \"localEngine\": \"<string>\",\n \"localParakeetModel\": \"<string>\",\n \"localPostProcessingModel\": \"<string>\",\n \"customVocabulary\": [\n \"<string>\"\n ],\n \"providerType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"mode": {
"name": "<string>",
"preset": "<string>",
"language": "<string>",
"model": "<string>",
"punctuation": true,
"capitalization": true,
"profanityFilter": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customInstructions": "<string>",
"userSystemPrompt": "<string>",
"isDefault": true,
"isSystemProvided": true,
"sortOrder": 123,
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"languageModel": "<string>",
"cloudTranscriptionModel": "<string>",
"cloudProvider": "<string>",
"postProcessingMode": 123,
"postProcessingProvider": "<string>",
"englishSpelling": "<string>",
"useStreamingTranscription": true,
"cloudAccuracyTier": "<string>",
"removeTrailingPeriod": true,
"enableScreenOCR": true,
"geminiCustomPrompt": "<string>",
"cloudPostProcessingModel": "<string>",
"cloudTranscriptionDomain": "<string>",
"localEngine": "<string>",
"localParakeetModel": "<string>",
"localPostProcessingModel": "<string>",
"customVocabulary": [
"<string>"
],
"providerType": "<string>"
}
}API Reference
Partial-field update
PATCH
/
modes
/
{id}
Partial-field update
curl --request PATCH \
--url http://127.0.0.1:{port}/modes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"preset": "<string>",
"language": "<string>",
"model": "<string>",
"punctuation": true,
"capitalization": true,
"profanityFilter": true,
"customInstructions": "<string>",
"userSystemPrompt": "<string>",
"isDefault": true,
"sortOrder": 123,
"languageModel": "<string>",
"cloudTranscriptionModel": "<string>",
"cloudProvider": "<string>",
"postProcessingMode": 123,
"postProcessingProvider": "<string>",
"englishSpelling": "<string>",
"useStreamingTranscription": true,
"cloudAccuracyTier": "<string>",
"removeTrailingPeriod": true,
"enableScreenOCR": true,
"geminiCustomPrompt": "<string>",
"cloudPostProcessingModel": "<string>",
"cloudTranscriptionDomain": "<string>",
"localEngine": "<string>",
"localParakeetModel": "<string>",
"localPostProcessingModel": "<string>",
"customVocabulary": [
"<string>"
],
"providerType": "<string>"
}
'import requests
url = "http://127.0.0.1:{port}/modes/{id}"
payload = {
"name": "<string>",
"preset": "<string>",
"language": "<string>",
"model": "<string>",
"punctuation": True,
"capitalization": True,
"profanityFilter": True,
"customInstructions": "<string>",
"userSystemPrompt": "<string>",
"isDefault": True,
"sortOrder": 123,
"languageModel": "<string>",
"cloudTranscriptionModel": "<string>",
"cloudProvider": "<string>",
"postProcessingMode": 123,
"postProcessingProvider": "<string>",
"englishSpelling": "<string>",
"useStreamingTranscription": True,
"cloudAccuracyTier": "<string>",
"removeTrailingPeriod": True,
"enableScreenOCR": True,
"geminiCustomPrompt": "<string>",
"cloudPostProcessingModel": "<string>",
"cloudTranscriptionDomain": "<string>",
"localEngine": "<string>",
"localParakeetModel": "<string>",
"localPostProcessingModel": "<string>",
"customVocabulary": ["<string>"],
"providerType": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
preset: '<string>',
language: '<string>',
model: '<string>',
punctuation: true,
capitalization: true,
profanityFilter: true,
customInstructions: '<string>',
userSystemPrompt: '<string>',
isDefault: true,
sortOrder: 123,
languageModel: '<string>',
cloudTranscriptionModel: '<string>',
cloudProvider: '<string>',
postProcessingMode: 123,
postProcessingProvider: '<string>',
englishSpelling: '<string>',
useStreamingTranscription: true,
cloudAccuracyTier: '<string>',
removeTrailingPeriod: true,
enableScreenOCR: true,
geminiCustomPrompt: '<string>',
cloudPostProcessingModel: '<string>',
cloudTranscriptionDomain: '<string>',
localEngine: '<string>',
localParakeetModel: '<string>',
localPostProcessingModel: '<string>',
customVocabulary: ['<string>'],
providerType: '<string>'
})
};
fetch('http://127.0.0.1:{port}/modes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "62437",
CURLOPT_URL => "http://127.0.0.1:{port}/modes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'preset' => '<string>',
'language' => '<string>',
'model' => '<string>',
'punctuation' => true,
'capitalization' => true,
'profanityFilter' => true,
'customInstructions' => '<string>',
'userSystemPrompt' => '<string>',
'isDefault' => true,
'sortOrder' => 123,
'languageModel' => '<string>',
'cloudTranscriptionModel' => '<string>',
'cloudProvider' => '<string>',
'postProcessingMode' => 123,
'postProcessingProvider' => '<string>',
'englishSpelling' => '<string>',
'useStreamingTranscription' => true,
'cloudAccuracyTier' => '<string>',
'removeTrailingPeriod' => true,
'enableScreenOCR' => true,
'geminiCustomPrompt' => '<string>',
'cloudPostProcessingModel' => '<string>',
'cloudTranscriptionDomain' => '<string>',
'localEngine' => '<string>',
'localParakeetModel' => '<string>',
'localPostProcessingModel' => '<string>',
'customVocabulary' => [
'<string>'
],
'providerType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:{port}/modes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"preset\": \"<string>\",\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"punctuation\": true,\n \"capitalization\": true,\n \"profanityFilter\": true,\n \"customInstructions\": \"<string>\",\n \"userSystemPrompt\": \"<string>\",\n \"isDefault\": true,\n \"sortOrder\": 123,\n \"languageModel\": \"<string>\",\n \"cloudTranscriptionModel\": \"<string>\",\n \"cloudProvider\": \"<string>\",\n \"postProcessingMode\": 123,\n \"postProcessingProvider\": \"<string>\",\n \"englishSpelling\": \"<string>\",\n \"useStreamingTranscription\": true,\n \"cloudAccuracyTier\": \"<string>\",\n \"removeTrailingPeriod\": true,\n \"enableScreenOCR\": true,\n \"geminiCustomPrompt\": \"<string>\",\n \"cloudPostProcessingModel\": \"<string>\",\n \"cloudTranscriptionDomain\": \"<string>\",\n \"localEngine\": \"<string>\",\n \"localParakeetModel\": \"<string>\",\n \"localPostProcessingModel\": \"<string>\",\n \"customVocabulary\": [\n \"<string>\"\n ],\n \"providerType\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("http://127.0.0.1:{port}/modes/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"preset\": \"<string>\",\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"punctuation\": true,\n \"capitalization\": true,\n \"profanityFilter\": true,\n \"customInstructions\": \"<string>\",\n \"userSystemPrompt\": \"<string>\",\n \"isDefault\": true,\n \"sortOrder\": 123,\n \"languageModel\": \"<string>\",\n \"cloudTranscriptionModel\": \"<string>\",\n \"cloudProvider\": \"<string>\",\n \"postProcessingMode\": 123,\n \"postProcessingProvider\": \"<string>\",\n \"englishSpelling\": \"<string>\",\n \"useStreamingTranscription\": true,\n \"cloudAccuracyTier\": \"<string>\",\n \"removeTrailingPeriod\": true,\n \"enableScreenOCR\": true,\n \"geminiCustomPrompt\": \"<string>\",\n \"cloudPostProcessingModel\": \"<string>\",\n \"cloudTranscriptionDomain\": \"<string>\",\n \"localEngine\": \"<string>\",\n \"localParakeetModel\": \"<string>\",\n \"localPostProcessingModel\": \"<string>\",\n \"customVocabulary\": [\n \"<string>\"\n ],\n \"providerType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:{port}/modes/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"preset\": \"<string>\",\n \"language\": \"<string>\",\n \"model\": \"<string>\",\n \"punctuation\": true,\n \"capitalization\": true,\n \"profanityFilter\": true,\n \"customInstructions\": \"<string>\",\n \"userSystemPrompt\": \"<string>\",\n \"isDefault\": true,\n \"sortOrder\": 123,\n \"languageModel\": \"<string>\",\n \"cloudTranscriptionModel\": \"<string>\",\n \"cloudProvider\": \"<string>\",\n \"postProcessingMode\": 123,\n \"postProcessingProvider\": \"<string>\",\n \"englishSpelling\": \"<string>\",\n \"useStreamingTranscription\": true,\n \"cloudAccuracyTier\": \"<string>\",\n \"removeTrailingPeriod\": true,\n \"enableScreenOCR\": true,\n \"geminiCustomPrompt\": \"<string>\",\n \"cloudPostProcessingModel\": \"<string>\",\n \"cloudTranscriptionDomain\": \"<string>\",\n \"localEngine\": \"<string>\",\n \"localParakeetModel\": \"<string>\",\n \"localPostProcessingModel\": \"<string>\",\n \"customVocabulary\": [\n \"<string>\"\n ],\n \"providerType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"mode": {
"name": "<string>",
"preset": "<string>",
"language": "<string>",
"model": "<string>",
"punctuation": true,
"capitalization": true,
"profanityFilter": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customInstructions": "<string>",
"userSystemPrompt": "<string>",
"isDefault": true,
"isSystemProvided": true,
"sortOrder": 123,
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"languageModel": "<string>",
"cloudTranscriptionModel": "<string>",
"cloudProvider": "<string>",
"postProcessingMode": 123,
"postProcessingProvider": "<string>",
"englishSpelling": "<string>",
"useStreamingTranscription": true,
"cloudAccuracyTier": "<string>",
"removeTrailingPeriod": true,
"enableScreenOCR": true,
"geminiCustomPrompt": "<string>",
"cloudPostProcessingModel": "<string>",
"cloudTranscriptionDomain": "<string>",
"localEngine": "<string>",
"localParakeetModel": "<string>",
"localPostProcessingModel": "<string>",
"customVocabulary": [
"<string>"
],
"providerType": "<string>"
}
}Authorizations
Token from the discovery file. Required on every endpoint except /health.
Path Parameters
Body
application/json
Partial Mode. Any field omitted is left untouched on the server. All fields are optional. id, isSystemProvided, createdDate and modifiedDate are read-only: the server ignores them here, and sets modifiedDate itself on each patch. On macOS, an explicit JSON null clears customInstructions, userSystemPrompt, languageModel, cloudTranscriptionModel, cloudTranscriptionDomain, cloudProvider, postProcessingProvider, englishSpelling, cloudAccuracyTier, geminiCustomPrompt, or cloudPostProcessingModel. Windows treats null like omission for nullable PATCH fields.
Must not be empty after normalization and must be unique without regard to case. Windows trims boundary whitespace. macOS also normalizes Unicode, trims invisible boundary characters, and rejects names with no visible base character.
hyper | message | mail | note | meeting | code | custom
macOS accepts values from -32768 through 32767.
0 = off, 1 = cloud, 2 = local. macOS rejects all other values.
american | british | australian | canadian
Windows only. macOS ignores this key.
Windows only. macOS ignores this key.
Windows only. macOS ignores this key.
Windows only. macOS ignores this key.
Windows only. macOS ignores this key.
Was this page helpful?