Vokabular

Das Vokabular enthält Begriffe, die die Transkription verbessern, etwa Namen und Fachbegriffe. Diese Endpunkte verwalten die Vokabeleinträge eines Unternehmenskontos.

Jeder Endpunkt unten zeigt in der Mitte seine Parameter und Antwortfelder und rechts ein Anfragebeispiel mit Beispielantwort.

Basis-URL https://api.sally.ioVersion v1.0 aktuell, noch nicht eingefrorenSo funktioniert die Versionierung

Listet die Vokabeleinträge eines Unternehmenskontos auf

GET/v1.0/directories/{directoryId}/vocabulary

Gibt alle unternehmensweiten Einträge sowie die eigenen persönlichen Einträge des Aufrufers zurück, sortiert nach Phrase.

Feldübersicht aus der Spezifikation

Jeder Eintrag enthält:

vocabularyId (string): Id des Vokabeleintrags.
phrase (string): der Begriff bzw. die Phrase, die Sally bevorzugt erkennen soll.
manualReplacePhrases (string | null): alternative Schreibweisen/Fehlerkennungen, die im Transkript durch phrase ersetzt werden (kommagetrennt); null, wenn keine.
description (string | null): Freitext-Notiz, die den Eintrag beschreibt (wird nicht für die Erkennung genutzt); null, wenn nicht gesetzt.
languageCode (string | null): Sprache, für die der Eintrag gilt, als IETF-Sprachtag (z. B. de-DE, en-US); null = gilt für alle Sprachen.
isDirectoryWide (boolean): Geltungsbereich: true = unternehmensweit (wird für jedes Mitglied der Organisation erkannt), false = persönlich (nur die eigenen Aufnahmen des Aufrufers).
createdOn (string): Zeitpunkt, zu dem der Eintrag erstellt wurde (UTC ISO-8601).
modifiedOn (string): Zeitpunkt, zu dem der Eintrag zuletzt geändert wurde (UTC ISO-8601).

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

fieldsstringoptional
Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.
Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.
Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.
Hier auswählbar: createdOn, description, isDirectoryWide, languageCode, manualReplacePhrases, modifiedOn, phrase, vocabularyId.
Beispiel: createdOn,description

Antwort

vocabularyIdstringPflicht
Id des Vokabeleintrags.
phrasestringPflicht
Der Begriff bzw. die Phrase, die Sally bevorzugt erkennen soll.
manualReplacePhrasesstringPflichtkann null sein
Alternative Schreibweisen/Fehlerkennungen, die im Transkript durch phrase ersetzt werden (kommagetrennt); null, wenn keine.
descriptionstringPflichtkann null sein
Freitext-Notiz, die den Eintrag beschreibt (wird nicht für die Erkennung genutzt); null, wenn nicht gesetzt.
languageCodestringPflichtkann null sein
Sprache, für die der Eintrag gilt, als IETF-Sprachtag (z. B. de-DE, en-US); null = gilt für alle Sprachen.
isDirectoryWidebooleanPflicht
Geltungsbereich: true = unternehmensweit (wird für jedes Mitglied der Organisation erkannt), false = persönlich (nur die eigenen Aufnahmen des Aufrufers).
createdOnstringPflicht
Zeitpunkt, zu dem der Eintrag erstellt wurde (UTC ISO-8601).
modifiedOnstringPflicht
Zeitpunkt, zu dem der Eintrag zuletzt geändert wurde (UTC ISO-8601).

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
404
Ressource nicht gefunden oder nicht zugänglich.
429
Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.
500
Interner Serverfehler.

Anfrage

cURL
JavaScript
Python

curl "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/vocabulary" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/vocabulary`, {
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
  },
});
const data = await response.json();

import os
import requests

response = requests.get(
    f"https://api.sally.io/v1.0/directories/{directory_id}/vocabulary",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
data = response.json()

Beispielantwort 200 OK

[
  {
    "vocabularyId": "b10870ac-d73b-44b4-ad6d-b8bc0df4c37c",
    "phrase": "string",
    "manualReplacePhrases": "string",
    "description": "string",
    "languageCode": "de-DE",
    "isDirectoryWide": true,
    "createdOn": "2026-09-24T09:30:00Z",
    "modifiedOn": "2026-09-24T09:30:00Z"
  }
]

Erstellt einen Vokabeleintrag

POST/v1.0/directories/{directoryId}/vocabulary

Persönliche Einträge sind für jedes Mitglied erlaubt; unternehmensweite Einträge erfordern Admin-/Owner-Rechte.

Feldübersicht aus der Spezifikation

Body-Felder:

phrase (string, Pflicht): der zu erkennende Begriff bzw. die Phrase (max. 400 Zeichen).
manualReplacePhrases (string, optional): manuelle alternative Schreibweisen (max. 4000 Zeichen); null zum Entfernen.
description (string, optional): Freitext-Beschreibung/Notiz (max. 4000 Zeichen); null zum Entfernen.
languageCode (string, optional): Sprache als IETF-Sprachtag (z. B. de-DE); null/weggelassen für sprachunabhängig.
isDirectoryWide (boolean, optional, Standard false): false = persönlich für den Aufrufer, true = unternehmensweit (erfordert Admin-/Owner-Rechte).

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

fieldsstringoptional
Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.
Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.
Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.
Hier auswählbar: createdOn, description, isDirectoryWide, languageCode, manualReplacePhrases, modifiedOn, phrase, vocabularyId.
Beispiel: createdOn,description

Request-Body application/json

phrasestringPflicht
Der Begriff bzw. die Phrase, die Sally bevorzugt erkennen soll (max. 400 Zeichen).
manualReplacePhrasesstringoptionalkann null sein
Alternative Schreibweisen/Fehlerkennungen, die durch phrase ersetzt werden sollen (kommagetrennt, max. 4000 Zeichen); null zum Entfernen.
descriptionstringoptionalkann null sein
Freitext-Notiz, die den Eintrag beschreibt, wird nicht für die Erkennung genutzt (max. 4000 Zeichen); null zum Entfernen.
languageCodestringoptionalkann null sein
Sprache, für die der Eintrag gilt, als IETF-Sprachtag (z. B. de-DE, en-US); null/weggelassen = gilt für alle Sprachen.
isDirectoryWidebooleanoptional
Geltungsbereich (Standard false): true = unternehmensweit (wird für jedes Mitglied erkannt), false = persönlich (nur die eigenen Aufnahmen des Aufrufers). Unternehmensweite Einträge erfordern Admin-/Owner-Rechte; persönliche Einträge sind für jedes Mitglied erlaubt.

Antwort

vocabularyIdstringPflicht
Id des Vokabeleintrags.
phrasestringPflicht
Der Begriff bzw. die Phrase, die Sally bevorzugt erkennen soll.
manualReplacePhrasesstringPflichtkann null sein
Alternative Schreibweisen/Fehlerkennungen, die im Transkript durch phrase ersetzt werden (kommagetrennt); null, wenn keine.
descriptionstringPflichtkann null sein
Freitext-Notiz, die den Eintrag beschreibt (wird nicht für die Erkennung genutzt); null, wenn nicht gesetzt.
languageCodestringPflichtkann null sein
Sprache, für die der Eintrag gilt, als IETF-Sprachtag (z. B. de-DE, en-US); null = gilt für alle Sprachen.
isDirectoryWidebooleanPflicht
Geltungsbereich: true = unternehmensweit (wird für jedes Mitglied der Organisation erkannt), false = persönlich (nur die eigenen Aufnahmen des Aufrufers).
createdOnstringPflicht
Zeitpunkt, zu dem der Eintrag erstellt wurde (UTC ISO-8601).
modifiedOnstringPflicht
Zeitpunkt, zu dem der Eintrag zuletzt geändert wurde (UTC ISO-8601).

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
403
Verboten (unzureichende Berechtigungen).
404
Ressource nicht gefunden oder nicht zugänglich.
429
Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.
500
Interner Serverfehler.

Anfrage

cURL
JavaScript
Python

curl -X POST "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/vocabulary" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "phrase": "string"
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/vocabulary`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "phrase": "string"
  }),
});
const data = await response.json();

import os
import requests

response = requests.post(
    f"https://api.sally.io/v1.0/directories/{directory_id}/vocabulary",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
    json={
        "phrase": "string",
    },
)
data = response.json()

Beispielantwort 200 OK

{
  "vocabularyId": "b10870ac-d73b-44b4-ad6d-b8bc0df4c37c",
  "phrase": "string",
  "manualReplacePhrases": "string",
  "description": "string",
  "languageCode": "de-DE",
  "isDirectoryWide": true,
  "createdOn": "2026-09-24T09:30:00Z",
  "modifiedOn": "2026-09-24T09:30:00Z"
}

Aktualisiert einen Vokabeleintrag

PUT/v1.0/directories/{directoryId}/vocabulary/{vocabularyId}

Persönliche Einträge sind für jedes Mitglied erlaubt; unternehmensweite Einträge erfordern Admin-/Owner-Rechte.

Feldübersicht aus der Spezifikation

Body-Felder:

phrase (string, Pflicht): der zu erkennende Begriff bzw. die Phrase (max. 400 Zeichen).
manualReplacePhrases (string, optional): manuelle alternative Schreibweisen (max. 4000 Zeichen); null zum Entfernen.
description (string, optional): Freitext-Beschreibung/Notiz (max. 4000 Zeichen); null zum Entfernen.
languageCode (string, optional): Sprache als IETF-Sprachtag (z. B. de-DE); null/weggelassen für sprachunabhängig.
isDirectoryWide (boolean, optional, Standard false): false = persönlich für den Aufrufer, true = unternehmensweit (erfordert Admin-/Owner-Rechte).

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.
vocabularyIdstringPflicht
Id des Vokabulars.

Query-Parameter

fieldsstringoptional
Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.
Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.
Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.
Hier auswählbar: createdOn, description, isDirectoryWide, languageCode, manualReplacePhrases, modifiedOn, phrase, vocabularyId.
Beispiel: createdOn,description

Request-Body application/json

phrasestringPflicht
Der Begriff bzw. die Phrase, die Sally bevorzugt erkennen soll (max. 400 Zeichen).
manualReplacePhrasesstringoptionalkann null sein
Alternative Schreibweisen/Fehlerkennungen, die durch phrase ersetzt werden sollen (kommagetrennt, max. 4000 Zeichen); null zum Entfernen.
descriptionstringoptionalkann null sein
Freitext-Notiz, die den Eintrag beschreibt, wird nicht für die Erkennung genutzt (max. 4000 Zeichen); null zum Entfernen.
languageCodestringoptionalkann null sein
Sprache, für die der Eintrag gilt, als IETF-Sprachtag (z. B. de-DE, en-US); null/weggelassen = gilt für alle Sprachen.
isDirectoryWidebooleanoptional
Geltungsbereich (Standard false): true = unternehmensweit (wird für jedes Mitglied erkannt), false = persönlich (nur die eigenen Aufnahmen des Aufrufers). Unternehmensweite Einträge erfordern Admin-/Owner-Rechte; persönliche Einträge sind für jedes Mitglied erlaubt.

Antwort

vocabularyIdstringPflicht
Id des Vokabeleintrags.
phrasestringPflicht
Der Begriff bzw. die Phrase, die Sally bevorzugt erkennen soll.
manualReplacePhrasesstringPflichtkann null sein
Alternative Schreibweisen/Fehlerkennungen, die im Transkript durch phrase ersetzt werden (kommagetrennt); null, wenn keine.
descriptionstringPflichtkann null sein
Freitext-Notiz, die den Eintrag beschreibt (wird nicht für die Erkennung genutzt); null, wenn nicht gesetzt.
languageCodestringPflichtkann null sein
Sprache, für die der Eintrag gilt, als IETF-Sprachtag (z. B. de-DE, en-US); null = gilt für alle Sprachen.
isDirectoryWidebooleanPflicht
Geltungsbereich: true = unternehmensweit (wird für jedes Mitglied der Organisation erkannt), false = persönlich (nur die eigenen Aufnahmen des Aufrufers).
createdOnstringPflicht
Zeitpunkt, zu dem der Eintrag erstellt wurde (UTC ISO-8601).
modifiedOnstringPflicht
Zeitpunkt, zu dem der Eintrag zuletzt geändert wurde (UTC ISO-8601).

Statuscodes

200Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
403
Verboten (unzureichende Berechtigungen).
404
Ressource nicht gefunden oder nicht zugänglich.
429
Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.
500
Interner Serverfehler.

Anfrage

cURL
JavaScript
Python

curl -X PUT "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/vocabulary/$VOCABULARY_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "phrase": "string"
}'

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/vocabulary/${vocabularyId}`, {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "phrase": "string"
  }),
});
const data = await response.json();

import os
import requests

response = requests.put(
    f"https://api.sally.io/v1.0/directories/{directory_id}/vocabulary/{vocabulary_id}",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
    json={
        "phrase": "string",
    },
)
data = response.json()

Beispielantwort 200 OK

{
  "vocabularyId": "b10870ac-d73b-44b4-ad6d-b8bc0df4c37c",
  "phrase": "string",
  "manualReplacePhrases": "string",
  "description": "string",
  "languageCode": "de-DE",
  "isDirectoryWide": true,
  "createdOn": "2026-09-24T09:30:00Z",
  "modifiedOn": "2026-09-24T09:30:00Z"
}

Löscht einen Vokabeleintrag

DELETE/v1.0/directories/{directoryId}/vocabulary/{vocabularyId}

Löscht den Eintrag weich (Soft Delete). Das Löschen eines unternehmensweiten Eintrags erfordert Admin-/Owner-Rechte.

Pfadparameter

directoryIdstringPflicht
Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.
vocabularyIdstringPflicht
Id des Vokabulars.

Statuscodes

204Erfolg
400
Ungültige Anfrage (Validierungsfehler).
401
Fehlender oder ungültiger Bearer-Token.
403
Verboten (unzureichende Berechtigungen).
404
Ressource nicht gefunden oder nicht zugänglich.
429
Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.
500
Interner Serverfehler.

Anfrage

cURL
JavaScript
Python

curl -X DELETE "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/vocabulary/$VOCABULARY_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/vocabulary/${vocabularyId}`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SALLY_TOKEN}`,
  },
});
console.log(response.status); // 204

import os
import requests

response = requests.delete(
    f"https://api.sally.io/v1.0/directories/{directory_id}/vocabulary/{vocabulary_id}",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
print(response.status_code)  # 204

Beispielantwort 204 No Content

Kein Inhalt. Ein erfolgreicher Aufruf liefert einen leeren Body.

Listet die Vokabeleinträge eines Unternehmenskontos auf​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Erstellt einen Vokabeleintrag​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort

Statuscodes

Aktualisiert einen Vokabeleintrag​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort

Statuscodes

Löscht einen Vokabeleintrag​

Pfadparameter

Statuscodes

Listet die Vokabeleinträge eines Unternehmenskontos auf

Erstellt einen Vokabeleintrag

Aktualisiert einen Vokabeleintrag

Löscht einen Vokabeleintrag