API Quick Start

The SyncWords API is only available by request. To get access to our API reach out to request access.

To get started with the API, log in to SyncWords, find your API keys in My Account > API Information and download the documentation and samples.

NOTE: To use the samples you should enable simple authorization in the cms.

Working with SyncWords typically involves the following steps:

1) Send your media (and possibly your transcript), and note the project ID.

To send only the media and request ASR:

./swapi-post-asr-project.sh <API Public Key> "My Project" my_media.mp3

To send media and transcript for timestamping:

./swapi-post-project <API Public Key> "My Project" my_media.mp3 my_transcript.doc

2) Wait for the work to finish.

To check the status of the project:

./swapi-get-project.sh <API Public Key> <Project ID>

3) Download your captions.

To download the captions associated with a preset that's been saved on the site:

./swapi-get-profiles.sh <API Public Key>

./swapi-get-captions.sh <API Public Key> <Project ID> <Profile ID> my_captions.zip

For more details, please see the SyncWords API documentation.

792 Bytes