project_id

'limit' sets the number of results to return in each page.

pagination[limit]

'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.

pagination[offset]

The click-through URL of the custom ad to show in the player

The image URL to show in the player while the ad is playing

The URL of the media file of the custom ad to play in the player

Whether the ad should play before/during/after the audio content. Possible values are pre-roll, mid-roll, or post-roll

The time range for when the ad should play in the player

Retrieves analytics for all projects within an organization


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).

aggregation

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[start]

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.

time_range[end]

The metrics that you want to fetch data for

metrics[]

media_variants[]

Retrieves an analytics overview for all projects within an organization



This is used to order analytics by number of listens or average listen time or average listen duration

order[by]

This is used to order analytics in the ascending or descending order

order[dir]

Get analytics for content whose title contains the specified string. Note: filter[title] does not work in combination with order[by]

filter[title]

Retrieves an analytics overview for all content items in a project



Retrieve analytics for some specific content.



The UUID of the content item (or a legacy numeric ID)

Retrieve analytics overview for all ads in a project.



filter[ids][]

Retrieve analytics for a single ad in a project.


filter[scopes]

filter[custom]

Creates a background track in a organization



Updates a background track in a organization



filter[published]

filter[statuses][]

filter[created][from]

filter[created][to]

filter[updated][from]

filter[updated][to]

This is used to order content by created date or duration or published status

The level of detail to show for segments in the response: 'none', 'partial' or 'full'

segments

Update a content item from your project



The level of detail to show for segment words in the response: 'none', 'partial' or 'full'

words

Delete a content item from your project



The model of AI. Possible values are chat_gpt

filter[project.id]

The class attribute of an element. This filter will be applied to any element that contains the class

The name of the tag representing the element

The XPath specifying the elements. https://www.w3.org/TR/1999/REC-xpath-19991116/

Whether BeyondWords should use the filter to include or exclude the selected part of the HTML document. The default is false

The string value contained within an element. This filter will be applied to any element that contains the value

Gets player data related to a content item



The UUID of your content item (or a legacy numeric ID)

preview_token

Gets player data related to a content item


An encoded JSON array containing mixed identifiers

array

Get the player settings for your project



Updates the player settings for a project



Whether to show a download button next to each playlist item in the player

Whether to show or hide the image in the player

An image to show in the player instead of the content's image

Whether or not the intro and outro should be played. The default is false

The URL of an intro audio file to play before all content in the player

Whether to show the BeyondWords logo in the player

The URL of an outro audio file to play after all content in the player.

The style of paywall to apply to the player. Possible values are none, show, hide or lock You can specify the number of body segments to make listenable, e.g. show-3

The URL to link to when the content is paywalled, e.g. a signup page

Whether to show clickable ad images in the player when the ad isn't playing

he style of user interface to show for the player. Possible values are small, standard, large, or video

The title to show in the large player when there isn't a playlist

The player version to use. Possible values are 0 for legacy and 1 for the current

Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page Support for this depends on adding some markup into the HTML of the page.

Whether to show a share button in the player

The style of skip buttons to show in the player. Possible values are auto, segments, seconds or audios You can specify the number of seconds to skip, e.g. seconds-15 or seconds-15-30 The auto style uses audios if there is a playlist and segments otherwise.

Whether to always show the content's title (e.g. instead of the call_to_action)

Whether to show an icon stating that the voice was AI generated in the player

The side of the screen on which to show the widget. Possible values are auto, left, center, right The 'auto' position places the standard player in the center, otherwise to the right.

The style of user interface to show for the widget at the bottom of the screen. Possible values are none, small, standard, large, video The widget appears once you scroll past the player in the page.

Lists all projects in your organization



User should be able to list all RSS feeds.

User should be able to create an RSS feed.


Whether importing is enabled or disabled.

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.

Headers that you want to include in the HTTP request when fetching and extracting the content from the map.source_url.

Type of content in the feed. Possible values include xml or json.

Headers that you want to include in the HTTP request when fetching the RSS feed.

Number of minutes between each import of the RSS feed.

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.

Request body can include all but the readonly props.



User should be able to delete an RSS feed.



User should be able to run an RSS feed bypassing the "import_interval".



This is used to order rules by type or key or value

filter[type]

filter[preview_status]

filter[key]

The text you want the rule to be applied to

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

Get the summarization settings for your project


Update the summarization settings for your project



Whether AI summaries should be generated for the project.

The prompt that will be used to generate AI summaries.

Update the video settings for your project



The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...)

Whether to show the content's image_url as the default background image.

Whether text-to-speech videos should be generated for the project.

Whether to extract images by default from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.

The position of the logo that appears in the corner of the video.

The logo that should appear in the corner of the video. Defaults to the BeyondWords logo.

Whether to automatically pan and zoom images in generated videos.

The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...)

The foreground color of text. Supports CSS colors including linear-gradient(to right, ...)

The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...)

The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...)

This is used to order voice issues by created time

filter[label]

filter[status]

filter[description]

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

filter[language.id]

filter[language.code]

filter[scopes][]

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.

Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true.

The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS

BeyondWords 

BeyondWords API

BeyondWords  API

Pre-configured, Predictable, Single Interface, Ready-to-use, Opinionated & Managed API Explorer & Server. Bring your API credentials, configure and access your 3rd party APIs. Using LowCodeAPI securely manage all integrations in one place.