Zusammenfassungen

Eine Zusammenfassung gehört zu einer Aufnahme und existiert einmal je Sprache. Mit diesen Endpunkten durchsuchst du Zusammenfassungen und rufst eine einzelne per Id ab.

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

Durchsucht Zusammenfassungen (Parameter im Body)

POST/v1.0/directories/{directoryId}/summaries/search

Durchsucht Zusammenfassungen und gibt pro Treffer einen gekürzten Ausschnitt aus dem Text der Zusammenfassung zurück.

Feldübersicht aus der Spezifikation

Felder im Body:

search (string, optional, min. 3 Zeichen): Teilstring ohne Beachtung der Groß- und Kleinschreibung, der an beliebiger Stelle im Text der Zusammenfassung UND in den erzeugten Abschnittseinträgen (Titel/Inhalt/Betreff/Beschreibung) gesucht wird; eine Aufnahme ist ein Treffer, wenn IRGENDEINER davon passt.
page (number, optional, Standard 1): Seitennummer, beginnend bei 1.
pageSize (number, optional, Standard 25): Seitengröße, max. 100.

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: appointmentId, createdOn, languageCode, recordingId, recordingSummaryId, snippet.
Beispiel: appointmentId,createdOn

Request-Body application/json

searchstringoptionalkann null sein
Teilstring-Suche ohne Beachtung der Groß- und Kleinschreibung im Text der Zusammenfassung und in den erzeugten Abschnittseinträgen (Titel/Inhalt/Betreff/Beschreibung). Mindestens 3 Zeichen.
pagenumberoptional
Seite (beginnend bei 1, Standard 1).
pageSizenumberoptional
Seitengröße (Standard 25, max. 100).

Antwort: je Eintrag in items

recordingSummaryIdstringPflicht
Id der Zusammenfassung.
recordingIdstringPflicht
Id der zugehörigen Aufnahme.
appointmentIdstringPflichtkann null sein
Id des zugehörigen Termins (falls vorhanden).
languageCodestringPflichtkann null sein
Sprachcode der Zusammenfassung (IETF-Sprach-Tag, z. B. de-DE, en-US).
snippetstringPflicht
Gekürzter Ausschnitt aus dem Text der Zusammenfassung (max. 300 Zeichen).
createdOnstringPflicht
Zeitstempel der Erstellung (ISO-8601).

Jede Seite trägt außerdem page, pageSize, total, hasMore.

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/summaries/search" \
  -H "Authorization: Bearer $SALLY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "search": "pricing",
  "page": 1,
  "pageSize": 25
}'

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

import os
import requests

response = requests.post(
    f"https://api.sally.io/v1.0/directories/{directory_id}/summaries/search",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
    json={
        "search": "pricing",
        "page": 1,
        "pageSize": 25,
    },
)
data = response.json()

Beispielantwort 200 OK

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "hasMore": true,
  "items": [
    {
      "recordingSummaryId": "731180f9-257a-46cf-a7e3-8ca508fb9c35",
      "recordingId": "53e2e041-4b34-41c7-a285-634d80b3675d",
      "appointmentId": "d4398f97-cd92-4d21-a6ec-4aab0a85441b",
      "languageCode": "de-DE",
      "snippet": "string",
      "createdOn": "2026-09-24T09:30:00Z"
    }
  ]
}

Gibt eine einzelne Zusammenfassung anhand ihrer Id zurück

GET/v1.0/directories/{directoryId}/summaries/{recordingSummaryId}

Gibt die vollständige Zusammenfassung zur angegebenen recordingSummaryId zurück. 404, wenn die Zusammenfassung nicht existiert oder der Aufrufer keinen Zugriff auf die zugrunde liegende Aufnahme hat. Gültige Ids erhältst du über die Suche nach Zusammenfassungen (POST .../summaries/search) oder über GET .../recordings/{recordingId}/summaries.

Feldübersicht aus der Spezifikation

Pfadparameter:

directoryId (string): Id des Unternehmenskontos (der Organisation), zu dem die Zusammenfassung gehört.
recordingSummaryId (string): Id der Zusammenfassung, die zurückgegeben werden soll.

Felder der Antwort:

recordingSummaryId (string): Id dieser Zusammenfassung. Eine Aufnahme kann mehrere Zusammenfassungen haben, eine pro Sprache.
recordingId (string): Id der Aufnahme, aus der diese Zusammenfassung erzeugt wurde.
appointmentId (string | null): Id des eigenen Termins des Aufrufers, der mit der Aufnahme verknüpft ist; null, wenn die Aufnahme mit keinem Termin verknüpft ist.
languageCode (string | null): Sprache des Zusammenfassungstexts als IETF-Sprach-Tag (z. B. de-DE, en-US); null, wenn unbekannt.
summary (string | null): der Text der Zusammenfassung (Markdown); null, wenn kein Text erzeugt wurde.
createdOn (string): Zeitstempel der Erstellung der Zusammenfassung (UTC ISO-8601).
sectionItems (array): die strukturierten Ergebnisse pro Abschnitt aus dem Meetingtemplate, das diese Zusammenfassung erzeugt hat (bei diesem Endpunkt immer enthalten). Jeder Eintrag enthält:
- sectionItemId (string): Id des Abschnittseintrags.
- meetingTemplateSectionId (string | null): Id des Meetingtemplate-Abschnitts, aus dem dieser Eintrag erzeugt wurde (auflösen über GET .../meetingtemplates/{meetingTemplateId}); null bei abgeleiteten Einträgen ohne Template-Abschnitt (z. B. Aufgabeneinträge).
- title (string): Titel des Abschnittseintrags.
- sectionType (string enum): der Abschnittstyp (summary, tasks, topics, decisions, customList oder freeText).
- outputFormat (string enum): das Format von content (html oder markdown).
- sortOrder (number): Reihenfolge des Eintrags innerhalb der Zusammenfassung.
- content (string | null): der Freitext- bzw. Markdown-Inhalt des Eintrags.
- subject (string | null): Betreff der Aufgabe (bei aufgabenartigen Abschnittseinträgen).
- description (string | null): Beschreibung der Aufgabe (bei aufgabenartigen Abschnittseinträgen).
- responsibleUserName (string | null): Name der verantwortlichen Person (Aufgabeneinträge).
- responsibleUserEmail (string | null): E-Mail der verantwortlichen Person (Aufgabeneinträge).
- dueDate (string | null): Fälligkeitsdatum des Aufgabeneintrags (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.
recordingSummaryIdstringPflicht
Id der Zusammenfassung.

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: appointmentId, createdOn, isSummarizationCompleted, isSummarizationSucceeded, languageCode, recordingId, recordingSummaryId, sectionItems, summarizationCompletionReason, summary.
Beispiel: appointmentId,createdOn

Antwort

recordingSummaryIdstringPflicht
Id der Zusammenfassung.
recordingIdstringPflicht
Id der zugehörigen Aufnahme.
appointmentIdstringPflichtkann null sein
Id des zugehörigen Termins (falls vorhanden).
languageCodestringPflichtkann null sein
Sprachcode der Zusammenfassung (IETF-Sprach-Tag, z. B. de-DE, en-US).
summarystringPflichtkann null sein
Text der Zusammenfassung.
isSummarizationCompletedbooleanPflicht
True, sobald der Zusammenfassungsdurchlauf beendet ist, unabhängig davon, ob er etwas erzeugt hat.
isSummarizationSucceededbooleanPflicht
True, wenn es etwas zu lesen gibt: Text der Zusammenfassung oder mindestens ein Abschnittseintrag. Auch ein Durchlauf über eine Aufnahme ohne Transkript wird beendet, und dann bleibt dieser Wert false.
summarizationCompletionReasonstringPflicht
Warum der Zusammenfassungsdurchlauf beendet wurde. noTranscript bedeutet, dass es nichts zusammenzufassen gab; das ist ein erwartetes Ergebnis und kein Fehler. unknown, solange er nicht beendet ist. Der zugrunde liegende Fehlertext wird bewusst nicht offengelegt.
Erlaubte Werte: succeedednoTranscriptemptyResulterrorunknown
createdOnstringPflicht
Zeitstempel der Erstellung (ISO-8601).
sectionItemsobject[]Pflichtkann null sein
Die erzeugten Abschnittseinträge der Zusammenfassung (die strukturierten Ergebnisse des Meetingtemplates pro Abschnitt). Null, wenn nicht geladen (der Listen-Endpunkt der Aufnahmen füllt dieses Feld nur mit ?includeDetails=true); der Endpunkt für eine einzelne Zusammenfassung liefert es immer mit.
12 Unterfelder
- sectionItemIdstringPflicht
  Id des Abschnittseintrags.
- meetingTemplateSectionIdstringPflichtkann null sein
  Id des Meetingtemplate-Abschnitts, aus dem dieser Eintrag erzeugt wurde. Auflösen über GET /v1.0/directories/{directoryId}/meetingtemplates/{meetingTemplateId} (entspricht der meetingTemplateSectionId eines Abschnitts). Null bei abgeleiteten Einträgen ohne Template-Abschnitt (z. B. Aufgabeneinträge).
- titlestringPflicht
  Titel des Template-Abschnittseintrags.
- sectionTypestringPflicht
  Abschnittstyp des Eintrags.
  Erlaubte Werte: summarytaskstopicsdecisionscustomListfreeTextunknown
- outputFormatstringPflicht
  Ausgabeformat des Eintragsinhalts.
  Erlaubte Werte: htmlmarkdownunknown
- sortOrdernumberPflicht
  Reihenfolge innerhalb der Zusammenfassung.
- contentstringPflichtkann null sein
  Freitext- bzw. Markdown-Inhalt des Eintrags.
- subjectstringPflichtkann null sein
  Betreff der Aufgabe (bei aufgabenartigen Abschnittseinträgen).
- descriptionstringPflichtkann null sein
  Beschreibung der Aufgabe.
- responsibleUserNamestringPflichtkann null sein
  Verantwortliche Person (Name).
- responsibleUserEmailstringPflichtkann null sein
  Verantwortliche Person (E-Mail).
- dueDatestringPflichtkann null sein
  Fälligkeitsdatum (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/summaries/$RECORDING_SUMMARY_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

const response = await fetch(`https://api.sally.io/v1.0/directories/${directoryId}/summaries/${recordingSummaryId}`, {
  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}/summaries/{recording_summary_id}",
    headers={"Authorization": f"Bearer {os.environ['SALLY_TOKEN']}"},
)
data = response.json()

Beispielantwort 200 OK

{
  "recordingSummaryId": "731180f9-257a-46cf-a7e3-8ca508fb9c35",
  "recordingId": "53e2e041-4b34-41c7-a285-634d80b3675d",
  "appointmentId": "d4398f97-cd92-4d21-a6ec-4aab0a85441b",
  "languageCode": "de-DE",
  "summary": "string",
  "isSummarizationCompleted": true,
  "isSummarizationSucceeded": true,
  "summarizationCompletionReason": "succeeded",
  "createdOn": "2026-09-24T09:30:00Z",
  "sectionItems": [
    {
      "sectionItemId": "39ec96ee-9578-4082-a103-aa168fcd18f6",
      "meetingTemplateSectionId": "0ba1ea56-516d-485a-a738-e65e51578bbe",
      "title": "string",
      "sectionType": "summary",
      "outputFormat": "html",
      "sortOrder": 1,
      "content": "We agreed on the rollout plan for October.",
      "subject": "Quarterly planning",
      "description": "string",
      "responsibleUserName": "string",
      "responsibleUserEmail": "anna.berger@example.com",
      "dueDate": "2026-09-24T09:30:00Z"
    }
  ]
}

Durchsucht Zusammenfassungen (Parameter im Body)​

Pfadparameter

Query-Parameter

Request-Body application/json

Antwort: je Eintrag in items

Statuscodes

Gibt eine einzelne Zusammenfassung anhand ihrer Id zurück​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Durchsucht Zusammenfassungen (Parameter im Body)

Gibt eine einzelne Zusammenfassung anhand ihrer Id zurück