Status

/summaries

Create summary

post

Creates a new summary for the specified transcription.

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

Path parameters
transcriptionIdstringRequired

Transcription ID.

Example: b438fda0-83e2-4835-92f9-c845ee3d5ea7
Body
transcriptionIdstringRequired

The transcription ID for which the summary should be created.

Example: b438fda0-83e2-4835-92f9-c845ee3d5ea7
templatestring · enumOptional

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 NarrativePossible values:
Responses
201
The summary job was scheduled successfully.
application/json
Responseany
post
POST /v1/summaries HTTP/1.1
Host: api.whereby.dev
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
  "template": "General Narrative"
}
No content

Get summaries

get

Returns a list of summaries

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

Query parameters
cursorstringOptional

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: 100Optional

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

Default: 50
sortByanyOptional

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

Example: roomName:asc
Responses
200
A JSON array representing the summaries.
application/json
get
GET /v1/summaries HTTP/1.1
Host: api.whereby.dev
Accept: */*

{
  "results": [
    {
      "summaryId": "c429ff78-9f03-49de-b427-546bcd848050",
      "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
      "summary": {
        "summary": "This is a meeting summary"
      },
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-01T00:01:00.000Z",
      "state": "completed",
      "modifiedAt": "2025-01-01T00:00:00.000Z",
      "template": "General Narrative"
    }
  ]
}

Get summary

get

Returns the specified summary.

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

Path parameters
summaryIdstringRequired

Summary ID.

Example: c429ff78-9f03-49de-b427-546bcd848050
Responses
200
A JSON object representing the summary.
application/json
ResponseobjectExample: {"summaryId":"c429ff78-9f03-49de-b427-546bcd848050","transcriptionId":"b438fda0-83e2-4835-92f9-c845ee3d5ea7","summary":{"summary":"This is a meeting summary"},"roomSessionId":"e2f29530-46ec-4cee-8b27-e565cb5bb2e9","roomName":"/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd","createdAt":"2025-01-01T00:00:00.000Z","startDate":"2025-01-01T00:00:00.000Z","endDate":"2025-01-01T00:01:00.000Z","state":"completed","modifiedAt":"2025-01-01T00:00:00.000Z","template":"General Narrative"}
get
GET /v1/summaries/{summaryId} HTTP/1.1
Host: api.whereby.dev
Accept: */*

{
  "summaryId": "c429ff78-9f03-49de-b427-546bcd848050",
  "transcriptionId": "b438fda0-83e2-4835-92f9-c845ee3d5ea7",
  "summary": {
    "summary": "This is a meeting summary"
  },
  "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
  "roomName": "/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "startDate": "2025-01-01T00:00:00.000Z",
  "endDate": "2025-01-01T00:01:00.000Z",
  "state": "completed",
  "modifiedAt": "2025-01-01T00:00:00.000Z",
  "template": "General Narrative"
}

Delete summary

delete

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 [email protected] to join our pilot program (terms and conditions apply).

Path parameters
summaryIdstringRequired

Summary ID.

Example: c429ff78-9f03-49de-b427-546bcd848050
Responses
204
The resource was deleted successfully.
delete
DELETE /v1/summaries/{summaryId} HTTP/1.1
Host: api.whereby.dev
Accept: */*

No content

Last updated

Was this helpful?