# AudioStack Integration via LowCodeAPI

## Overview

Platform for creating and managing audio content including text-to-speech and audio production

## Base Endpoint

```
https://api.lowcodeapi.com/audiostack/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [https://audiostack.ai](https://audiostack.ai)
2. **Get your credentials** from [https://audiostack.com/account/api](https://audiostack.com/account/api)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your AudioStack API key
- Apply it to each request with `Authorization` header

**Auth Type**: API Key (Authorization header)

## API Categories

- Text to Audio AI

## Common Endpoints

### Category: File

#### Creates a url for uploading a new file.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/file/create-upload-url`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/create-upload-url&api_token={api_token}
```


**Body Parameters**:

| `tags` | array | No | A list of tags in string format |
| `source` | string | No | By default this will be the client used to upload i.e. api, sdk |
| `category` | string | No | An arbitrary category for this file. |
| `filePath` | string | Yes | File path in the backend where the file will be created. Arbitrary folder paths are supported, and folders not yet created will be created. |
| `metadata` | object | No | Freeform object for representing metadata |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/create-upload-url?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tags":"value","source":"value","category":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postfile](https://docs.audiostack.ai/reference/postfile)

---

#### Transfers a file created in the audiostack api

**Method**: `PUT` | **LowCodeAPI Path**: `https://v2.api.audio/content/file/transfer-file`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/transfer-file&api_token={api_token}
```


**Body Parameters**:

| `url` | string | Yes | A valid url in the format: https://v2.api.audio/file/.. |
| `tags` | array | No | A list of tags in string format |
| `category` | string | No | An arbitrary category for this file. |
| `filePath` | string | Yes | File path in the backend where the file will be created. Arbitrary folder paths are supported, and folders not yet created will be created. There is no need to supply the extension on transferred files. |
| `metadata` | object | No | Freeform object for representing metadata |


**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/transfer-file?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"value","tags":"value","category":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postfiletransfer](https://docs.audiostack.ai/reference/postfiletransfer)

---

#### Search for files.

**Method**: `GET` | **LowCodeAPI Path**: `/content/file/search`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/content/file/search?...&api_token={api_token}
```


**Query Parameters**:

| `name` | string | No |  |
| `path` | string | No |  |
| `tags` | array of strings | No |  |
| `source` | string | No |  |
| `category` | string | No |  |
| `fileType` | string | No |  |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/content/file/search?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/searchfiles](https://docs.audiostack.ai/reference/searchfiles)

---

#### Get a file object and creates a url for downloading it.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/content/file/id/fileId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/id/fileId?fileId={fileId}&api_token={api_token}
```


**Path Parameters**:

| `fileId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/id/fileId?fileId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getfileid](https://docs.audiostack.ai/reference/getfileid)

---

#### Deletes a file.

**Method**: `DELETE` | **LowCodeAPI Path**: `https://v2.api.audio/content/file/id/fileId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/id/fileId?fileId={fileId}&api_token={api_token}
```


**Path Parameters**:

| `fileId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/id/fileId?fileId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletefileid](https://docs.audiostack.ai/reference/deletefileid)

---

#### Updates a file resource

**Method**: `PATCH` | **LowCodeAPI Path**: `https://v2.api.audio/content/file/id/fileId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/id/fileId?fileId={fileId}&api_token={api_token}
```


**Path Parameters**:

| `fileId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Body Parameters**:

| `tags` | array | No |  |
| `category` | string | No |  |
| `filePath` | string | No |  |
| `metadata` | object | No |  |


**Example Request**:
```bash
curl -X PATCH "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/file/id/fileId?fileId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tags":"value","category":"value","filePath":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/patchfile](https://docs.audiostack.ai/reference/patchfile)

---

### Category: Folder

#### Creates an empty folder

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/folder`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/folder&api_token={api_token}
```


**Body Parameters**:

| `folder` | string | Yes |  |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/folder?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"folder":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/createfolder](https://docs.audiostack.ai/reference/createfolder)

---

#### Deletes a folder.

**Method**: `DELETE` | **LowCodeAPI Path**: `https://v2.api.audio/content/folder`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/folder?...&api_token={api_token}
```


**Query Parameters**:

| `folder` | string | Yes |  |
| `forceDelete` | string | No |  |


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/folder?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletefolder](https://docs.audiostack.ai/reference/deletefolder)

---

### Category: Recommend

#### Get recommended tags from user-specified list

**Method**: `POST` | **LowCodeAPI Path**: `/content/recommend/tag`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/content/recommend/tag&api_token={api_token}
```


**Body Parameters**:

| `tags` | array of strings | Yes | User specified list of tags to use |
| `text` | string | Yes | Text to get tags recommendations for. |
| `category` | string | No | User specified category. |
| `number_of_results` | number | No | Number of tags to get back. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/content/recommend/tag?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tags":"value","text":"value","category":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postrecommendtags](https://docs.audiostack.ai/reference/postrecommendtags)

---

#### Get recommended tones

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/recommend/tone`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/recommend/tone&api_token={api_token}
```


**Body Parameters**:

| `text` | string | Yes | Text to get tone recommendations for. |
| `number_of_results` | integer | No | Number of tags to get back. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/recommend/tone?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"value","number_of_results":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postrecommendtones](https://docs.audiostack.ai/reference/postrecommendtones)

---

#### Get recommended moods

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/recommend/mood`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/recommend/mood&api_token={api_token}
```


**Body Parameters**:

| `text` | string | Yes | Text to get mood recommendations for. |
| `number_of_results` | integer | No | Number of tags to get back. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/recommend/mood?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"value","number_of_results":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postrecommendmoods](https://docs.audiostack.ai/reference/postrecommendmoods)

---

#### Get recommended IAB category

**Method**: `POST` | **LowCodeAPI Path**: `/content/recommend/iab_category`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/content/recommend/iab_category&api_token={api_token}
```


**Body Parameters**:

| `text` | string | Yes | Text to get IAB categories for. |
| `language` | string | No | 2-letter language code for text - e.g. en |
| `num_tags` | integer | No | Number of IAB tags to get back. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/content/recommend/iab_category?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"value","language":"value","num_tags":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postrecommendiabcategory](https://docs.audiostack.ai/reference/postrecommendiabcategory)

---

### Category: Script

#### Create a Script resource.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/script`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script&api_token={api_token}
```


**Body Parameters**:

| `moduleName` | string | No |  |
| `scriptName` | string | No |  |
| `scriptText` | string | Yes |  |
| `projectName` | string | No |  |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"moduleName":"value","scriptName":"value","scriptText":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postscript](https://docs.audiostack.ai/reference/postscript)

---

#### Updates a Script resource.

**Method**: `PUT` | **LowCodeAPI Path**: `https://v2.api.audio/content/script`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script&api_token={api_token}
```


**Body Parameters**:

| `version` | string | No | By default this will update v0, however you can set this field to update/create an additional version of this scriptId |
| `scriptId` | string | Yes | The scriptId of the resource to be updated. |
| `scriptText` | string | Yes | Script text to replace, or add to new version |


**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"version":"value","scriptId":"value","scriptText":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/putscript](https://docs.audiostack.ai/reference/putscript)

---

#### Lists multiple script resources.

**Method**: `GET` | **LowCodeAPI Path**: `/content/scripts`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/content/scripts?...&api_token={api_token}
```


**Query Parameters**:

| `verbose` | boolean | No |  |
| `scriptId` | string | No |  |
| `moduleName` | string | No |  |
| `scriptName` | string | No |  |
| `projectName` | string | No |  |
| `paginationToken` | string | No |  |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/content/scripts?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listscripts](https://docs.audiostack.ai/reference/listscripts)

---

#### Get a single script.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/content/script/scriptId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId?scriptId={scriptId}&...&api_token={api_token}
```


**Query Parameters**:

| `voice` | string | No | Which TTS voice should be used to generate the preview, note that this required as different voices require different text correction processes. |
| `preview` | string | No | Preview the effect of applying various text correction processes, normalisation and dictionary. |


**Path Parameters**:

| `scriptId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId?scriptId=VALUE&...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getscriptid](https://docs.audiostack.ai/reference/getscriptid)

---

#### Deletes a script and all its versions (if applicable).

**Method**: `DELETE` | **LowCodeAPI Path**: `https://v2.api.audio/content/script/scriptId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId?scriptId={scriptId}&api_token={api_token}
```


**Path Parameters**:

| `scriptId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId?scriptId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletescriptid](https://docs.audiostack.ai/reference/deletescriptid)

---

#### Get a single version of a script with a given scriptId.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/content/script/scriptId/version`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId/version?version={version}&scriptId={scriptId}&...&api_token={api_token}
```


**Query Parameters**:

| `voice` | string | No | Which TTS voice should be used to generate the preview, note that this required as different voices require different text correction processes. |
| `preview` | string | No | Preview the effect of applying various text correction processes, normalisation and dictionary. |


**Path Parameters**:

| `version` | string |  |
| `scriptId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId/version?version=VALUE&...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getscriptversion](https://docs.audiostack.ai/reference/getscriptversion)

---

#### Deletes a single version of a script.

**Method**: `DELETE` | **LowCodeAPI Path**: `https://v2.api.audio/content/script/scriptId/version`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId/version?version={version}&scriptId={scriptId}&api_token={api_token}
```


**Path Parameters**:

| `version` | string |  |
| `scriptId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/script/scriptId/version?version=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletescriptversion](https://docs.audiostack.ai/reference/deletescriptversion)

---

#### Lists all projects that have been created.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/content/list_projects`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/list_projects&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/list_projects&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listscriptprojects](https://docs.audiostack.ai/reference/listscriptprojects)

---

#### Generate an advert using AI based on a Productdescription.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/generate/advert`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/generate/advert&api_token={api_token}
```


**Body Parameters**:

| `mood` | string | No |  |
| `tone` | string | No |  |
| `adLength` | number | No |  |
| `productName` | string | Yes |  |
| `thirdPerson` | boolean | No |  |
| `productDescription` | string | Yes |  |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/generate/advert?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mood":"value","tone":"value","adLength":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/generateadvert](https://docs.audiostack.ai/reference/generateadvert)

---

#### Edit an advert.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/content/edit/advert`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/edit/advert&api_token={api_token}
```


**Body Parameters**:

| `voice` | string | No |  |
| `adText` | string | Yes |  |
| `filters` | object | No |  |
| `adLength` | number | No |  |
| `instruction` | string | Yes |  |
| `productName` | string | Yes |  |
| `soundTemplate` | string | No |  |
| `productDescription` | string | No |  |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/content/edit/advert?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"voice":"value","adText":"value","filters":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/editadvert](https://docs.audiostack.ai/reference/editadvert)

---

### Category: Voice

#### List all available voices.

**Method**: `GET` | **LowCodeAPI Path**: `/speech/voice`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/voice?...&api_token={api_token}
```


**Query Parameters**:

| `page` | number | No | Page number to be returned. |
| `sort` | string | No | Sort order of items by an attribute. |
| `tags` | string | No | Tags of the voice. Multiple tags separated by comma are accepted. |
| `accent` | string | No | Accent of the voice. |
| `gender` | string | No | Gender of the voice. |
| `language` | string | No | Language of the voice. |
| `provider` | string | No | Provider of the voice. |
| `pageLimit` | number | No | Max. amount of items to be returned per page. |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/speech/voice?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listvoices](https://docs.audiostack.ai/reference/listvoices)

---

#### Lists voice parameters.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/speech/voice/parameter`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/voice/parameter&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/voice/parameter&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listvoiceparameters](https://docs.audiostack.ai/reference/listvoiceparameters)

---

#### Get data for a single voice.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/speech/voice/name`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/voice/name?name={name}&api_token={api_token}
```


**Path Parameters**:

| `name` | string | Alias or original voice ID. |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/voice/name?name=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getvoicename](https://docs.audiostack.ai/reference/getvoicename)

---

#### Get a voice and speed recommendation for your content.

**Method**: `POST` | **LowCodeAPI Path**: `/speech/voice/select`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/voice/select&api_token={api_token}
```


**Body Parameters**:

| `tone` | string | No |  |
| `content` | string | Yes |  |
| `filters` | object | No |  |
| `scriptId` | string | No |  |
| `targetLength` | number | No |  |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/speech/voice/select?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tone":"value","content":"value","filters":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/selectvoice](https://docs.audiostack.ai/reference/selectvoice)

---

### Category: Dictionary

#### Add word to a custom dictionary

**Method**: `PUT` | **LowCodeAPI Path**: `/speech/diction/custom/item`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/diction/custom/item&api_token={api_token}
```


**Body Parameters**:

| `lang` | string | No | Language family, e.g. en or es.dictionary - use global to register a word globally (default). |
| `word` | string | Yes | Word to be replaced. |
| `contentType` | string | No | The content type of the supplied replacement, can be either basic (default) or ipa for phonetic replacements. |
| `replacement` | string | Yes | The replacement token. Can be either a plain string or a IPA token. |
| `specialization` | string | No | by default the supplied replacement will apply regardless of the supplied voice, language code or provider. However edge cases can be supplied, these can be either a valid; provider name, language code (i.e. en-gb) or voice name. |


**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/audiostack/speech/diction/custom/item?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"lang":"value","word":"value","contentType":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/putwordindictionary](https://docs.audiostack.ai/reference/putwordindictionary)

---

#### Deletes a word from a dictionary.

**Method**: `DELETE` | **LowCodeAPI Path**: `/speech/diction/custom/item`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/diction/custom/item?...&api_token={api_token}
```


**Query Parameters**:

| `lang` | string | Yes |  |
| `word` | string | Yes |  |
| `specialization` | string | No | Delete a specific specialization |


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostack/speech/diction/custom/item?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletewordindictionary](https://docs.audiostack.ai/reference/deletewordindictionary)

---

#### List dictionaries

**Method**: `GET` | **LowCodeAPI Path**: `/speech/diction`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/diction&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/speech/diction&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listdictionaries](https://docs.audiostack.ai/reference/listdictionaries)

---

#### List dictionaries

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/speech/diction/custom`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/diction/custom&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/diction/custom&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listcustomdictionaries](https://docs.audiostack.ai/reference/listcustomdictionaries)

---

#### Lists all words within a custom dictionary.

**Method**: `GET` | **LowCodeAPI Path**: `/speech/diction/custom/items`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/diction/custom/items?...&api_token={api_token}
```


**Query Parameters**:

| `lang` | string | Yes |  |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/speech/diction/custom/items?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listcustomwords](https://docs.audiostack.ai/reference/listcustomwords)

---

### Category: Predict

#### Predicts the resultant audio length of the given text content read by the supplied voice alias

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/predict`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/predict&api_token={api_token}
```


**Body Parameters**:

| `text` | string | Yes | Text that will be read |
| `voice` | string | Yes | Name of the voice |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/predict?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"value","voice":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postpredict](https://docs.audiostack.ai/reference/postpredict)

---

#### Lists all voices that can be predict resultant audio length

**Method**: `GET` | **LowCodeAPI Path**: `/speech/predict/voices`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/predict/voices&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/speech/predict/voices&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listpredictvoices](https://docs.audiostack.ai/reference/listpredictvoices)

---

### Category: Voice Cloning

#### Clones a voice from a list of files.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/voice-builder`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/voice-builder&api_token={api_token}
```


**Body Parameters**:

| `alias` | string | Yes | Alias for the cloned voice. You'll be able to use this alias when requesting TTS. Has to be globally unique. |
| `fileIds` | array of strings | Yes | List of fileIds to be used in cloning. |
| `metadata` | object of strings | No | Metadata for the cloned voice. It's recommended to include. |
| `voiceEngine` | string | Yes | Voice engine to be used in cloning. |
| `consentFileId` | string | No | FileId of the consent file, speaker stating they agree to have their voice cloned. Required for voice_engine_2. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/voice-builder?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alias":"value","fileIds":"value","metadata":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/voicebuilder](https://docs.audiostack.ai/reference/voicebuilder)

---

#### Lists all Voice Cloning jobs done within your organisation.

**Method**: `GET` | **LowCodeAPI Path**: `/speech/voice-builder`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/voice-builder&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/speech/voice-builder?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alias":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listvoicebuilder](https://docs.audiostack.ai/reference/listvoicebuilder)

---

### Category: Speech

#### Create a text-to-speech resource.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts&api_token={api_token}
```


**Body Parameters**:

| `speed` | number | No | Scalar for speed manipulation, range 0.5-3. |
| `voice` | string | No | Either alias or original (provider's) ID. Available voices are listed at https://library.audiostack.ai/ |
| `public` | boolean | No | Makes returned URLs publicly available |
| `audience` | object | No | Object defining the values for Script parameters. E.g. for Script parameters in: |
| `scriptId` | string | Yes | Reference to the Script that is to be synthesized, use /script to create and get it. |
| `sections` | object | No | Separate configurations for Script section. E.g. to specify a separate voice and speed for Script section intro the object would be. |
| `useAutofix` | boolean | No | Flag to apply autofix |
| `useDenoiser` | boolean | No | Flag to apply denoiser |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"speed":"value","voice":"value","public":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postspeech](https://docs.audiostack.ai/reference/postspeech)

---

#### Lists multiple text-to-speech resources.

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts?...&api_token={api_token}
```


**Query Parameters**:

| `verbose` | string | No |  |
| `scriptId` | string | No |  |
| `moduleName` | string | No |  |
| `scriptName` | string | No |  |
| `projectName` | string | No |  |
| `paginationToken` | string | No |  |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listtts](https://docs.audiostack.ai/reference/listtts)

---

#### Create a single section of a text-to-speech resource.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts/section`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/section&api_token={api_token}
```


**Body Parameters**:

| `speed` | number | No | Scalar for speed manipulation, range 0.5-3. |
| `voice` | string | No | Either alias or original (provider's) ID. Available voices are listed at https://library.audiostack.ai/ |
| `public` | boolean | No | Makes returned URLs publicly available |
| `audience` | object | No | Object defining the values for Script parameters. E.g. for Script parameters in: |
| `scriptId` | string | Yes | Reference to the Script that is to be synthesized, use /script to create and get it. |
| `sections` | object | No | Separate configurations for Script section. E.g. to specify a separate voice and speed for Script section intro the object would be |
| `silencePadding` | string | No | Amount of microseconds for silence padding. Half of the amount is inserted as silence at the beginning and at the end of each Speech file. |
| `sectionToProduce` | string | Yes | The name of the script section to produce |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/section?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"speed":"value","voice":"value","public":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postspeechsection](https://docs.audiostack.ai/reference/postspeechsection)

---

#### Create a fast preview of a given voice

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts/preview`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/preview&api_token={api_token}
```


**Body Parameters**:

| `text` | string | No | Text to synthesize. |
| `voice` | string | Yes | Either alias or original (provider's) ID. Available voices are listed at https://library.audiostack.ai/ |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/preview?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"value","voice":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postspeechpreview](https://docs.audiostack.ai/reference/postspeechpreview)

---

#### Retrieve a text-to-speech resource

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts/speechId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/speechId?speechId={speechId}&api_token={api_token}
```


**Path Parameters**:

| `speechId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/speechId?speechId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getspeechid](https://docs.audiostack.ai/reference/getspeechid)

---

#### Deletes a text-to-speech resource

**Method**: `DELETE` | **LowCodeAPI Path**: `/speech/tts/speechid`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/tts/speechid?speechId={speechId}&api_token={api_token}
```


**Path Parameters**:

| `speechId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostack/speech/tts/speechid?speechId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletespeechid](https://docs.audiostack.ai/reference/deletespeechid)

---

#### Reduce length of speech to fit in a target using silence removal and time stretching with pitch preservation.

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts/reduce`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/reduce&api_token={api_token}
```


**Body Parameters**:

| `speechId` | string | Yes | speech id to reduce. |
| `targetLength` | number | Yes | Target length for duration of speech |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/reduce?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"speechId":"value","targetLength":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postreduce](https://docs.audiostack.ai/reference/postreduce)

---

#### Remove silence of a file given the parameters below

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts/remove_padding`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/remove_padding&api_token={api_token}
```


**Body Parameters**:

| `position` | string | No | Where to remove silence 'end', 'start' or 'all' for all across the file. Default is 'end' |
| `speechId` | string | Yes | speech id to remove padding from. |
| `silenceThreshold` | number | No | Amplitude threshold in % below which audio will be considered silence. Default is 0.1 |
| `minSilenceDuration` | number | No | How long a silent region must be to be considered removable silence. Default is 0.01 |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/remove_padding?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"position":"value","speechId":"value","silenceThreshold":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postremovesilence](https://docs.audiostack.ai/reference/postremovesilence)

---

#### Returns time annotations for each word

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/tts/annotate`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/annotate&api_token={api_token}
```


**Body Parameters**:

| `speechId` | string | Yes | Speech ID for the speech file you want to annotate. |
| `languageCode` | string | No | languageCode (ISO 639-1 standard) of the speech file. If not provided, we try to detect the language. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/tts/annotate?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"speechId":"value","languageCode":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/annotate](https://docs.audiostack.ai/reference/annotate)

---

#### List available speech-to-speech compatible voices

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/speech/sts/voices`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/sts/voices&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/sts/voices&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getspeechtospeechvoices](https://docs.audiostack.ai/reference/getspeechtospeechvoices)

---

#### Submit a voice recording for speech-to-speech transformation into a different speaker

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/speech/sts`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/sts&api_token={api_token}
```


**Body Parameters**:

| `alias` | string | Yes | This is the voice you want the output to sound like. You can get a list of available voices from /speech/sts/voices and you can listen to samples in our voice library (https://platform.audiostack.ai/workflows/voice-library). |
| `fileId` | string | Yes | File ID of the voice recording you want to run through STS. |
| `newFilePath` | string | No | The path and name of the new file to be created in your Content area (https://platform.audiostack.ai/content). |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/speech/sts?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"alias":"value","fileId":"value","newFilePath":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postspeechtospeech](https://docs.audiostack.ai/reference/postspeechtospeech)

---

#### Get speech-to-speech generation pipeline status updates

**Method**: `GET` | **LowCodeAPI Path**: `/speech/sts/pipelineid`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/speech/sts/pipelineid?pipelineId={pipelineId}&api_token={api_token}
```


**Path Parameters**:

| `pipelineId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/speech/sts/pipelineid?pipelineId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getspeechtospeechpipeline](https://docs.audiostack.ai/reference/getspeechtospeechpipeline)

---

### Category: Sound Template

#### Create a sound template resource

**Method**: `POST` | **LowCodeAPI Path**: `/production/sound/template`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/sound/template&api_token={api_token}
```


**Body Parameters**:

| `isElastic` | boolean | No | Elastic templates are currently not available to self-serve customers |
| `description` | string | No | Description of the template |
| `templateName` | string | Yes | Name of the template |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/production/sound/template?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"isElastic":"value","description":"value","templateName":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/posttemplate](https://docs.audiostack.ai/reference/posttemplate)

---

#### Lists available sound templates

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/production/sound/template`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/template?...&api_token={api_token}
```


**Query Parameters**:

| `page` | number | No | Page number to be returned. |
| `moods` | string | No |  |
| `genres` | string | No |  |
| `pageLimit` | number | No | Max. amount of items to be returned per page. |
| `collections` | string | No |  |
| `instruments` | string | No |  |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/template?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/gettemplate](https://docs.audiostack.ai/reference/gettemplate)

---

#### Deletes a sound template

**Method**: `DELETE` | **LowCodeAPI Path**: `https://v2.api.audio/production/sound/template/name`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/template/name?name={name}&api_token={api_token}
```


**Path Parameters**:

| `name` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/template/name?name=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deletetemplate](https://docs.audiostack.ai/reference/deletetemplate)

---

#### Lists sound templates parameters

**Method**: `GET` | **LowCodeAPI Path**: `/production/sound/parameter`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/sound/parameter&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/production/sound/parameter&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/gettemplateparameters](https://docs.audiostack.ai/reference/gettemplateparameters)

---

#### Get a Sound Template recommendation for your content

**Method**: `POST` | **LowCodeAPI Path**: `/production/sound/select`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/sound/select&api_token={api_token}
```


**Body Parameters**:

| `mood` | string | No |  |
| `content` | string | Yes |  |
| `scriptId` | string | No |  |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/production/sound/select?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mood":"value","content":"value","scriptId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postselecttemplate](https://docs.audiostack.ai/reference/postselecttemplate)

---

### Category: Sound Atmospheres

#### Lists available sound atmospheres

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/production/sound/atmospheres`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/atmospheres&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/atmospheres&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getatmosphere](https://docs.audiostack.ai/reference/getatmosphere)

---

### Category: Sound Segment

#### Adds a sound segment to an existing sound template

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/sound/segment`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/segment&api_token={api_token}
```


**Body Parameters**:

| `mediaId` | string | Yes | Id of the media file to transfer into a sound segment |
| `segmentName` | string | Yes | Name of the segment |
| `templateName` | string | Yes | Name of the template |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/sound/segment?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mediaId":"value","segmentName":"value","templateName":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postsegment](https://docs.audiostack.ai/reference/postsegment)

---

### Category: Suite

#### Evaluate and enhance an audio file

**Method**: `POST` | **LowCodeAPI Path**: `/production/suite/enhance`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/suite/enhance&api_token={api_token}
```


**Body Parameters**:

| `text` | string | No | Text to compare the words read in the recording against. |
| `fileId` | string | Yes | fileId |
| `preset` | string | No | Preset for strictness of the evaluation, available presets are low, medium, strict |
| `language` | string | No | language code of choice, i.e. en-US |
| `scriptId` | string | No | ScriptId for the text to check the words read in the recording against. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/production/suite/enhance?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"value","fileId":"value","preset":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/enhanceaudio](https://docs.audiostack.ai/reference/enhanceaudio)

---

#### Denoise an audio file

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/denoise`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/denoise&api_token={api_token}
```


**Body Parameters**:

| `level` | number | No |  |
| `fileId` | string | Yes | fileId |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/denoise?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"level":"value","fileId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/denoiseaudio](https://docs.audiostack.ai/reference/denoiseaudio)

---

#### Speed up an audio file

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/speed-adjust`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/speed-adjust&api_token={api_token}
```


**Body Parameters**:

| `ratio` | number | No | The amount to speed up by whereby 1.0 is no affect |
| `fileId` | string | Yes | fileId |
| `maxLength` | number | No | The max length that the file can be in seconds. Note this overrides ratio. |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/speed-adjust?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"ratio":"value","fileId":"value","maxLength":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/speedadjustaudio](https://docs.audiostack.ai/reference/speedadjustaudio)

---

#### Trim an audio file

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/silence-trim`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/silence-trim&api_token={api_token}
```


**Body Parameters**:

| `fileId` | string | Yes | fileId |
| `trimType` | string | No | valid options are 'all', 'start' or 'end' |
| `silenceThreshold` | number | No | the threshold below which will be counted as silence. (default 0.01 = -36db) |
| `minSilenceDuration` | number | No | The minimum of silence to remove (default 0.1) |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/silence-trim?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fileId":"value","trimType":"value","silenceThreshold":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/silencetrimaudio](https://docs.audiostack.ai/reference/silencetrimaudio)

---

#### Separate an audio file

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/separate`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/separate&api_token={api_token}
```


**Body Parameters**:

| `fileId` | string | Yes | fileId |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/separate?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fileId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/separateaudio](https://docs.audiostack.ai/reference/separateaudio)

---

#### Transcribe an audio file

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/transcribe`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/transcribe&api_token={api_token}
```


**Body Parameters**:

| `fileId` | string | Yes | fileId |
| `language` | string | Yes | 2-letter language code for audio - e.g. en |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/transcribe?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fileId":"value","language":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/transcribeaudio](https://docs.audiostack.ai/reference/transcribeaudio)

---

#### Create a video

**Method**: `POST` | **LowCodeAPI Path**: `/production/suite/file_to_video`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/suite/file_to_video&api_token={api_token}
```


**Body Parameters**:

| `mode` | string | No | Including the key 'settings' of possible values low or high |
| `fileId` | string | Yes | fileId |
| `videoFileId` | string | No | Video file id |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/production/suite/file_to_video?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mode":"value","fileId":"value","videoFileId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/createvideo](https://docs.audiostack.ai/reference/createvideo)

---

#### Retrieve a pipeline resource

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/pipeline/pipelineId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/pipeline/pipelineId?pipelineId={pipelineId}&api_token={api_token}
```


**Path Parameters**:

| `pipelineId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/pipeline/pipelineId?pipelineId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getpipelineid](https://docs.audiostack.ai/reference/getpipelineid)

---

#### Retrieve a video pipeline resource

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/production/suite/videopipeline/pipelineId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/videopipeline/pipelineId?pipelineId={pipelineId}&api_token={api_token}
```


**Path Parameters**:

| `pipelineId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/suite/videopipeline/pipelineId?pipelineId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getvideopipelineid](https://docs.audiostack.ai/reference/getvideopipelineid)

---

### Category: Mixing 

#### Creates a mix of multiple audio resources

**Method**: `POST` | **LowCodeAPI Path**: `/production/mix`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/mix&api_token={api_token}
```


**Body Parameters**:

| `public` | boolean | No | Makes returned URLs publicly available |
| `fxFiles` | object | No | List of fx files to be mixed with other audio resources |
| `speechId` | string | Yes | Reference to the speechId that is to be mixed with other audio resources |
| `mediaFiles` | object | No | List of media files to be mixed with other audio resources |
| `soundLayer` | string | No | (Beta) Which layer of the sound template should be used |
| `soundTemplate` | string | No | Name of the sound template to be mixed with other audio resources |
| `masteringPreset` | string | No | Mastering preset to use, for example heavyDucking. |
| `strictValidation` | boolean | No | To bypass timeline protection set this to false. Results may vary and sound files might overlap |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/production/mix?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"public":"value","fxFiles":"value","speechId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postmix](https://docs.audiostack.ai/reference/postmix)

---

#### Validates that the requested mastering request is valid

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/production/validate`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/validate&api_token={api_token}
```


**Body Parameters**:

| `public` | boolean | No | Makes returned URLs publicly available |
| `fxFiles` | object | No | List of fx files to be mixed with other audio resources |
| `speechId` | string | Yes | Reference to the speechId that is to be mixed with other audio resources |
| `mediaFiles` | object | No | List of media files to be mixed with other audio resources |
| `soundLayer` | string | No | (Beta) Which layer of the sound template should be used |
| `soundTemplate` | string | No | Name of the sound template to be mixed with other audio resources |
| `masteringPreset` | string | No | Mastering preset to use, for example heavyDucking. |
| `strictValidation` | boolean | No | To bypass timeline protection set this to false. Results may vary and sound files might overlap |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/validate?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"public":"value","fxFiles":"value","speechId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/validatemix](https://docs.audiostack.ai/reference/validatemix)

---

#### Lists multiple mixed resources

**Method**: `GET` | **LowCodeAPI Path**: `/production/mixes`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/mixes?...&api_token={api_token}
```


**Query Parameters**:

| `verbose` | boolean | No |  |
| `scriptId` | string | No |  |
| `moduleName` | string | No |  |
| `scriptName` | string | No |  |
| `projectName` | string | No |  |
| `paginationToken` | string | No |  |


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/production/mixes?...&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listmixes](https://docs.audiostack.ai/reference/listmixes)

---

#### Retrieve a mixed resource

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/production/mix/productionId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/mix/productionId?productionId={productionId}&api_token={api_token}
```


**Path Parameters**:

| `productionId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/production/mix/productionId?productionId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getproductionid](https://docs.audiostack.ai/reference/getproductionid)

---

#### Deletes a mixed resource

**Method**: `DELETE` | **LowCodeAPI Path**: `/production/mix/productionid`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/mix/productionid?productionId={productionId}&api_token={api_token}
```


**Path Parameters**:

| `productionId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/audiostack/production/mix/productionid?productionId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/deleteproductionid](https://docs.audiostack.ai/reference/deleteproductionid)

---

#### Lists available mastering presets

**Method**: `GET` | **LowCodeAPI Path**: `/production/mix/presets`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/production/mix/presets&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/production/mix/presets&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listmasteringpresets](https://docs.audiostack.ai/reference/listmasteringpresets)

---

### Category: Encoder

#### Changes the audio encoding of a mixed audio file

**Method**: `POST` | **LowCodeAPI Path**: `/delivery/encoder`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/delivery/encoder&api_token={api_token}
```


**Body Parameters**:

| `format` | string | No | Can be wav, mp3, flac or ogg |
| `preset` | string | No | named preset to use or 'custom'. Available presets can be listed using '/delivery/encoder/presets' |
| `public` | boolean | No | Make the output a publicly available URL |
| `bitRate` | string | No | Can be between 0-9 for variable bit rates, or between 32 and 320 for constant bit rates |
| `bitDepth` | number | No | Can be 16, 24, or 32 |
| `channels` | number | No | Supply 1 for mono or 2 for stereo |
| `sampleRate` | number | No | Sample rate, should be between 24000 and 96000 |
| `bitRateType` | string | No | Supplied value must be either 'constant' or 'variable |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/delivery/encoder?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"format":"value","preset":"value","public":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postencoder](https://docs.audiostack.ai/reference/postencoder)

---

#### Lists available encoder presets and loudness presets

**Method**: `GET` | **LowCodeAPI Path**: `/delivery/encoder/presets`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/delivery/encoder/presets&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/delivery/encoder/presets&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listencoderpresets](https://docs.audiostack.ai/reference/listencoderpresets)

---

### Category: Video

#### Create video

**Method**: `POST` | **LowCodeAPI Path**: `https://v2.api.audio/delivery/video`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/delivery/video&api_token={api_token}
```


**Body Parameters**:

| `public` | boolean | No | Make the output a publicly available URL |
| `productionId` | string | Yes | Reference to the productionId that is to be encoded |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/delivery/video?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"public":"value","productionId":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postvideo](https://docs.audiostack.ai/reference/postvideo)

---

### Category: Julep

#### Sends a produced file to Julep connector

**Method**: `POST` | **LowCodeAPI Path**: `/delivery/connectors/julep`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/delivery/connectors/julep&api_token={api_token}
```


**Body Parameters**:

| `notes` | string | No | notes for the podcast |
| `title` | string | Yes | Title of podcast |
| `subtitle` | string | No | Subtitle for podcast |
| `permalink` | string | Yes | permalink for podcast |
| `podcastId` | string | Yes | Id of the podcast |
| `description` | string | No | podcast description |
| `publishedAt` | string | No | Changes the date of publication. publishedAt parameter should be in YYYY-MM-DD HH:MM:SS format. |
| `productionId` | string | Yes | Reference to the productionId that is to be delivered to the connector |


**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/audiostack/delivery/connectors/julep?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"notes":"value","title":"value","subtitle":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/postjulep](https://docs.audiostack.ai/reference/postjulep)

---

#### Authenticates with Julep

**Method**: `PUT` | **LowCodeAPI Path**: `/delivery/connectors/authenticate-julep`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/delivery/connectors/authenticate-julep&api_token={api_token}
```


**Body Parameters**:

| `password` | string | Yes | Julep password |
| `username` | string | Yes | Julep username |


**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/audiostack/delivery/connectors/authenticate-julep?&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"password":"value","username":"value"}'
```

**Official Documentation**: [https://docs.audiostack.ai/reference/putjulepcredentials](https://docs.audiostack.ai/reference/putjulepcredentials)

---

### Category: Connector

#### Lists all connected deliveries

**Method**: `GET` | **LowCodeAPI Path**: `/delivery/connectors/status`

**Full URL**:
```
https://api.lowcodeapi.com/audiostack/delivery/connectors/status&api_token={api_token}
```


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostack/delivery/connectors/status&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/listconnectordeliveries](https://docs.audiostack.ai/reference/listconnectordeliveries)

---

#### Get a single delivery

**Method**: `GET` | **LowCodeAPI Path**: `https://v2.api.audio/delivery/connectors/status/deliveryId`

**Full URL**:
```
https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/delivery/connectors/status/deliveryId?deliveryId={deliveryId}&api_token={api_token}
```


**Path Parameters**:

| `deliveryId` | string |  |

**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.


**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/audiostackhttps://v2.api.audio/delivery/connectors/status/deliveryId?deliveryId=VALUE&&api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
```

**Official Documentation**: [https://docs.audiostack.ai/reference/getconnectordelivery](https://docs.audiostack.ai/reference/getconnectordelivery)

---

## Usage Examples

### Example 1: Basic Usage

Get started with AudioStack API by making your first request.

```bash
# Your example code here
# This demonstrates basic usage
curl -X GET "https://api.lowcodeapi.com/audiostack/?api_token=YOUR_API_TOKEN"
```

### Example 2: Advanced Usage

Explore more advanced features and parameters.

```bash
# Your example code here
# This demonstrates advanced usage
curl -X GET "https://api.lowcodeapi.com/audiostack/?api_token=YOUR_API_TOKEN"
```

## Complete Endpoint Reference

For a complete list of all endpoints and their parameters, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/audiostack/definition`
- **Official Provider Documentation**: [https://docs.audiostack.ai/reference/quick-start](https://docs.audiostack.ai/reference/quick-start)

## Rate Limits & Best Practices

- Check your AudioStack account for specific rate limits
- Use appropriate error handling and retry logic
- Cache responses when appropriate to reduce API calls

## Error Handling

Standard HTTP status codes apply:
- `400` - Invalid request parameters
- `401` - Unauthorized (check your API key)
- `429` - Rate limit exceeded
- `500` - Internal server error