API Introduction

The SpeechKit API is organized around REST. Our API returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Requests should include: content-type: application/json.

Prepare content

Prior to using the API to create audio, you should make sure that your content is in a suitable format to be processed.

We recommend submitting title and body content in HTML. This is because the HTML provides SpeechKit with context that helps us to better process text into audio e.g. paragraphs, sub-headings, etc.

Submit HTML

The HTML markup is submitted via a JSON request, so make sure it is valid by escaping quotation marks and forward slashes:

<h4 class=\"line\" data-line=\"0\">h4 Heading<\/h4>
<p class=\"line\" data-line=\"2\"><strong>This is bold text<\/strong><\/p>
<p class=\"line\" data-line=\"4\"><em>This is italic text<\/em><\/p>

Submit Markdown

You can also submit content in Markdown.

#### Heading
**This is bold text**
_This is italic text_

Submit plain text

For plain text, use \n\n to signify a new paragraph.

Heading
This is bold text
This is italic text

Authentication

The SpeechKit API uses API Keys to authenticate requests. You can view and manage your API keys for each Project in the Project Settings.

API

Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.

API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Next steps

Create an audio
Update an audio
Delete an audio
Retrieve an audio
List all audios