The content object

Learn about the content object

This object represents an item of content that belongs to a project.

Property	Type	Description
id	string	Unique UUID for the object.
status	string	The 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
type	string	The type. Possible values are auto_segmet, manual_segment or audio_upload
title	string	The content title.
summary	string	The content summary.
body	string	The content body.
source_id	string	The externally-provided source identifier of the content. For example, this could be the id of the content in your CMS.
source_url	string	The URL that contains the source content. For example, this could be the public URL of the content.
author	string	The author of the content.
image_url	string	The feature image URL of the content.
metadata	object	The arbitrary metadata associated with content. For example, this could be {"category": "sport"}
audio	array	The array of generated audio files for the entire content.
audio.id	integer	Unique identifier for the audio object.
audio.content_type	string	The MIME type of the audio file according to the IANA specification.
audio.url	string	The URL of the generated audio file.
audio.duration	integer	The duration of the generated audio file in milliseconds.
video	array	The array of generated video files for the entire content.
segments	array	The array of segments in the content
segments.id	integer	Unique identifier for the segment object
segments.marker	string	The 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.section	string	The section type of the segment. Possible values are title, summary, or body
segments.content_type	string	The 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.text	string	The plain text for this segment if segment.content_type is text
segments.audio_url	string	The URL of the uploaded audio file for this segment if the segment.content_type is audio
segments.image_url	string	The URL of the uploaded image file for this segment if the segment.content_type is image
segments.language	object	The language object associated with this segment if the segment.content_type is text
segments.language.code	string	The language code of the segment if the segment.content_type is text
segments.language.name	string	The language name of the segment if the segment.content_type is text
segments.voice	object	The voice object associated with this segment if the segment.content_type is text
segments.voice.id	integer	The id of the voice used to generate the audio of the segment if the segment.content_type is text
segments.voice.name	string	The name of voice used to generate the audio of the segment if the segment.content_type is text
segments.start_time	integer	The start time of this segment in milliseconds. This may not exactly match the summed durations because of audio alignment gaps.
segments.duration	integer	The duration of this segment in milliseconds.
segments.created	string	Time at which the segment object was created (ISO 8601).
segments.updated	string	Time at which the segment object was updated (ISO 8601).
published	boolean	Whether the content will appear in the BeyondWords Players
publish_date	string	Time at which the content was published or is scheduled to be published (ISO 8601).
ads_enabled	boolean	Whether 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_enabled	boolean	Whether the media files will be regenerated when the title, summary or body content is updated with auto_segment
created	string	Time at which the object was created (ISO 8601).
updated	string	Time at which the object was updated (ISO 8601).