BEbeyondwords
Content

List content items

Changed on

Lists content items within a project.

get/projects/{project_id}/content

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/content
  • Auth
    API key in header X-Api-Key

Query parameters

filter[id]string

filter by content id

filter[source_id]string

filter by content source id

filter[source_url]string

filter by content source url

filter[title]string

filter by content title

filter[body]string

filter by content body

filter[published]boolean

filter by content published status

filter[video_published]boolean

filter by content video published status

filter[generate_audio]boolean

filter by content audio generation setting

filter[statuses][]string[]

filter by content statuses

filter[created][from]string date-time

filter by created time from (ISO 8601)

filter[created][to]string date-time

filter by created time to (ISO 8601)

filter[updated][from]string date-time

filter by updated time from (ISO 8601)

filter[updated][to]string date-time

filter by updated time to (ISO 8601)

filter[publish_date][from]string date-time

filter by publish date from (ISO 8601)

filter[publish_date][to]string date-time

filter by publish date to (ISO 8601)

pagination[limit]integer

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

pagination[offset]integer

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

order[by]'created' | 'publish_date' | 'duration' | 'published' | 'status'

This is used to order content

order[dir]'asc' | 'desc'

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

Response

OK

idstring nullable

Unique identifier for the content. Can be either a UUID or an externally provided source_id

status'draft' | 'ready' | 'queued' | 'processing' | 'processed' | 'skipped' | 'error'

The current status of the content processing operation. This value will change as the content is processed. ready means the content is prepared and indexed, but audio generation wasn't requested (generate_audio is false). Reaching ready sends a content.ready webhook with the ready state and without media, a preparation failure sends audio.error.

type'auto_segment' | 'manual_segment' | 'audio_upload'

The content type. Possible values are auto_segment, manual_segment or audio_upload

titlestring nullable

The content title

summarystring nullable

The content summary

bodystring nullable

The content body

title_enabledboolean

The flag to enable title segments in audio

body_enabledboolean

The flag to enable body segments in audio

summary_enabledboolean

The flag to enable summary audio

summary_title_enabledboolean

The flag to include title text and audio segments in summaries

source_idstring nullable

The externally-provided source identifier of the content

source_urlstring nullable

The URL that contains the source content

authorstring nullable

The author of the content

tagsstring[]

Arbitrary tags associated with the content, used for playlist filtering

image_urlstring nullable

The feature image URL of the content

metadataobject nullable

The arbitrary metadata associated with content

publishedboolean

Whether the content will appear in the BeyondWords players and podcast feeds

video_publishedboolean

Whether the content will appear in the BeyondWords video players and podcast video feeds

publish_datestring nullable

Time at which the content was published or is scheduled to be published (ISO 8601)

ads_enabledboolean

Whether adverts will play for this content in the BeyondWords players

ai_summary_promptstring nullable

The last used AI prompt for summary generation

ai_summary_updates_enabledboolean

Whether the summary segments will be regenerated when the text content is updated

auto_segment_updates_enabledboolean

Whether the media files will be regenerated when the text content is updated with auto_segment. Content with generate_audio set to false is always prepared and indexed again on text updates

generate_audioboolean

Whether audio (and dependent video) is generated automatically for the content. Content with false is prepared and indexed without audio generation and has the ready status unless it already has audio. Not applicable to audio_upload content

languagestring nullable

The default language of the content

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

Changes

  • 994b9853e685Revision changes
    • warning

      added the new ready enum value to the / response property for the response status

    • info

      added the new optional query request parameter filter[generate_audio]

    • info

      added the optional property / to the response with the status

    • info

      response property items/metadata deprecated