Skip to main content

How to make your first call to the Sally API

This quickstart takes you from nothing to the summary of a real meeting in four calls. Every command works as it stands once your own token is in place.

You need a Sally account with access to at least one company account and one meeting that Sally has already summarized. No app registration and no approval step are required.

Quick navigation

  1. Create a token
  2. Find your company account
  3. List your recordings
  4. Read the summary
  5. Before you build on it

1. Create a token​

In Sally, open Settings, select Integrations under Configuration and switch to the Personal Access Token tab. Create a token and copy it right away.

The token starts with sally_user_api_. It belongs to you and acts with your permissions: it reaches exactly the company accounts you are a member of and sees exactly what you would see in the app. Store it in an environment variable:

export SALLY_TOKEN="sally_user_api_…"

2. Find your company account​

Nearly every path needs a directoryId, the id of the Sally company account the data belongs to. This call lists the company accounts your token can address:

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

Copy the directoryId you want to work with:

export DIRECTORY_ID="…"

Reference: GET/v1.0/me/directories/memberships

3. List your recordings​

There is one recording per recorded meeting. Ask only for the fields you need and the answer stays small:

curl "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/recordings?pageSize=5&fields=recordingId,name,createdOn" \
-H "Authorization: Bearer $SALLY_TOKEN"

Copy the recordingId of a meeting that already has a summary:

export RECORDING_ID="…"

Reference: GET/v1.0/directories/{directoryId}/recordings

4. Read the summary​

Add includeDetails=true to get the section items of your meeting template as well. Without it you only get the summary text.

curl "https://api.sally.io/v1.0/directories/$DIRECTORY_ID/recordings/$RECORDING_ID/summaries?includeDetails=true" \
-H "Authorization: Bearer $SALLY_TOKEN"

Reference: GET/v1.0/directories/{directoryId}/recordings/{recordingId}/summaries

5. Before you build on it​

Important

A recording can have several summaries, one per language. Always identify a summary by the recording together with its languageCode, never by the recording alone. Meetings, recordings & summaries explains why, and why the same meeting can show up several times as an appointment.

From here, pick the guide for what you are building: