/summaries

Create summary

Creates a new summary for the specified transcription.

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

post

/summaries

Path parameters

transcriptionIdanyrequired

Transcription ID.

Example: 1

Body

transcriptionIdstringrequired

The transcription ID for which the summary should be created.

Example: 1

templatestring · enum

The template that the summary should be created from. The following summary templates are currently available:

• General Bulleted
• General Narrative
• SOAP
• Extended SOAP
• General Narrative
• Educational Lecture
• Educational Tutoring

Example: General Narrative

Options: SOAP, Extended SOAP, General Narrative, General Bulleted, Educational Lecture, Educational Tutoring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/summaries' \
  --header 'Content-Type: application/json' \
  --data '{"transcriptionId":"1","template":"General Narrative"}'

201

401

404

429

201

No body

The summary job was scheduled successfully.

Get summaries

Returns a list of summaries

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

get

/summaries

Query parameters

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 50

The limit for the pagination - the maximum number of results that will be returned within a single API response.

sortByany

Sort results by a field. Accepted fields are: roomName, startDate and durationInSeconds. Accepted sort values are 'asc' and 'desc'.

Example: roomName:asc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.whereby.dev/v1/summaries'

200

401

429

200

{
  "results": [
    {
      "summaryId": "1",
      "transcriptionId": "1",
      "roomSessionId": "1",
      "roomName": "room-name",
      "startDate": "2020-01-01T00:00:00.000Z",
      "endDate": "2020-01-01T00:00:00.000Z",
      "state": "completed",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "modifiedAt": "2020-01-01T00:00:00.000Z",
      "template": "General Narrative",
      "summary": {
        "summary": "This is a meeting summary"
      }
    }
  ]
}

A JSON array representing the summaries.

Get summary

Returns the specified summary.

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

get

/summaries/{summaryId}

Path parameters

summaryIdanyrequired

Summary ID.

Example: 1

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.whereby.dev/v1/summaries/{summaryId}'

200

401

404

429

200

{
  "summaryId": "1",
  "transcriptionId": "1",
  "roomSessionId": "1",
  "roomName": "room-name",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-01-01T00:00:00.000Z",
  "state": "completed",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "modifiedAt": "2020-01-01T00:00:00.000Z",
  "template": "General Narrative",
  "summary": {
    "summary": "This is a meeting summary"
  }
}

A JSON object representing the summary.

Delete summary

Deletes the specified summary. The endpoint is idempotent, meaning it will return the same response even if the summary has already been deleted.

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

delete

/summaries/{summaryId}

Path parameters

summaryIdanyrequired

Summary ID.

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.whereby.dev/v1/summaries/{summaryId}'

204

401

429

204

No body

The resource was deleted successfully.