---
title: API Quick Start
description: 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 Informati
---

[Skip to content](https://help.syncwords.com/vod/api-quick-start#main-content)

[Contact Support](https://help.syncwords.com/vod/kb-tickets/new?hsLang=en) [Go to Customer Portal](https://tickets.syncwords.com/tickets-view?hsLang=en)

[![Syncwords-logo-color-black.png.png\]](https://help.syncwords.com/hs-fs/hubfs/Syncwords-logo-color-black.png.png?height=40&name=Syncwords-logo-color-black.png.png)](https://help.syncwords.com/migration/vod?hsLang=en)

- [SyncWords VOD Help](https://help.syncwords.com/vod)

Open main navigation

Close main navigation

- [SyncWords VOD Help](https://help.syncwords.com/vod)
- [Contact Support](https://help.syncwords.com/vod/kb-tickets/new)
- [Go to Customer Portal](https://tickets.syncwords.com/tickets-view)
- [Switch to Live Knowledge Base](https://help.syncwords.com/live)

[Switch to Live Knowledge Base](https://help.syncwords.com/live?hsLang=en)

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [SyncWords VOD Help](https://help.syncwords.com/vod?hsLang=en)
2. [Account](https://help.syncwords.com/vod/account?hsLang=en)
3. [Enterprise Users](https://help.syncwords.com/vod/account?hsLang=en#enterprise-users)

# API Quick Start

The SyncWords API is only available by request. To get access to our API [reach out](mailto:tickets@syncwords.com) 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](https://sw-offline.s3.amazonaws.com/syncwords-api-documentation.pdf) and [samples](http://syncwords-team.s3.amazonaws.com/api/swapi-samples.tar.gz).

**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](https://sw-offline.s3.amazonaws.com/syncwords-api-documentation.pdf).

- [The Basics](https://help.syncwords.com/vod/the-basics?hsLang=en#main-content)

    - [FAQ](https://help.syncwords.com/vod/the-basics?hsLang=en#faq)
    - [Resolving issues](https://help.syncwords.com/vod/the-basics?hsLang=en#resolving-issues)
    - [Getting Started](https://help.syncwords.com/vod/the-basics?hsLang=en#getting-started)
    - [Helpful Videos](https://help.syncwords.com/vod/the-basics?hsLang=en#helpful-videos)
- [Captions](https://help.syncwords.com/vod/captions?hsLang=en#main-content)

    - [Edit Captions](https://help.syncwords.com/vod/captions?hsLang=en#edit-captions)
    - [Captions](https://help.syncwords.com/vod/captions?hsLang=en#captions)
- [Transcripts](https://help.syncwords.com/vod/transcripts?hsLang=en#main-content)

    - [Transcription](https://help.syncwords.com/vod/transcripts?hsLang=en#transcription)
    - [Edit Transcript](https://help.syncwords.com/vod/transcripts?hsLang=en#edit-transcript)
- [Account](https://help.syncwords.com/vod/account?hsLang=en#main-content)

    - [Enterprise Users](https://help.syncwords.com/vod/account?hsLang=en#enterprise-users)
    - [Settings](https://help.syncwords.com/vod/account?hsLang=en#settings)
    - [Integrations](https://help.syncwords.com/vod/account?hsLang=en#integrations)
    - [Billing](https://help.syncwords.com/vod/account?hsLang=en#billing)
- [Tools, Tips & Videos](https://help.syncwords.com/vod/tools-tips-videos?hsLang=en#main-content)

    - [Helpful Videos](https://help.syncwords.com/vod/tools-tips-videos?hsLang=en#helpful-videos)
    - [Using SyncWords with Other Tools](https://help.syncwords.com/vod/tools-tips-videos?hsLang=en#using-syncwords-with-other-tools)

[![](https://help.syncwords.com/hs-fs/hubfs/5e7383edff0f8e6e3c4967b0_sw-logo-black-1.png?width=169&height=36&name=5e7383edff0f8e6e3c4967b0_sw-logo-black-1.png)](https://help.syncwords.com/vod?hsLang=en)

syncwords.com Help Center

Copyright © 2025, SyncWords