Skip to main content
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,
  "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>"
}
'
{
  "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>"
  }
}

Authorizations

​
Authorization
string
header
required

Token from the discovery file. Required on every endpoint except /health.

Path Parameters

​
id
string<uuid>
required

Body

application/json

Partial Mode. Any field omitted is left untouched on the server.

​
name
string
required
​
preset
string
required

hyper | note | email | commit | custom

​
language
string
required
​
model
string
required
​
punctuation
boolean
required
​
capitalization
boolean
required
​
profanityFilter
boolean
required
​
id
string<uuid>
​
customInstructions
string | null
​
userSystemPrompt
string | null
​
isDefault
boolean | null
​
isSystemProvided
boolean | null
​
sortOrder
integer | null
​
createdDate
string<date-time> | null
​
modifiedDate
string<date-time> | null
​
languageModel
string | null
​
cloudTranscriptionModel
string | null
​
cloudProvider
string | null
​
postProcessingMode
integer

0 = off, 1 = cloud, 2 = local

​
postProcessingProvider
string | null
​
englishSpelling
string | null
​
useStreamingTranscription
boolean | null
​
cloudAccuracyTier
string | null
​
removeTrailingPeriod
boolean | null
​
enableScreenOCR
boolean | null
​
geminiCustomPrompt
string | null
​
cloudPostProcessingModel
string | null

Response

200 - application/json

Updated mode

​
ok
boolean
​
mode
object