Getting started
Analytics
Content
Languages
Player settings
Player
Playlists
Webhooks
RSS Feed
Rules
Video Settings
Playlists
Create playlist
Playlists
Create playlist
Creates a playlist in a project
POST
/
projects
/
{project_id}
/
playlists
curl --request POST \
--url https://api.beyondwords.io/v1/projects/{project_id}/playlists \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"title": "My playlist",
"enabled": true,
"type": "manual",
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
},
{
"id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
},
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
}
]
}'{
"id": 1,
"title": "My playlist",
"enabled": true,
"type": "manual",
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd",
"status": "processed",
"title": "Content title",
"source_id": "example-source-id",
"source_url": "https://example.com/some-article",
"author": "John Smith",
"image_url": "https://example.com/image.jpeg",
"metadata": {
"key": "value"
},
"audio": [
{
"id": 1,
"content_type": "application/vnd.apple.mpegurl",
"url": "https://example.com/audio.m3u8",
"duration": 10000
},
{
"id": 2,
"content_type": "audio/mpeg,",
"url": "https://example.com/audio.mp3",
"duration": 10000
}
],
"video": [
{
"id": 1,
"content_type": "video/mp4",
"url": "https://example.com/waveform-video.mp4",
"duration": 10000
}
],
"ads_enabled": true,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}Authorizations
Path Parameters
The numeric ID of your project
Body
application/json
The title of the playlist
The type of playlist. The project type is generated automatically. The manual and auto can set content and rules respectively
Available options:
project, manual, auto Whether the playlist can be played in the BeyondWords player
The IDs of content to include in the manual playlist
UUID of the content item to include in the playlist
The image URL of the playlist
Response
201 - application/json
successful
Unique identifier for the object
The title of the playlist
Whether the playlist can be played in the BeyondWords player
The type of playlist. The project type is generated automatically. The manual and auto can set content and rules respectively
Available options:
project, manual, auto The maximum number of content items that will appear in the playlist
The content of the playlist (a reduced set of fields are returned). Only the id field is returned for the playlists index endpoint
Unique UUID or the source_id for the object
The current status of the content processing operation. This value will change as the content is processed.
Available options:
draft, queued, processing, processed, skipped, error The content type. Possible values are auto_segment, manual_segment or audio_upload
Available options:
auto_segment, manual_segment, audio_upload The content title
The flag to enable title segments in audio
The flag to enable body segments in audio
The flag to enable summary audio
The flag to include title text and audio segments in summaries
The externally-provided source identifier of the content
The URL that contains the source content
The author of the content
The feature image URL of the content
The arbitrary metadata associated with content
The array of audio files for the entire content
Unique identifier for the object
Available options:
article, summary The MIME type of the audio file according to the IANA specification
Available options:
audio/mpeg, application/x-mpegURL The URL of the audio file
The duration of the audio file in milliseconds
The content of the media file encoded as base64. Only present for .m3u8 metadata files
The array of video files for the entire content
Unique identifier for the object
Available options:
article, summary The MIME type of the video file according to the IANA specification
Available options:
video/mp4, application/x-mpegURL The URL of the video file
The duration of the video file in milliseconds
The content of the media file encoded as base64. Only present for .m3u8 metadata files
The array of summary audio files for the entire content
Unique identifier for the object
Available options:
article, summary The MIME type of the audio file according to the IANA specification
Available options:
audio/mpeg, application/x-mpegURL The URL of the audio file
The duration of the audio file in milliseconds
The content of the media file encoded as base64. Only present for .m3u8 metadata files
The array of summary video files for the entire content
Unique identifier for the object
Available options:
article, summary The MIME type of the video file according to the IANA specification
Available options:
video/mp4, application/x-mpegURL The URL of the video file
The duration of the video file in milliseconds
The content of the media file encoded as base64. Only present for .m3u8 metadata files
Whether the content will appear in the BeyondWords players and podcast feeds
Time at which the content was published or is scheduled to be published (ISO 8601)
Whether adverts will play for this content in the BeyondWords players
Whether the media files will be regenerated when the text content is updated with auto_segment
The default language of the content
Time at which the object was created (ISO 8601)
Time at which the object was updated (ISO 8601)
Time at which the object was created (ISO 8601)
The title of the podcast feed
Whether or not the podcast feed URL is available
The description of the podcast feed
The homepage URL of the podcast feed
The image URL of the podcast feed
Category data for Apple Podcasts and Spotify
The primary category of the podcast
The primary subcategory of the podcast
The secondary category of the podcast
The secondary subcategory of the podcast
An array of Google Podcast categories of the podcast
The podcast feed language
The name of the administrator for the podcast
The email of the administrator for the podcast
The names of writers/speakers who contribute to the podcast
Whether or not the podcast contains explicit content
An array of keywords to associate with the podcast
The maximum number of podcasts that will appear in the feed
The copyright tag of the podcast feed
Time at which the object was updated (ISO 8601)
curl --request POST \
--url https://api.beyondwords.io/v1/projects/{project_id}/playlists \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"title": "My playlist",
"enabled": true,
"type": "manual",
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
},
{
"id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
},
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
}
]
}'{
"id": 1,
"title": "My playlist",
"enabled": true,
"type": "manual",
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd",
"status": "processed",
"title": "Content title",
"source_id": "example-source-id",
"source_url": "https://example.com/some-article",
"author": "John Smith",
"image_url": "https://example.com/image.jpeg",
"metadata": {
"key": "value"
},
"audio": [
{
"id": 1,
"content_type": "application/vnd.apple.mpegurl",
"url": "https://example.com/audio.m3u8",
"duration": 10000
},
{
"id": 2,
"content_type": "audio/mpeg,",
"url": "https://example.com/audio.mp3",
"duration": 10000
}
],
"video": [
{
"id": 1,
"content_type": "video/mp4",
"url": "https://example.com/waveform-video.mp4",
"duration": 10000
}
],
"ads_enabled": true,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}