Summaries

A summary belongs to one recording and exists once per language. Use these endpoints to search summaries and to fetch a single summary by its id.

Every endpoint below shows its parameters and response fields in the middle and a request sample with an example response on the right.

Base URL https://api.sally.ioVersion v1.0 current, not frozen yetHow versioning works

Searches recording summaries (parameters in the body)

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

Searches recording summaries and returns a truncated snippet of the summary text per hit.

Field overview from the specification

Body fields:

search (string, optional, min. 3 characters): case-insensitive substring, matched anywhere over the summary text AND the generated section items (title/content/subject/description); a recording is a hit if ANY of these matches.
page (number, optional, default 1): 1-based page number.
pageSize (number, optional, default 25): page size, max. 100.

Path parameters

directoryIdstringrequired
Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

Query parameters

fieldsstringoptional
Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.
Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.
On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.
Selectable here: appointmentId, createdOn, languageCode, recordingId, recordingSummaryId, snippet.
Example: appointmentId,createdOn

Request body application/json

searchstringoptionalnullable
Case-insensitive substring match over the summary text and the generated section items (title/content/subject/description). Min. 3 characters.
pagenumberoptional
Page (1-based, default 1).
pageSizenumberoptional
Page size (default 25, max 100).

Response: each entry in items

recordingSummaryIdstringrequired
Id of the recording summary.
recordingIdstringrequired
Associated recording id.
appointmentIdstringrequirednullable
Associated appointment id (if present).
languageCodestringrequirednullable
Language code of the summary (IETF language tag, e.g. de-DE, en-US).
snippetstringrequired
Truncated excerpt of the summary text (max. 300 characters).
createdOnstringrequired
Creation timestamp (ISO-8601).

Every page also carries page, pageSize, total, hasMore.

Status codes

200Success
400
Invalid request (validation error).
401
Missing or invalid bearer token.
403
Forbidden (insufficient permissions).
404
Resource not found or not accessible.
429
Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.
500
Internal server error.

Request

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()

Response example 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"
    }
  ]
}

Returns a single recording summary by id

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

Returns the full recording summary for the given recordingSummaryId. 404 if the summary does not exist or the caller cannot access the underlying recording. Obtain valid ids from the summary search (POST .../summaries/search) or from GET .../recordings/{recordingId}/summaries.

Field overview from the specification

Path parameters:

directoryId (string): id of the directory (organization) the summary belongs to.
recordingSummaryId (string): id of the recording summary to return.

Response fields:

recordingSummaryId (string): id of this summary. A recording can have several summaries — one per language.
recordingId (string): id of the recording this summary was generated from.
appointmentId (string | null): id of the caller’s own appointment linked to the recording; null if the recording is not linked to an appointment.
languageCode (string | null): language of the summary text as an IETF language tag (e.g. de-DE, en-US); null if unknown.
summary (string | null): the summary text (Markdown); null if no summary text was generated.
createdOn (string): creation timestamp of the summary (UTC ISO-8601).
sectionItems (array): the structured, per-section results of the meeting template that produced this summary (always included on this endpoint). Each item has:
- sectionItemId (string): id of the section item.
- meetingTemplateSectionId (string | null): id of the meeting-template section this item was generated from (resolve via GET .../meetingtemplates/{meetingTemplateId}); null for derived items without a template section (e.g. task items).
- title (string): title of the section item.
- sectionType (string enum): the section type (summary, tasks, topics, decisions, customList or freeText).
- outputFormat (string enum): the format of content (html or markdown).
- sortOrder (number): order of the item within the summary.
- content (string | null): the free-text/Markdown content of the item.
- subject (string | null): task subject (for task-like section items).
- description (string | null): task description (for task-like section items).
- responsibleUserName (string | null): name of the responsible person (task items).
- responsibleUserEmail (string | null): email of the responsible person (task items).
- dueDate (string | null): due date of the task item (ISO-8601).

Path parameters

directoryIdstringrequired
Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.
recordingSummaryIdstringrequired
Id of the recording summary.

Query parameters

fieldsstringoptional
Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.
Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.
On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.
Selectable here: appointmentId, createdOn, isSummarizationCompleted, isSummarizationSucceeded, languageCode, recordingId, recordingSummaryId, sectionItems, summarizationCompletionReason, summary.
Example: appointmentId,createdOn

Response

recordingSummaryIdstringrequired
Id of the recording summary.
recordingIdstringrequired
Associated recording id.
appointmentIdstringrequirednullable
Associated appointment id (if present).
languageCodestringrequirednullable
Language code of the summary (IETF language tag, e.g. de-DE, en-US).
summarystringrequirednullable
Summary text.
isSummarizationCompletedbooleanrequired
True once the summarization run has finished, whether or not it produced anything.
isSummarizationSucceededbooleanrequired
True when there is something to read: summary text or at least one section item. A run over a recording without a transcript finishes too, and then this stays false.
summarizationCompletionReasonstringrequired
Why the summarization run ended. noTranscript means there was nothing to summarize, which is an expected outcome and not a failure. unknown while it has not finished. The underlying error text is deliberately not exposed.
Allowed values: succeedednoTranscriptemptyResulterrorunknown
createdOnstringrequired
Creation timestamp (ISO-8601).
sectionItemsobject[]requirednullable
The generated section items of the summary (the structured, per-section results of the meeting template). Null when not loaded (the recordings list endpoint only fills this with ?includeDetails=true); the single-summary endpoint always includes it.
12 child fields
- sectionItemIdstringrequired
  Id of the section item.
- meetingTemplateSectionIdstringrequirednullable
  Id of the meeting template section this item was generated from. Resolve it via GET /v1.0/directories/{directoryId}/meetingtemplates/{meetingTemplateId} (matches a section’s meetingTemplateSectionId). Null for derived items without a template section (e.g. task items).
- titlestringrequired
  Title of the template section item.
- sectionTypestringrequired
  Section type of the item.
  Allowed values: summarytaskstopicsdecisionscustomListfreeTextunknown
- outputFormatstringrequired
  Output format of the item content.
  Allowed values: htmlmarkdownunknown
- sortOrdernumberrequired
  Order within the summary.
- contentstringrequirednullable
  Free-text/Markdown content of the item.
- subjectstringrequirednullable
  Task subject (for task-like section items).
- descriptionstringrequirednullable
  Task description.
- responsibleUserNamestringrequirednullable
  Responsible person (name).
- responsibleUserEmailstringrequirednullable
  Responsible person (email).
- dueDatestringrequirednullable
  Due date (ISO-8601).

Status codes

200Success
400
Invalid request (validation error).
401
Missing or invalid bearer token.
404
Resource not found or not accessible.
429
Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.
500
Internal server error.

Request

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()

Response example 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"
    }
  ]
}

Searches recording summaries (parameters in the body)​

Path parameters

Query parameters

Request body application/json

Response: each entry in items

Status codes

Returns a single recording summary by id​

Path parameters

Query parameters

Response

Status codes

Searches recording summaries (parameters in the body)

Returns a single recording summary by id