Meetingtemplates

Ein Meetingtemplate legt fest, in welche Abschnitte eine Zusammenfassung gegliedert wird. Diese Endpunkte sind nur lesend und listen Templates und Abschnitte, damit du Abschnittseinträge zuordnen kannst.

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 Meetingtemplates auf, die in einem Unternehmenskonto nutzbar sind

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

Gibt die veröffentlichten Templates zurück, die in diesem Unternehmenskonto nutzbar sind (die eigenen Templates des Mandanten). Paginiert über ?page + ?pageSize (max. 100). Verwende den Detail-Endpunkt (oder .../{meetingTemplateId}/sections), um die Abschnitte eines Templates zu lesen.

Feldübersicht aus der Spezifikation

Jeder Eintrag enthält:

meetingTemplateId (string): Id des Templates (verwende sie für die Detail- und Abschnitts-Endpunkte).
title (string): Titel des Templates.
description (string | null): Beschreibung des Templates; null, wenn nicht gesetzt.

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

pagenumberoptional
Seitennummer, beginnend bei 1. Standard: 1.
pageSizenumberoptional
Einträge pro Seite. Standard: 25, maximal 100.
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: description, meetingTemplateId, title.
Beispiel: description,meetingTemplateId

Antwort: je Eintrag in items

meetingTemplateIdstringPflicht
Id des Meetingtemplates.
titlestringPflicht
Anzeigetitel des Templates.
descriptionstringPflichtkann null sein
Beschreibung des Templates.

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

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/meetingtemplates" \
  -H "Authorization: Bearer $SALLY_TOKEN"

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

Beispielantwort 200 OK

{
  "page": 1,
  "pageSize": 25,
  "total": 137,
  "hasMore": true,
  "items": [
    {
      "meetingTemplateId": "cffcc4d1-afe9-41b7-afd5-fe9d8fa24bad",
      "title": "string",
      "description": "string"
    }
  ]
}

Zeigt ein Meetingtemplate einschließlich seiner veröffentlichten Abschnitte an

GET/v1.0/directories/{directoryId}/meetingtemplates/{meetingTemplateId}

Gibt das Template und seine veröffentlichten Abschnitte in Sortierreihenfolge zurück. Jeder Abschnitt enthält seine meetingTemplateSectionId, also dieselbe Id, die ein Abschnittseintrag einer Zusammenfassung referenziert. So lässt sich ein Abschnittseintrag einer Zusammenfassung seinem Template-Abschnitt zuordnen. Wenn du nur die Abschnitte abrufen willst, verwende GET .../meetingtemplates/{meetingTemplateId}/sections.

Feldübersicht aus der Spezifikation

Felder der Antwort:

meetingTemplateId (string): Id des Templates.
title (string): Titel des Templates.
description (string | null): Beschreibung des Templates; null, wenn nicht gesetzt.
scope (string enum): wem das Template gehört: global (ein integriertes Sally-Template), directory (das eigene der Organisation), team oder personal.
sections (array): die veröffentlichten Abschnitte in Sortierreihenfolge. Jeder Abschnitt enthält:
- meetingTemplateSectionId (string): Id des Abschnitts; wird im meetingTemplateSectionId eines Abschnittseintrags einer Zusammenfassung referenziert.
- title (string): Titel des Abschnitts.
- description (string | null): Beschreibung des Abschnitts; null, wenn nicht gesetzt.
- sectionType (string enum): der Abschnittstyp (summary, tasks, topics, decisions, customList oder freeText).
- outputFormat (string enum): das Format, in dem der Abschnittsinhalt generiert wird (html oder markdown).
- detailLevel (string enum): der gewünschte Detailgrad des Abschnitts (short, medium oder long).
- sortOrder (number): Reihenfolge des Abschnitts innerhalb des Templates.
- additionalInstructions (string | null): zusätzliche Generierungsanweisungen für den Abschnitt; null, wenn keine.
- isTimestampInclusionEnabled (boolean): ob Zeitstempel aus dem Transkript in den Abschnitt aufgenommen werden.
- isResponsibleDetectionEnabled (boolean): ob für den Abschnitt eine verantwortliche Person erkannt wird.
- isDueDateInferenceEnabled (boolean): ob für den Abschnitt ein Fälligkeitsdatum abgeleitet wird.

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.
meetingTemplateIdstringPflicht
Id des Meetingtemplates.

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: description, meetingTemplateId, scope, sections, title.
Beispiel: description,meetingTemplateId

Antwort

meetingTemplateIdstringPflicht
Id des Meetingtemplates.
titlestringPflicht
Anzeigetitel des Templates.
descriptionstringPflichtkann null sein
Beschreibung des Templates.
scopestringPflicht
Sichtbarkeitsbereich. global = Sally-Standardtemplate; andernfalls gehört das Template dem Mandanten.
Erlaubte Werte: globaldirectoryteampersonal
sectionsobject[]Pflicht
Die veröffentlichten Abschnitte des Templates in Sortierreihenfolge.
11 Unterfelder
- meetingTemplateSectionIdstringPflicht
  Id des Abschnitts im Meetingtemplate. Das ist dieselbe Id, die ein Abschnittseintrag einer Zusammenfassung referenziert (meetingTemplateSectionId).
- titlestringPflicht
  Titel des Abschnitts.
- descriptionstringPflichtkann null sein
  Für Nutzer sichtbare Beschreibung des Abschnitts.
- sectionTypestringPflicht
  Typ des Abschnitts.
  Erlaubte Werte: summarytaskstopicsdecisionscustomListfreeTextunknown
- outputFormatstringPflicht
  Ausgabeformat des generierten Abschnittsinhalts.
  Erlaubte Werte: htmlmarkdownunknown
- detailLevelstringPflicht
  Gewünschter Detailgrad des KI-Abschnitts.
  Erlaubte Werte: shortmediumlongunknown
- sortOrdernumberPflicht
  Sortierreihenfolge innerhalb des Templates (aufsteigend).
- additionalInstructionsstringPflichtkann null sein
  Zusätzliche KI-Anweisungen (Prompt) für diesen Abschnitt.
- isTimestampInclusionEnabledbooleanPflicht
  Ob Zeitstempel in die Ausgabe des Abschnitts aufgenommen werden.
- isResponsibleDetectionEnabledbooleanPflicht
  Ob die Erkennung verantwortlicher Personen aktiviert ist.
- isDueDateInferenceEnabledbooleanPflicht
  Ob das Ableiten von Fälligkeitsdaten aktiviert ist.

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/meetingtemplates/$MEETING_TEMPLATE_ID" \
  -H "Authorization: Bearer $SALLY_TOKEN"

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

Beispielantwort 200 OK

{
  "meetingTemplateId": "cffcc4d1-afe9-41b7-afd5-fe9d8fa24bad",
  "title": "string",
  "description": "string",
  "scope": "global",
  "sections": [
    {
      "meetingTemplateSectionId": "0ba1ea56-516d-485a-a738-e65e51578bbe",
      "title": "string",
      "description": "string",
      "sectionType": "summary",
      "outputFormat": "html",
      "detailLevel": "short",
      "sortOrder": 1,
      "additionalInstructions": "string",
      "isTimestampInclusionEnabled": true,
      "isResponsibleDetectionEnabled": true,
      "isDueDateInferenceEnabled": true
    }
  ]
}

Listet nur die Abschnitte eines Meetingtemplates auf

GET/v1.0/directories/{directoryId}/meetingtemplates/{meetingTemplateId}/sections

Gibt nur die veröffentlichten Abschnitte des Templates in Sortierreihenfolge zurück: dieselben Abschnitte wie der Detail-Endpunkt, aber ohne die Metadaten des Templates. Jeder Abschnitt enthält seine meetingTemplateSectionId, dieselbe Id, die ein Abschnittseintrag einer Zusammenfassung referenziert (so lässt sich ein Abschnittseintrag einer Zusammenfassung seinem Template-Abschnitt zuordnen).

Feldübersicht aus der Spezifikation

Felder der Abschnitte:

meetingTemplateSectionId (string): Id des Abschnitts; wird im meetingTemplateSectionId eines Abschnittseintrags einer Zusammenfassung referenziert.
title (string): Titel des Abschnitts.
description (string | null): Beschreibung des Abschnitts; null, wenn nicht gesetzt.
sectionType (string enum): der Abschnittstyp (summary, tasks, topics, decisions, customList oder freeText).
outputFormat (string enum): das Format, in dem der Abschnittsinhalt generiert wird (html oder markdown).
detailLevel (string enum): der gewünschte Detailgrad des Abschnitts (short, medium oder long).
sortOrder (number): Reihenfolge des Abschnitts innerhalb des Templates.
additionalInstructions (string | null): zusätzliche Generierungsanweisungen für den Abschnitt; null, wenn keine.
isTimestampInclusionEnabled (boolean): ob Zeitstempel aus dem Transkript in den Abschnitt aufgenommen werden.
isResponsibleDetectionEnabled (boolean): ob für den Abschnitt eine verantwortliche Person erkannt wird.
isDueDateInferenceEnabled (boolean): ob für den Abschnitt ein Fälligkeitsdatum abgeleitet wird.

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.
meetingTemplateIdstringPflicht
Id des Meetingtemplates.

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: additionalInstructions, description, detailLevel, isDueDateInferenceEnabled, isResponsibleDetectionEnabled, isTimestampInclusionEnabled, meetingTemplateSectionId, outputFormat, sectionType, sortOrder, title.
Beispiel: additionalInstructions,description

Antwort

meetingTemplateSectionIdstringPflicht
Id des Abschnitts im Meetingtemplate. Das ist dieselbe Id, die ein Abschnittseintrag einer Zusammenfassung referenziert (meetingTemplateSectionId).
titlestringPflicht
Titel des Abschnitts.
descriptionstringPflichtkann null sein
Für Nutzer sichtbare Beschreibung des Abschnitts.
sectionTypestringPflicht
Typ des Abschnitts.
Erlaubte Werte: summarytaskstopicsdecisionscustomListfreeTextunknown
outputFormatstringPflicht
Ausgabeformat des generierten Abschnittsinhalts.
Erlaubte Werte: htmlmarkdownunknown
detailLevelstringPflicht
Gewünschter Detailgrad des KI-Abschnitts.
Erlaubte Werte: shortmediumlongunknown
sortOrdernumberPflicht
Sortierreihenfolge innerhalb des Templates (aufsteigend).
additionalInstructionsstringPflichtkann null sein
Zusätzliche KI-Anweisungen (Prompt) für diesen Abschnitt.
isTimestampInclusionEnabledbooleanPflicht
Ob Zeitstempel in die Ausgabe des Abschnitts aufgenommen werden.
isResponsibleDetectionEnabledbooleanPflicht
Ob die Erkennung verantwortlicher Personen aktiviert ist.
isDueDateInferenceEnabledbooleanPflicht
Ob das Ableiten von Fälligkeitsdaten aktiviert ist.

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/meetingtemplates/$MEETING_TEMPLATE_ID/sections" \
  -H "Authorization: Bearer $SALLY_TOKEN"

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

Beispielantwort 200 OK

[
  {
    "meetingTemplateSectionId": "0ba1ea56-516d-485a-a738-e65e51578bbe",
    "title": "string",
    "description": "string",
    "sectionType": "summary",
    "outputFormat": "html",
    "detailLevel": "short",
    "sortOrder": 1,
    "additionalInstructions": "string",
    "isTimestampInclusionEnabled": true,
    "isResponsibleDetectionEnabled": true,
    "isDueDateInferenceEnabled": true
  }
]

Listet die Meetingtemplates auf, die in einem Unternehmenskonto nutzbar sind​

Pfadparameter

Query-Parameter

Antwort: je Eintrag in items

Statuscodes

Zeigt ein Meetingtemplate einschließlich seiner veröffentlichten Abschnitte an​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Listet nur die Abschnitte eines Meetingtemplates auf​

Pfadparameter

Query-Parameter

Antwort

Statuscodes

Listet die Meetingtemplates auf, die in einem Unternehmenskonto nutzbar sind

Zeigt ein Meetingtemplate einschließlich seiner veröffentlichten Abschnitte an

Listet nur die Abschnitte eines Meetingtemplates auf