# BeyondWords Integration via LowCodeAPI
## Overview
Audio content platform for converting text to natural-sounding speech and managing audio content
## Base Endpoint
```
https://api.lowcodeapi.com/beyondwords/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [https://beyondwords.io/](https://beyondwords.io/)
2. **Get your credentials** from [https://dash.beyondwords.io/dashboard](https://dash.beyondwords.io/dashboard)
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 BeyondWords credentials
- Apply them to each request
**Auth Type**:
## API Categories
- Text to Audio AI
## Common Endpoints
### Category: Ads
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/ads`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/ads?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/advertsindex](https://developers.beyondwords.io/reference/advertsindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/ads`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `type` | enum | No | The type of ad. Either custom or vast. Ads of type custom must have title, url and media fields. Ads of type vast must have title and vast_url fields. |
| `placement` | enum | No | Whether the ad should play before/during/after the audio content. Possible values are pre-roll, mid-roll, or post-roll |
| `title` | string | No | The title of the ad |
| `click_through_url` | string | No | The click-through URL of the custom ad to show in the player |
| `image_url` | string | No | The image URL to show in the player while the ad is playing |
| `media_url` | string | No | The URL of the media file of the custom ad to play in the player |
| `vast_url` | string | No | The VAST URL for VAST ads |
| `theme` | enum | No | The color theme to use for the ad when it is playing. Possible values are auto, dark, light. The auto theme is based on the user's light/dark mode system preference. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"type":"value","placement":"value","title":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/adscreate](https://developers.beyondwords.io/reference/adscreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/ads/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your ad |
**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**:
| `placement` | enum | No | Whether the ad should play before/during/after the audio content. Possible values are pre-roll, mid-roll, or post-roll |
| `title` | string | No | The title of the ad |
| `click_through_url` | string | No | The click-through URL of the custom ad to show in the player |
| `image_url` | string | No | The image URL to show in the player while the ad is playing |
| `media_url` | string | No | The URL of the media file of the custom ad to play in the player |
| `theme` | enum | No | The color theme to use for the ad when it is playing. Possible values are auto, dark, light. The auto theme is based on the user's light/dark mode system preference. |
| `dark_theme` | object | No | The dark theme colors |
| `light_theme` | object | No | The light theme colors |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"placement":"value","title":"value","click_through_url":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/adsupdate](https://developers.beyondwords.io/reference/adsupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/ads/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your ad |
**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/beyondwords/v1/projects/project_id/ads/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/adsshow](https://developers.beyondwords.io/reference/adsshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/project_id/ads/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your ad |
**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/beyondwords/v1/projects/project_id/ads/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/adsdelete](https://developers.beyondwords.io/reference/adsdelete)
---
### Category: Analytics
#### Organization analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/organization/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/organization/analytics?...&api_token={api_token}
```
**Query Parameters**:
| `aggregation` | enum | No | The way to aggregate the analytics. Possible values are all (aggregate all data together), year (aggregate data on a yearly basis), month (aggregate data on a yearly basis), week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour (aggregate data on an hourly basis, limited to a time_range 7 days or less). |
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `metrics[]` | array | No | The metrics that you want to fetch data for |
| `media_variants[]` | array | No | The media variants to fetch data for |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/organization/analytics?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/organizationanalytics](https://developers.beyondwords.io/reference/organizationanalytics)
---
#### Projects analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/analytics?...&api_token={api_token}
```
**Query Parameters**:
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `order[by]` | enum | No | This is used to order analytics by number of listens or average listen time or average listen duration |
| `order[dir]` | enum | No | This is used to order analytics in the ascending or descending order |
| `filter[title]` | string | No | Get analytics for content whose title contains the specified string. Note: filter[title] does not work in combination with order[by] |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/projects/analytics?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectanalytics_list](https://developers.beyondwords.io/reference/projectanalytics_list)
---
#### Project analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/id/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/id/analytics?id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `aggregation` | enum | No | The way to aggregate the analytics. Possible values are all (aggregate all data together), year (aggregate data on a yearly basis), month (aggregate data on a yearly basis), week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour (aggregate data on an hourly basis, limited to a time_range 7 days or less). |
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `metrics[]` | array | No | The metrics that you want to fetch data for |
| `media_variants[]` | array | No | The media variants to fetch data for |
**Path Parameters**:
| `id` | string | project 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/beyondwords/v1/projects/id/analytics?id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectanalytics](https://developers.beyondwords.io/reference/projectanalytics)
---
#### Contents analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/content/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/analytics?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `order[by]` | enum | No | This is used to order analytics by number of listens or average listen time or average listen duration |
| `order[dir]` | enum | No | This is used to order analytics in the ascending or descending order |
| `filter[title]` | string | No | Get analytics for content whose title contains the specified string. Note: filter[title] does not work in combination with order[by] |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/content/analytics?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentanalytics_list](https://developers.beyondwords.io/reference/contentanalytics_list)
---
#### Content analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/content/id/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id/analytics?project_id={project_id}&id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `aggregation` | enum | No | The way to aggregate the analytics. Possible values are all (aggregate all data together), year (aggregate data on a yearly basis), month (aggregate data on a yearly basis), week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour (aggregate data on an hourly basis, limited to a time_range 7 days or less). |
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `metrics[]` | array | No | The metrics that you want to fetch data for |
| `media_variants[]` | array | No | The media variants to fetch data for |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The UUID of the content item (or a legacy numeric 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/beyondwords/v1/projects/project_id/content/id/analytics?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentanalytics](https://developers.beyondwords.io/reference/contentanalytics)
---
#### Ads analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/ads/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/analytics?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `order[by]` | enum | No | This is used to order analytics by number of listens or average listen time or average listen duration |
| `order[dir]` | enum | No | This is used to order analytics in the ascending or descending order |
| `filter[title]` | string | No | Get analytics for content whose title contains the specified string. Note: filter[title] does not work in combination with order[by] |
| `filter[ids][]` | array | No | filter ids |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/ads/analytics?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/adsanalytics_list](https://developers.beyondwords.io/reference/adsanalytics_list)
---
#### Ad analytics
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/ads/id/analytics`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/ads/id/analytics?project_id={project_id}&id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `time_range[start]` | string | No | The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `time_range[end]` | string | No | The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. |
| `metrics[]` | array | No | The metrics that you want to fetch data for |
| `media_variants[]` | array | No | The media variants to fetch data for |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The ID of the ads campaign |
**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/beyondwords/v1/projects/project_id/ads/id/analytics?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/adsanalytics](https://developers.beyondwords.io/reference/adsanalytics)
---
### Category: Background tracks
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/background_tracks`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/background_tracks?...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `filter[scopes]` | object | No | filter items by scopes |
| `filter[custom]` | boolean | No | The media variants to fetch data for |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/background_tracks?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/background_tracksindex](https://developers.beyondwords.io/reference/background_tracksindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/background_tracks`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/background_tracks&api_token={api_token}
```
**Body Parameters**:
| `name` | string | No | Name of the background track |
| `volume` | number | No | Volume of the background track |
| `project` | object | No | Background track project |
| `media` | object | No | Background track media |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/background_tracks?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","volume":"value","project":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/background_trackscreate](https://developers.beyondwords.io/reference/background_trackscreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/background_tracks/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/background_tracks/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your background track |
**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**:
| `name` | string | No | Name of the background track |
| `volume` | number | No | Volume of the background track |
| `project` | object | No | Background track project |
| `media` | object | No | Background track media |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/background_tracks/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","volume":"value","project":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/background_tracksupdate](https://developers.beyondwords.io/reference/background_tracksupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/background_tracks/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/background_tracks/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your background track |
**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/beyondwords/v1/background_tracks/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/background_tracksshow](https://developers.beyondwords.io/reference/background_tracksshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/background_tracks/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/background_tracks/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your background track |
**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/beyondwords/v1/background_tracks/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/background_tracksdelete](https://developers.beyondwords.io/reference/background_tracksdelete)
---
### Category: Content
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/content`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `filter[title]` | string | No | filter by content title |
| `filter[published]` | string | No | filter by content published status |
| `filter[statuses][]` | array | No | filter by content statuses |
| `filter[created][from]` | date | No | filter by created time from (ISO 8601) |
| `filter[created][to]` | date | No | filter by created time to (ISO 8601) |
| `filter[updated][from]` | date | No | filter by updated time from (ISO 8601) |
| `filter[updated][to]` | date | No | filter by updated time to (ISO 8601) |
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/content?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentindex](https://developers.beyondwords.io/reference/contentindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/content`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `segments` | enum | No | The level of detail to show for segments in the response: 'none', 'partial' or 'full' |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `type` | enum | No | The type of content. Possible values are auto_segment, manual_segment, or audio_upload |
| `title` | string | No | The title of the content |
| `summary` | string | No | The summary of the content |
| `body` | string | No | The body text of the content |
| `title_enabled` | boolean | No | Whether the title is enabled |
| `body_enabled` | boolean | No | Whether the body is enabled |
| `summary_enabled` | boolean | No | Whether the summary is enabled |
| `summary_title_enabled` | boolean | No | Whether the summary title is enabled |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"type":"value","title":"value","summary":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentcreate](https://developers.beyondwords.io/reference/contentcreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/content/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id?project_id={project_id}&id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `segments` | string | No | The level of detail to show for segments in the response: 'none', 'partial' or 'full' |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The UUID of the content item (or a legacy numeric 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.
**Body Parameters**:
| `title` | string | No | The title of the content |
| `summary` | string | No | The summary of the content |
| `body` | string | No | The body text of the content |
| `title_enabled` | boolean | No | Whether the title is enabled |
| `body_enabled` | boolean | No | Whether the body is enabled |
| `summary_enabled` | boolean | No | Whether the summary is enabled |
| `summary_title_enabled` | boolean | No | Whether the summary title is enabled |
| `source_id` | string | No | The source ID of the content |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"value","summary":"value","body":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentupdate](https://developers.beyondwords.io/reference/contentupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/content/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id?project_id={project_id}&id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `segments` | string | No | The level of detail to show for segments in the response: 'none', 'partial' or 'full' |
| `words` | string | No | The level of detail to show for segment words in the response: 'none', 'partial' or 'full' |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The UUID of the content item (or a legacy numeric 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/beyondwords/v1/projects/project_id/content/id?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentshow](https://developers.beyondwords.io/reference/contentshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/project_id/content/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The UUID of the content item (or a legacy numeric 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 DELETE "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentdelete](https://developers.beyondwords.io/reference/contentdelete)
---
#### Regenerate
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/content/id/regenerate`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id/regenerate?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | project_id |
| `id` | string | 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 POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id/regenerate?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentregenerate](https://developers.beyondwords.io/reference/contentregenerate)
---
#### Search fields
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/content/search_fields`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/search_fields?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | project_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/beyondwords/v1/projects/project_id/content/search_fields?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentsearch_fields](https://developers.beyondwords.io/reference/contentsearch_fields)
---
#### Summarize
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/content/id/summarize`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id/summarize?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | project_id |
| `id` | string | 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.
**Body Parameters**:
| `model` | string | No | The model of AI. Possible values are chat_gpt |
| `prompt` | string | No | The AI prompt |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/content/id/summarize?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"model":"value","prompt":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/contentsummarize](https://developers.beyondwords.io/reference/contentsummarize)
---
### Category: Html filters
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/html_filters`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/html_filters?...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `filter[project.id]` | string | No | filter by project ID |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/html_filters?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/html_filtersindex](https://developers.beyondwords.io/reference/html_filtersindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/html_filters`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/html_filters&api_token={api_token}
```
**Body Parameters**:
| `element_type` | string | No | The name of the tag representing the element |
| `element_class` | string | No | The class attribute of an element. This filter will be applied to any element that contains the class |
| `element_data` | string | No | The data attribute of an element |
| `element_xpath` | string | No | The XPath specifying the elements. https://www.w3.org/TR/1999/REC-xpath-19991116/ |
| `element_id` | string | No | The class attribute of an element |
| `value` | string | No | The string value contained within an element. This filter will be applied to any element that contains the value |
| `include` | boolean | No | Whether BeyondWords should use the filter to include or exclude the selected part of the HTML document. The default is false |
| `project` | object | No | The project id to apply this filter to |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/html_filters?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"element_type":"value","element_class":"value","element_data":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/html_filterscreate](https://developers.beyondwords.io/reference/html_filterscreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/html_filters/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/html_filters/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your filter |
**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**:
| `element_type` | string | No | The name of the tag representing the element |
| `element_class` | string | No | The class attribute of an element. This filter will be applied to any element that contains the class |
| `element_data` | string | No | The data attribute of an element |
| `element_xpath` | string | No | The XPath specifying the elements. https://www.w3.org/TR/1999/REC-xpath-19991116/ |
| `element_id` | string | No | The class attribute of an element |
| `value` | string | No | The string value contained within an element. This filter will be applied to any element that contains the value |
| `include` | boolean | No | Whether BeyondWords should use the filter to include or exclude the selected part of the HTML document. The default is false |
| `project` | object | No | The project id to apply this filter to |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/html_filters/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"element_type":"value","element_class":"value","element_data":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/html_filtersupdate](https://developers.beyondwords.io/reference/html_filtersupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/html_filters/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/html_filters/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your filter |
**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/beyondwords/v1/html_filters/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/html_filtersshow](https://developers.beyondwords.io/reference/html_filtersshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/html_filters/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/html_filters/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your filter |
**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/beyondwords/v1/html_filters/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/html_filtersdelete](https://developers.beyondwords.io/reference/html_filtersdelete)
---
### Category: Languages
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/organization/languages`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/organization/languages&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/organization/languages&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/organizationlanguagesindex](https://developers.beyondwords.io/reference/organizationlanguagesindex)
---
### Category: Player
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/player/by_content_id/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player/by_content_id/id?project_id={project_id}&id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `preview_token` | string | No | The preview token of your content item |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The UUID of your content item (or a legacy numeric 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/beyondwords/v1/projects/project_id/player/by_content_id/id?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playerby_content_id](https://developers.beyondwords.io/reference/playerby_content_id)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/player/by_playlist_id/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player/by_playlist_id/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your playlist |
**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/beyondwords/v1/projects/project_id/player/by_playlist_id/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playerby_playlist_id](https://developers.beyondwords.io/reference/playerby_playlist_id)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/player/by_source_id/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player/by_source_id/id?project_id={project_id}&id={id}&...&api_token={api_token}
```
**Query Parameters**:
| `preview_token` | string | No | The preview token of your content item |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The source_id of your content item |
**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/beyondwords/v1/projects/project_id/player/by_source_id/id?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playerby_source_id](https://developers.beyondwords.io/reference/playerby_source_id)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/player/by_source_url/url`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player/by_source_url/url?project_id={project_id}&url={url}&...&api_token={api_token}
```
**Query Parameters**:
| `preview_token` | string | No | The preview token of your content item |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `url` | string | The source_url of your content item |
**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/beyondwords/v1/projects/project_id/player/by_source_url/url?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playerby_source_url](https://developers.beyondwords.io/reference/playerby_source_url)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/player/by_identifiers/array`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player/by_identifiers/array?array={array}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `array` | string | An encoded JSON array containing mixed identifiers |
| `id` | string | The source_url of your content item |
**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/beyondwords/v1/projects/project_id/player/by_identifiers/array?array=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playerby_identifiers](https://developers.beyondwords.io/reference/playerby_identifiers)
---
### Category: Player settings
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/player_settings`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player_settings?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/player_settings?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/player_settingsshow](https://developers.beyondwords.io/reference/player_settingsshow)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/player_settings`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player_settings?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `player_version` | enum | No | The player version to use. Possible values are 0 for legacy and 1 for the current |
| `player_style` | enum | No | The style of user interface to show for the player. Possible values are small, standard, large, or video |
| `player_title` | string | No | The title to show in the large player when there isn't a playlist |
| `call_to_action` | string | No | The text prompt to show on the player |
| `image_url` | string | No | An image to show in the player instead of the content's image |
| `persistent_ad_image` | boolean | No | Whether to show clickable ad images in the player when the ad isn't playing |
| `theme` | enum | No | The color theme to use for the player. The color theme to use for the player. Possible values are auto, dark, or light |
| `dark_theme` | object | No | The dark theme colors |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/player_settings?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"player_version":"value","player_style":"value","player_title":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/player_settingsupdate](https://developers.beyondwords.io/reference/player_settingsupdate)
---
### Category: Playlists
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/playlists`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/playlists?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playlistsindex](https://developers.beyondwords.io/reference/playlistsindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/playlists`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `name` | string | Yes | The name of the playlist |
| `content_ids` | array | No | Array of content item IDs to include in the playlist |
| `description` | string | No | The description of the playlist |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","content_ids":"value","description":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playlistscreate](https://developers.beyondwords.io/reference/playlistscreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/playlists/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your playlist |
**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**:
| `name` | string | No | The name of the playlist |
| `content_ids` | array | No | Array of content item IDs to include in the playlist |
| `description` | string | No | The description of the playlist |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","content_ids":"value","description":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playlistsupdate](https://developers.beyondwords.io/reference/playlistsupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/playlists/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your playlist |
**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/beyondwords/v1/projects/project_id/playlists/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playlistsshow](https://developers.beyondwords.io/reference/playlistsshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/project_id/playlists/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/playlists/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | The numeric ID of your playlist |
**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/beyondwords/v1/projects/project_id/playlists/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/playlistsdelete](https://developers.beyondwords.io/reference/playlistsdelete)
---
### Category: Projects
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects?...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/projects?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectsindex](https://developers.beyondwords.io/reference/projectsindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects&api_token={api_token}
```
**Body Parameters**:
| `name` | string | Yes | The name of the project |
| `language` | object | No | Language configuration |
| `title` | object | No | Title voice configuration |
| `summary` | object | No | Summary voice configuration |
| `body` | object | No | Body voice configuration |
| `background_track` | object | No | Background track configuration |
| `auto_publish_enabled` | boolean | No | Whether auto publish is enabled |
| `time_zone` | string | No | The project time zone |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","language":"value","title":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectscreate](https://developers.beyondwords.io/reference/projectscreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | project 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.
**Body Parameters**:
| `name` | string | No | The name of the project |
| `language` | object | No | Language configuration |
| `title` | object | No | Title voice configuration |
| `summary` | object | No | Summary voice configuration |
| `body` | object | No | Body voice configuration |
| `background_track` | object | No | Background track configuration |
| `auto_publish_enabled` | boolean | No | Whether auto publish is enabled |
| `time_zone` | string | No | The project time zone |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","language":"value","title":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectsupdate](https://developers.beyondwords.io/reference/projectsupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | project 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/beyondwords/v1/projects/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectsshow](https://developers.beyondwords.io/reference/projectsshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | project 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 DELETE "https://api.lowcodeapi.com/beyondwords/v1/projects/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectsdelete](https://developers.beyondwords.io/reference/projectsdelete)
---
### Category: RSS Feed
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/integrations/rss_importer/feeds`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rss_importerfeedindex](https://developers.beyondwords.io/reference/rss_importerfeedindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/integrations/rss_importer/feeds`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `enabled` | boolean | No | Whether importing is enabled or disabled. |
| `feed_url` | string | Yes | URL of the RSS feed you want to import. |
| `feed_content_type` | enum | Yes | Type of content in the feed. Possible values include xml or json. |
| `feed_headers` | object | No | Headers that you want to include in the HTTP request when fetching the RSS feed. |
| `import_interval` | number | No | Number of minutes between each import of the RSS feed. |
| `extractor_enabled` | boolean | No | Whether or not the RSS importer should fetch the content from the page linked in the map.source_url property. Set to true if the RSS feed does not contain the content. In this case you can set map.body to null. |
| `extractor_headers` | object | No | Headers that you want to include in the HTTP request when fetching and extracting the content from the map.source_url. |
| `map` | object | No | Object that contains mappings between the data in the RSS feed and the properties in the content object. Each property in the map object represents a property in the content object, and its value is a string that represents the name of the corresponding element in the RSS feed. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"enabled":"value","feed_url":"value","feed_content_type":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rss_importerfeedcreate](https://developers.beyondwords.io/reference/rss_importerfeedcreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/integrations/rss_importer/feeds/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | RSS feed 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.
**Body Parameters**:
| `enabled` | boolean | No | Whether importing is enabled or disabled. |
| `feed_url` | string | Yes | URL of the RSS feed you want to import. |
| `feed_content_type` | enum | Yes | Type of content in the feed. Possible values include xml or json. |
| `feed_headers` | object | No | Headers that you want to include in the HTTP request when fetching the RSS feed. |
| `import_interval` | number | No | Number of minutes between each import of the RSS feed. |
| `extractor_enabled` | boolean | No | Whether or not the RSS importer should fetch the content from the page linked in the map.source_url property. Set to true if the RSS feed does not contain the content. In this case you can set map.body to null. |
| `extractor_headers` | object | No | Headers that you want to include in the HTTP request when fetching and extracting the content from the map.source_url. |
| `map` | object | No | Object that contains mappings between the data in the RSS feed and the properties in the content object. Each property in the map object represents a property in the content object, and its value is a string that represents the name of the corresponding element in the RSS feed. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"enabled":"value","feed_url":"value","feed_content_type":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rss_importerfeedupdate](https://developers.beyondwords.io/reference/rss_importerfeedupdate)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/project_id/integrations/rss_importer/feeds/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | RSS feed 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 DELETE "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rss_importerfeeddelete](https://developers.beyondwords.io/reference/rss_importerfeeddelete)
---
#### Run
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/integrations/rss_importer/feeds/id/run`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/id/run?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | RSS feed 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 POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/id/run?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rss_importerfeedrun](https://developers.beyondwords.io/reference/rss_importerfeedrun)
---
#### Test
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/integrations/rss_importer/feeds/test`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/test?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `enabled` | boolean | No | Whether importing is enabled or disabled. |
| `feed_url` | string | Yes | URL of the RSS feed you want to import. |
| `feed_content_type` | enum | Yes | Type of content in the feed. Possible values include xml or json. |
| `feed_headers` | object | No | Headers that you want to include in the HTTP request when fetching the RSS feed. |
| `import_interval` | number | No | Number of minutes between each import of the RSS feed. |
| `extractor_enabled` | boolean | No | Whether or not the RSS importer should fetch the content from the page linked in the map.source_url property. Set to true if the RSS feed does not contain the content. In this case you can set map.body to null. |
| `extractor_headers` | object | No | Headers that you want to include in the HTTP request when fetching and extracting the content from the map.source_url. |
| `map` | object | No | Object that contains mappings between the data in the RSS feed and the properties in the content object. Each property in the map object represents a property in the content object, and its value is a string that represents the name of the corresponding element in the RSS feed. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/integrations/rss_importer/feeds/test?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"enabled":"value","feed_url":"value","feed_content_type":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rss_importerfeedtest](https://developers.beyondwords.io/reference/rss_importerfeedtest)
---
### Category: Rules
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/rules`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules?...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `order[by]` | enum | No | This is used to order rules by type or key or value |
| `order[dir]` | enum | No | This is used to order analytics in the ascending or descending order |
| `filter[type]` | string | No | filter by rule type |
| `filter[preview_status]` | string | No | filter by rule preview status |
| `filter[key]` | string | No | filter by rule key |
| `filter[scopes]` | object | No | filter items by scopes |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/rules?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulesindex](https://developers.beyondwords.io/reference/rulesindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/rules`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules&api_token={api_token}
```
**Body Parameters**:
| `type` | enum | No | The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, x_sampa_transcription, pinyin_transcription, jyutping_transcription. Please note that not all voices support all rules |
| `key` | string | No | The text you want the rule to be applied to |
| `value` | string | No | |
| `project` | object | No | PROJECT OBJECT |
| `content` | object | No | Content Object |
| `language` | object | No | Language Object |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/rules?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"type":"value","key":"value","value":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulescreate](https://developers.beyondwords.io/reference/rulescreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/rules/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your rule |
**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**:
| `type` | enum | No | The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, x_sampa_transcription, pinyin_transcription, jyutping_transcription. Please note that not all voices support all rules |
| `key` | string | No | The text you want the rule to be applied to |
| `value` | string | No | |
| `project` | object | No | PROJECT OBJECT |
| `content` | object | No | Content Object |
| `language` | object | No | Language Object |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/rules/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"type":"value","key":"value","value":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulesupdate](https://developers.beyondwords.io/reference/rulesupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/rules/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your rule |
**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/beyondwords/v1/rules/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulesshow](https://developers.beyondwords.io/reference/rulesshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/rules/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your rule |
**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/beyondwords/v1/rules/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulesdelete](https://developers.beyondwords.io/reference/rulesdelete)
---
#### Regenerate preview
**Method**: `POST` | **LowCodeAPI Path**: `/v1/rules/id/regenerate_preview`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules/id/regenerate_preview?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your rule |
**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 POST "https://api.lowcodeapi.com/beyondwords/v1/rules/id/regenerate_preview?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulesregenerate_preview](https://developers.beyondwords.io/reference/rulesregenerate_preview)
---
#### Preview
**Method**: `POST` | **LowCodeAPI Path**: `/v1/rules/preview`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules/preview&api_token={api_token}
```
**Body Parameters**:
| `type` | enum | No | The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, x_sampa_transcription, pinyin_transcription, jyutping_transcription. Please note that not all voices support all rules |
| `key` | string | No | The text you want the rule to be applied to |
| `value` | string | No | |
| `project` | object | No | PROJECT OBJECT |
| `content` | object | No | Content Object |
| `language` | object | No | Language Object |
| `preview_voice` | object | No | preview_voice Object |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/rules/preview?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"type":"value","key":"value","value":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulespreview](https://developers.beyondwords.io/reference/rulespreview)
---
#### Phonemes
**Method**: `GET` | **LowCodeAPI Path**: `/v1/rules/phonemes`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/rules/phonemes&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/rules/phonemes&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/rulesphonemes](https://developers.beyondwords.io/reference/rulesphonemes)
---
### Category: Summarization settings
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/summarization_settings`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/summarization_settings?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/summarization_settings?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/summarization_settingsshow](https://developers.beyondwords.io/reference/summarization_settingsshow)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/summarization_settings`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/summarization_settings?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `enabled` | boolean | No | Whether AI summaries should be generated for the project. |
| `prompt` | string | No | The prompt that will be used to generate AI summaries. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/summarization_settings?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"enabled":"value","prompt":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/summarization_settingsupdate](https://developers.beyondwords.io/reference/summarization_settingsupdate)
---
### Category: Upload
#### Upload
**Method**: `POST` | **LowCodeAPI Path**: `/v1/upload`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/upload&api_token={api_token}
```
**Body Parameters**:
| `file` | file | Yes | Binary file (limit 50 MB) |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/upload?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"file":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/uploadcreate](https://developers.beyondwords.io/reference/uploadcreate)
---
### Category: Video Settings
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/video_settings`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/video_settings?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/video_settings?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/video_settingsshow](https://developers.beyondwords.io/reference/video_settingsshow)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/video_settings`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/video_settings?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `enabled` | boolean | No | Whether text-to-speech videos should be generated for the project. |
| `logo_image_url` | string | No | The logo that should appear in the corner of the video. Defaults to the BeyondWords logo. |
| `logo_image_position` | enum | No | The position of the logo that appears in the corner of the video. |
| `background_color` | string | No | The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...) |
| `text_background_color` | string | No | The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...) |
| `text_color` | string | No | The foreground color of text. Supports CSS colors including linear-gradient(to right, ...) |
| `text_highlight_color` | string | No | The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...) |
| `waveform_color` | string | No | The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...) |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/video_settings?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"enabled":"value","logo_image_url":"value","logo_image_position":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/video_settingsupdate](https://developers.beyondwords.io/reference/video_settingsupdate)
---
### Category: Voice issues
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/voice_issues`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/voice_issues?...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
| `order[by]` | enum | No | This is used to order voice issues by created time |
| `order[dir]` | enum | No | This is used to order analytics in the ascending or descending order |
| `filter[label]` | string | No | filter by label |
| `filter[status]` | string | No | filter by status |
| `filter[description]` | string | No | filter by description |
| `filter[scopes]` | object | No | filter items by scopes |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/voice_issues?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/voice_issuesindex](https://developers.beyondwords.io/reference/voice_issuesindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/voice_issues`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/voice_issues&api_token={api_token}
```
**Body Parameters**:
| `label` | enum | No | The voice issue label. Possible values are incorrect_pronunciation, incorrect_lexical_stress, incorrect_heteronym, incorrect_language, incorrect_intonation, incorrect_spoken_format, incorrect_pausing, incorrect_speed, text_missing_or_added, audio_issue |
| `description` | string | No | The voice issue description |
| `project` | object | No | Project Object |
| `content` | object | No | Content Object |
| `media` | object | No | Media Object |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/voice_issues?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"label":"value","description":"value","project":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/voice_issuecreate](https://developers.beyondwords.io/reference/voice_issuecreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/voice_issues/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/voice_issues/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your voice issue |
**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**:
| `label` | enum | No | The voice issue label. Possible values are incorrect_pronunciation, incorrect_lexical_stress, incorrect_heteronym, incorrect_language, incorrect_intonation, incorrect_spoken_format, incorrect_pausing, incorrect_speed, text_missing_or_added, audio_issue |
| `description` | string | No | The voice issue description |
| `project` | object | No | Project Object |
| `content` | object | No | Content Object |
| `media` | object | No | Media Object |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/voice_issues/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"label":"value","description":"value","project":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/voice_issueupdate](https://developers.beyondwords.io/reference/voice_issueupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/voice_issues/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/voice_issues/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your voice issue |
**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/beyondwords/v1/voice_issues/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/voice_issueshow](https://developers.beyondwords.io/reference/voice_issueshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/voice_issues/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/voice_issues/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The numeric ID of your voice issue |
**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/beyondwords/v1/voice_issues/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/voice_issuedelete](https://developers.beyondwords.io/reference/voice_issuedelete)
---
### Category: Voices
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/organization/voices`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/organization/voices?...&api_token={api_token}
```
**Query Parameters**:
| `filter[language.id]` | string | No | filter by language id |
| `filter[language.code]` | string | No | filter by language code |
| `filter[scopes][]` | array | No | The filter scopes |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/beyondwords/v1/organization/voices?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/organizationvoicesindex](https://developers.beyondwords.io/reference/organizationvoicesindex)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/organization/voices/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/organization/voices/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | 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.
**Body Parameters**:
| `speaking_rate` | number | Yes | The speaking rate for this voice as a percentage. Ranges from 50 to 200, where 100 is default speed, 50 is half speed, and 200 is double speed. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/organization/voices/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"speaking_rate":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/organizationvoicesupdate](https://developers.beyondwords.io/reference/organizationvoicesupdate)
---
### Category: Webhooks
#### List
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/webhooks`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks?project_id={project_id}&...&api_token={api_token}
```
**Query Parameters**:
| `pagination[limit]` | number | No | 'limit' sets the number of results to return in each page. |
| `pagination[offset]` | number | No | 'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result. |
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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/beyondwords/v1/projects/project_id/webhooks?project_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectswebhooksindex](https://developers.beyondwords.io/reference/projectswebhooksindex)
---
#### Create
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/webhooks`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks&api_token={api_token}
```
**Body Parameters**:
| `url` | string | Yes | The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS |
| `headers` | object | No | |
| `enabled` | boolean | No | Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"value","headers":"value","enabled":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectswebhookscreate](https://developers.beyondwords.io/reference/projectswebhookscreate)
---
#### Update
**Method**: `PUT` | **LowCodeAPI Path**: `/v1/projects/project_id/webhooks/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | 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.
**Body Parameters**:
| `url` | string | No | The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS |
| `headers` | object | No | |
| `enabled` | boolean | No | Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"value","headers":"value","enabled":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectswebhooksupdate](https://developers.beyondwords.io/reference/projectswebhooksupdate)
---
#### Show
**Method**: `GET` | **LowCodeAPI Path**: `/v1/projects/project_id/webhooks/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | 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/beyondwords/v1/projects/project_id/webhooks/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectswebhooksshow](https://developers.beyondwords.io/reference/projectswebhooksshow)
---
#### Delete
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1/projects/project_id/webhooks/id`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/id?project_id={project_id}&id={id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
| `id` | string | 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 DELETE "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/id?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectswebhooksdelete](https://developers.beyondwords.io/reference/projectswebhooksdelete)
---
#### Test
**Method**: `POST` | **LowCodeAPI Path**: `/v1/projects/project_id/webhooks/test`
**Full URL**:
```
https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/test?project_id={project_id}&api_token={api_token}
```
**Path Parameters**:
| `project_id` | string | The numeric ID of your project |
**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**:
| `url` | string | No | The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS |
| `headers` | object | No | |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/beyondwords/v1/projects/project_id/webhooks/test?project_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"value","headers":"value"}'
```
**Official Documentation**: [https://developers.beyondwords.io/reference/projectswebhookstest](https://developers.beyondwords.io/reference/projectswebhookstest)
---
## Usage Examples
### Example 1: Basic Usage
Get started with BeyondWords API by making your first request.
```bash
# Your example code here
# This demonstrates basic usage
curl -X GET "https://api.lowcodeapi.com/beyondwords/?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/beyondwords/?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/beyondwords/definition`
- **Official Provider Documentation**: [https://developers.beyondwords.io/reference/api-overview](https://developers.beyondwords.io/reference/api-overview)
## Rate Limits & Best Practices
- Check your BeyondWords 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