Rest API
Create Event
Create an event to be transcribed live, either by phone, webcast, or stream (or by uploading a file for bulk processing)
POST /events/create
Parameter | Where | Type | Default | Description |
---|---|---|---|---|
title | form | string | - | Title of the recording |
webcast_url | form | string | - | Webcast URL for processing |
stream_url | form | string | - | Streaming URL for processing (DASH or HLS) |
phone_number | form | string | - | Phone number for processing |
audio_url | form | string | - | URL of a file to bulk process |
event_date | form | datetime | null | Date and time of the event |
phone_pin | form | string | null | Pin for processing |
equity_id | form | string | null | ID of equity, if needed |
human_intervention | form | boolean | false | Whether to allow agents to assist in connecting the event (if needed) |
human_editing | form | boolean | false | Whether to have human editors review and cleanup the transcript on completion |
- while webcast_url, stream_url, phone_number, and audio_url are not individually required, at least one must be provided as a source of audio
- human_intervention and human_editing are premium paid features.
Response
{
"event_id": 1234567
}
Code Samples
Bash
curl --request POST \
--url 'null/api/speech-v1/events/create' \
--header 'X-API-Key: xxx' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'title=TITLE&webcast_url=WEBCAST_URL'
Python
import requests
requests.post(
"null/api/speech-v1/events/create",
headers={"X-API-Key": "xxx"},
data={
"title": "POTUS State of the Union",
"webcast_url": "https://www.youtube.com/watch?v=gzcBTUvVp7M"
}
)