Skip to main content
This object represents an item of content that belongs to a project.
PropertyTypeDescription
idstringUnique UUID for the object.
statusstringThe current status of the content processing operation. This value will change as the content is processed. Possible values are draft, queued, processing, processed, skipped, error
typestringThe type. Possible values are auto_segmet, manual_segment or audio_upload
titlestringThe content title.
summarystringThe content summary.
bodystringThe content body.
source_idstringThe externally-provided source identifier of the content. For example, this could be the id of the content in your CMS.
source_urlstringThe URL that contains the source content. For example, this could be the public URL of the content.
authorstringThe author of the content.
image_urlstringThe feature image URL of the content.
metadataobjectThe arbitrary metadata associated with content. For example, this could be {"category": "sport"}
audioarrayThe array of generated audio files for the entire content.
audio.idintegerUnique identifier for the audio object.
audio.content_typestringThe MIME type of the audio file according to the IANA specification.
audio.urlstringThe URL of the generated audio file.
audio.durationintegerThe duration of the generated audio file in milliseconds.
videoarrayThe array of generated video files for the entire content.
segmentsarrayThe array of segments in the content
segments.idintegerUnique identifier for the segment object
segments.markerstringThe marker associated with the segment. To support playback from segments (i.e. paragraphs), you need to use the BeyondWords Player and add markers to the elements.
segments.sectionstringThe section type of the segment. Possible values are title, summary, or body
segments.content_typestringThe content type of the segment. Possible values are text, audio, or image. Text and audio will be included in generated audios. Text, audio, and images will be included in generated videos (coming soon).
segments.textstringThe plain text for this segment if segment.content_type is text
segments.audio_urlstringThe URL of the uploaded audio file for this segment if the segment.content_type is audio
segments.image_urlstringThe URL of the uploaded image file for this segment if the segment.content_type is image
segments.languageobjectThe language object associated with this segment if the segment.content_type is text
segments.language.codestringThe language code of the segment if the segment.content_type is text
segments.language.namestringThe language name of the segment if the segment.content_type is text
segments.voiceobjectThe voice object associated with this segment if the segment.content_type is text
segments.voice.idintegerThe id of the voice used to generate the audio of the segment if the segment.content_type is text
segments.voice.namestringThe name of voice used to generate the audio of the segment if the segment.content_type is text
segments.start_timeintegerThe start time of this segment in milliseconds. This may not exactly match the summed durations because of audio alignment gaps.
segments.durationintegerThe duration of this segment in milliseconds.
segments.createdstringTime at which the segment object was created (ISO 8601).
segments.updatedstringTime at which the segment object was updated (ISO 8601).
publishedbooleanWhether the content will appear in the BeyondWords Players
publish_datestringTime at which the content was published or is scheduled to be published (ISO 8601).
ads_enabledbooleanWhether adverts will play for this content in the BeyondWords Players. If you don’t have any ads then no ads will play.
auto_segment_updates_enabledbooleanWhether the media files will be regenerated when the title, summary or body content is updated with auto_segment
createdstringTime at which the object was created (ISO 8601).
updatedstringTime at which the object was updated (ISO 8601).