List

To list the captions (transcripts) for a concrete room you need to execute a GET request against the /rooms/:id/captions endpoint.

Use the session_id argument if you want to list transcripts for in a concrete session. https://api.digitalsamba.com/api/v1/rooms/c39d7c40-7ff7-4faa-b06f-698a639a9523/captions?session_id=16e44502-dae5-41f9-b095-e41bf6ac2d1d

Since potentially there could be a lot of transcript records, pagination is supported with limit, order and after arguments. Read about pagination to learn the details of it. By default maximum 100 transcripts will be returned in the response.

Request

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/rooms/c39d7c40-7ff7-4faa-b06f-698a639a9523/captions \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

Response (200 OK)

{
    "total_count": 3,
    "data": [
        {
            "participant_id": "f06e6600-9424-4dc0-8e7d-a968df2c983d",
            "participant_name": "John Smith",
            "transcript": "Morning. How are you?",
            "start_time": "2024-04-10T12:18:27Z",
            "end_time": "2024-04-10T12:33:27Z"
        },
        {
            "participant_id": "f06e6600-9424-4dc0-8e7d-a968df2c983d",
            "participant_name": "Jane Doe",
            "transcript": "I am fine, thanks! What about you?",
            "start_time": "2024-04-10T12:10:27Z",
            "end_time": "2024-04-10T12:31:27Z"
        },
        {
            "participant_id": "f06e6600-9424-4dc0-8e7d-a968df2c983d",
            "participant_name": "John Doe",
            "transcript": "Hi all!",
            "start_time": "2024-04-10T12:06:27Z",
            "end_time": "2024-04-10T12:33:27Z"
        }
    ]
}

Last updated