Skip to content

Assigned Presets

Discover the recognition presets available to the authenticated Desktop Services user. The response combines role-based and individually assigned presets and is ordered by preset name.

Internal API

The Desktop API is internal and must not be used for customer integrations. Compatibility is not guaranteed, and these endpoints may change without notice.

Base path: /api/v1/desktop-services/presets

Method Endpoint Description
GET /api/v1/desktop-services/presets List Assigned Presets
GET /api/v1/desktop-services/presets/{presetName} Get an Assigned Preset

List Assigned Presets

GET /api/v1/desktop-services/presets

Requires Authentication - Scopes: desktop:app:use

Return every recognition preset assigned to the current user. An empty assignment set returns items: [].

curl https://koldan.dixilang.com/api/v1/desktop-services/presets \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.get(
    "https://koldan.dixilang.com/api/v1/desktop-services/presets",
    headers={"Authorization": f"Bearer {ACCESS_TOKEN}"},
)
response.raise_for_status()
print(response.json())
DesktopPresetListResponse
Field Type Nullable Description
items DesktopPreset[] No Assigned presets, sorted by name without case sensitivity. Default: empty array.
DesktopPresetListResponse
{
  "items": [
    { "...": "..." }
  ]
}
Status Description
200 OK Assigned presets returned.
401 Unauthorized Access token is missing or invalid.
403 Forbidden Token does not include desktop:app:use.

Get an Assigned Preset

GET /api/v1/desktop-services/presets/{presetName}

Requires Authentication - Scopes: desktop:app:use

Return one preset only when it is assigned to the current user. Name matching is case-insensitive.

Path Parameters
Parameter Type Required Description
presetName string Yes Stable preset name. URL-encode reserved characters. 
curl https://koldan.dixilang.com/api/v1/desktop-services/presets/general-he \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.get(
    "https://koldan.dixilang.com/api/v1/desktop-services/presets/general-he",
    headers={"Authorization": f"Bearer {ACCESS_TOKEN}"},
)
response.raise_for_status()
print(response.json())
DesktopPreset
Status Description
200 OK Assigned preset returned.
401 Unauthorized Access token is missing or invalid.
403 Forbidden Token does not include desktop:app:use.
404 Not Found Preset does not exist or is not assigned to the current user.

Data Models

DesktopPreset

Field Type Nullable Description
name string No Stable preset name used in requests and preferences.
displayName string No User-facing preset name.
description string Yes Preset description.
ready boolean No Whether the preset is currently available for recognition. Default when unavailable: false.
model DesktopPresetModel Yes Recognition model and audio format. null when no model configuration can be resolved.
DesktopPreset
{
  "name": "general-he",
  "displayName": "General Hebrew",
  "description": "General-purpose Hebrew dictation",
  "ready": true,
  "model": { "...": "..." }
}

DesktopPresetModel

Field Type Nullable Description
name string No Model name.
displayName string No User-facing model name.
sampleRate integer No Required PCM input sample rate in hertz. Defaults to 16000 when the model does not specify a rate.
language DesktopPresetLanguage No Model language.

DesktopPresetLanguage

Field Type Nullable Description
name string No Stable language name or code.
localDisplayName string Yes Language name in that language.
globalDisplayName string Yes Language name for a general-language UI.
rtl boolean No true when text should be presented right-to-left. Defaults to true when no language metadata is available.

See Engine Model and Preset Resources for model archive downloads and the general preset runtime-configuration endpoint.