Getting started
Analytics
Content
Languages
Player settings
Player
Playlists
Webhooks
RSS Feed
Rules
Video Settings
Playlists
List playlists
Playlists
List playlists
Lists playlists within a project
GET
/
projects
/
{project_id}
/
playlists
curl --request GET \
--url https://api.beyondwords.io/v1/projects/{project_id}/playlists \
--header 'X-Api-Key: <api-key>'[
{
"id": 1,
"title": "My project playlist",
"enabled": true,
"type": "project",
"rules_version": "1.0",
"rules": [],
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
},
{
"id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
},
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
},
{
"id": "7449fca4-2ecc-4bb8-9849-ae5c9f194fa6"
},
{
"id": "eb0cbce7-6160-4d11-b0d2-ecb9eb92502c"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
},
{
"id": 2,
"title": "My manual playlist",
"enabled": true,
"type": "manual",
"rules_version": "1.0",
"rules": [],
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
},
{
"id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
},
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
},
{
"id": 3,
"title": "My auto playlist",
"enabled": true,
"type": "auto",
"rules_version": "1.0",
"rules": [
{
"operator": "and",
"conjunction": [
{
"field": "author",
"operator": "is",
"arg": "John Smith"
}
]
}
],
"content_limit": 25,
"content": [
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
}
],
"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
Query Parameters
The partial title to filter by
The partial settings title to filter by
The types of playlists to return
This is used to order playlists by created date
Available options:
created This is used to order analytics in the ascending or descending order
Available options:
asc, desc 'limit' sets the number of results to return in each page.
'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.
Response
200
application/json
OK
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 GET \
--url https://api.beyondwords.io/v1/projects/{project_id}/playlists \
--header 'X-Api-Key: <api-key>'[
{
"id": 1,
"title": "My project playlist",
"enabled": true,
"type": "project",
"rules_version": "1.0",
"rules": [],
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
},
{
"id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
},
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
},
{
"id": "7449fca4-2ecc-4bb8-9849-ae5c9f194fa6"
},
{
"id": "eb0cbce7-6160-4d11-b0d2-ecb9eb92502c"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
},
{
"id": 2,
"title": "My manual playlist",
"enabled": true,
"type": "manual",
"rules_version": "1.0",
"rules": [],
"content_limit": 25,
"content": [
{
"id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
},
{
"id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
},
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
},
{
"id": 3,
"title": "My auto playlist",
"enabled": true,
"type": "auto",
"rules_version": "1.0",
"rules": [
{
"operator": "and",
"conjunction": [
{
"field": "author",
"operator": "is",
"arg": "John Smith"
}
]
}
],
"content_limit": 25,
"content": [
{
"id": "1c0274ba-362d-4dea-8a34-5177061bf032"
}
],
"settings": null,
"created": "2023-01-01 00:00:00 UTC",
"updated": "2023-01-01 00:00:05 UTC"
}
]