Create Transcrippet™

Save a portion of text and audio, including speaker, event, and company metadata from any Aiera event transcript.

POST /transcrippets/create

Parameter	Type	DataType	Description
event_id	query	integer	ID of the event
transcript	query	string	The text of the event transcript to capture
transcript_item_id	query	integer	ID of the first transcript item in the selected text
transcript_item_offset	query	integer	Number of characters from the beginning of the starting transcript item text until the start of the captured Transcrippet™ text
transcript_end_item_id	query	integer	ID of the last transcript item in the selected text
transcript_end_item_offset	query	integer	Number of characters from the end of the captured Transcrippet™ text until the end of the last transcript item
company_id	query	integer	ID of the company to which the event belongs (optional)
equity_id	query	integer	ID of the equity to which the event belongs (optional)

Response

{
  "transcrippet_id": 123456789,
  "company_id": 3190,
  "equity_id": 16597,
  "event_id": 2549093,
  "speaker_id": null,
  "transcript_item_id": 128281288,
  "user_id": 123456789,
  "audio_url": "https://audio.aiera.com/api/events/2549093/audio?api_key=your-rest-api-key",
  "company_logo_url": "https://s3.amazonaws.com/content.aiera.co/assets/equities-16597-2-2023-icon.png",
  "company_name": "Wesfarmers Limited",
  "company_ticker": "WES",
  "created": "2024-02-14T23:17:19",
  "end_ms": 4642767,
  "event_date": "2024-02-14T21:00:00",
  "event_title": "Half Year 2024 Wesfarmers Ltd Earnings Call",
  "event_type": "earnings",
  "modified": "2024-02-14T23:17:19",
  "speaker_name": null,
  "speaker_title": null,
  "start_ms": 4637287,
  "transcript": "There are opportunities we see to enhance the operating model",
  "transcrippet_guid": "02480b976c2596bd77cb7a0d59540313",
  "transcription_audio_offset_seconds": 313,
  "trimmed_audio_url": "https://s3.amazonaws.com/content.aiera.co/transcrippets/123456789-2549093.mp3",
  "word_durations_ms": [210, 90, 750, 120, 450, 210, 390, 90, 420, 270, 150]
}

Code Samples

Note: If you're copying any of the code, make sure to replace "your-rest-api-key" with your actual api key.

Bash

curl --request POST \
  --url 'https://premium.aiera.com/api/transcrippets/create' \
  --header 'X-API-Key: your-rest-api-key'
  --data 'event_id=2549093&transcript=There%20are%20opportunities%20we%20see%20to%20enhance%20the%20operating%20model&transcript_item_id=128281288&transcript_item_offset=67&transcript_end_item_id=128281288&transcript_end_item_offset=127'

Python

import requests
requests.post(
    "https://premium.aiera.com/api/transcrippets/create",
    headers={"X-API-Key": "your-rest-api-key"},
    data={
        "event_id": 2549093,
        "transcript": "There are opportunities we see to enhance the operating model",
        "transcript_item_id": 128281288,
        "transcript_item_offset": 67,
        "transcript_end_item_id": 128281288,
        "transcript_end_item_offset": 127
    }
)

Embeddable Code Example

Below is sample HTML code that demonstrates the simplicity and ease of embedding Aiera's Transcrippets™ component.

<script src="https://public.aiera.com/aiera-sdk/0.0.68/embed.js"></script>
<iframe id="aiera-transcrippet" width="100%" style="border:none"></iframe>
<script>
  const e = new Aiera.Module(
    'https://public.aiera.com/aiera-sdk/0.0.68/modules/Transcrippet/index.html',
    'aiera-transcrippet'
  )
  e.load().then(() => {
    e.authenticateApiKey('750bcdb788895603e78c34f3f28f12dd')
  })
  e.on('authenticated', () => {
    e.configure({
      options: { transcrippetGuid: '02480b976c2596bd77cb7a0d59540313' },
      overrides: {
        style: `
            .text-blue-600 {
                color: #008094 !important;
            }
        `,
      },
    })
  })
  e.on('transcrippet-height', (t) => {
    const n = document.getElementById('aiera-transcrippet')
    n && n.style && (n.style.height = t + 'px')
  })
</script>