Rest API

Get Event

Get a single event

GET /events/{event_id}

ParameterWhereTypeDescription
linguisticsquerybooleanWhether or not to include linguistic extras in data
transcriptsquerybooleanWhether or not to include individual best available transcripts
improved_onlyquerybooleanWhether or not to only return the post-realtime improved transcripts
word_offsetsquerybooleanWhether to include word-by-word durations and offsets

Response

{
  "event_id": 1234567,
  "title": "My Awesome Private Recording",
  "event_date": "2023-06-26T14:26:37-04:00",
  "event_type": "custom",
  "transcription_status": "archived",
  "created": "2023-06-26T14:26:37-04:00",
  "modified": "2023-06-26T14:34:38-04:00",
  "linguistics": {
    "topics": [],
    "sentiment": {
      "average": 0.15947602040816328,
      "median": 0.2049071428571429,
      "minimum": -0.2444,
      "maximum": 0.9349
    }
  },
  "transcripts": [
    {
      "transcript_item_id": 123456789,
      "transcript": "Hello, and welcome to Aiera's test event.",
      "timestamp": "2023-06-26T14:26:50-04:00",
      "start_ms": 0,
      "duration_ms": 4616,
      "pretty_word_durations_ms": [420, 190],
      "pretty_word_offsets_ms": [40, 460],
      "word_durations_ms": [420, 190],
      "word_offsets_ms": [40, 460],
      "speaker_id": 1234567,
      "speaker_type": "dia",
      "audio_url": "https://audio-dev.aiera.com/api/events/1234567/transcript/123456789/audio?api_key={API_KEY}",
      "is_improved": true,
      "is_edited": false,
      "modified": "2023-06-26T14:28:00-04:00",
      "linguistics": {
        "topics": [],
        "sentiment": {
          "average": 0.0,
          "median": 0.0,
          "minimum": 0.0,
          "maximum": 0.0
        },
        "sentiment_breakouts": []
      }
    }
  ]
}

Code Samples

Bash

  curl --request GET \
  --url 'null.com/api/speech-v1/events/{event_id}' \
  --header 'X-API-Key: xxx'

Python

import requests
requests.get(
    "null/api/speech-v1/events/{event_id}",
    headers={"X-API-Key": "xxx"}
)
Previous
Get Events