Skip to main content

How appointments, recordings and summaries relate

If you read only one concept page, read this one. Appointments, recordings and summaries look interchangeable, but they are scoped differently, and that difference is where most integrations go wrong.

Quick navigation

  1. An appointment exists per person
  2. A recording exists once
  3. A summary exists per language
  4. What that means in practice
  5. All entities at a glance

1. An appointment exists per person​

Every attendee of the same real-world meeting has their own appointment record. A meeting with six people can therefore appear up to six times inside one company account, with the same subject and the same time.

Important

Never treat subject plus time as an identity. Counting appointments does not count meetings, and grouping by subject merges things that are not the same. If you need the meeting, go through the recording.

2. A recording exists once​

There is exactly one recording per recorded meeting within a company account, no matter how many people attended. That makes the recording the stable anchor: it is what you store, deduplicate and join on.

3. A summary exists per language​

A summary belongs to exactly one recording, and a recording can have several summaries, one per language. A summary is unique per recording and languageCode. To pick a specific one, use both.

4. What that means in practice​

  • Store the recordingId as your foreign key, not the appointment.
  • When you show a meeting to a user, use the appointment of that user, because it carries their view of the meeting.
  • When you import summaries, iterate over recordings and pick the language you want, instead of iterating over appointments and importing the same meeting several times.
Example

Six colleagues attend the same weekly meeting. The company account holds six appointments, one recording and, if summaries exist in German and English, two summaries. An importer keyed on the appointment would create six entries for one meeting.

5. All entities at a glance​

Most resources live under a company account: /v1.0/directories/{directoryId}/….

EntityWhat it is
DirectoryA Sally company account and the top-level tenant. Every other resource belongs to exactly one directory.
User / MembershipA person, and the link between a user and a company account with a role and a license.
Role / LicenseLookups that a membership refers to.
TeamA named group of users inside a company account.
AppointmentA calendar meeting with its attendees, stored once per user.
RecordingOne audio or video recording of a meeting, plus its transcript.
SummaryThe AI summary of a recording, one per language, made of section items.
Meeting templateDefines the sections a summary is generated into (read-only).
Folder / TagOrganize recordings in a tree and label appointments and recordings.
TaskAn action item, often derived from a meeting.
VocabularyTerms that improve transcription.
WebhookAn outgoing subscription that sends events to your URL.
FileA binary asset such as a profile picture, fetched by id.