/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).

POSThttps://api.whereby.dev/v1/summaries

Path parameters

transcriptionId*any

Transcription ID.

Example: "1"

Body

application/json

transcriptionId*string

The transcription ID for which the summary should be created.

Example: "1"

templateenum

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"

SOAPExtended SOAPGeneral NarrativeGeneral BulletedEducational LectureEducational Tutoring

Response

201401404429

The summary job was scheduled successfully.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/summaries', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transcriptionId": "1"
    }),
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

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

GEThttps://api.whereby.dev/v1/summaries

Query parameters

Response

200401429

A JSON array representing the summaries.

Body

application/json

results*array of Summary (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/summaries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "results": [
    {
      "summaryId": "1",
      "transcriptionId": "1",
      "summary": {
        "summary": "This is a meeting summary"
      },
      "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"
    }
  ]
}

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

GEThttps://api.whereby.dev/v1/summaries/{summaryId}

Path parameters

summaryId*any

Summary ID.

Example: "1"

Response

200401404429

A JSON object representing the summary.

Body

application/json

Summary (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/summaries/{summaryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

{
  "summaryId": "1",
  "transcriptionId": "1",
  "summary": {
    "summary": "This is a meeting summary"
  },
  "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"
}

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

DELETEhttps://api.whereby.dev/v1/summaries/{summaryId}

Path parameters

summaryId*any

Summary ID.

Example: "1"

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://api.whereby.dev/v1/summaries/{summaryId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}