GET
/
projects
/
{project_id}
/
content
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd",
    "status": "processed",
    "type": "auto_segment",
    "title": "<h1 data-beyondwords-marker=\"h1-title\">Example title</h1>",
    "summary": "<h2 data-beyondwords-marker=\"h2-summary\">This article is about TTS</h2>",
    "body": "<p data-beyondwords-marker=\"paragraph-1\">Example body</p>",
    "source_id": "example-source-id",
    "source_url": "https://example.com/some-article",
    "author": "John Smith",
    "image_url": "https://example.com/image.jpeg",
    "title_enabled": true,
    "body_enabled": true,
    "summary_enabled": true,
    "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
      }
    ],
    "segments": [
      {
        "id": 1,
        "section": "title",
        "marker": "h1-title",
        "xpath": "/html/body/h1",
        "md5": "0cc175b9c0f1b6a831c399e269772661",
        "content_type": "text",
        "text": "Example title",
        "audio_url": null,
        "image_url": null,
        "language": {
          "code": "en_GB",
          "name": "English"
        },
        "voice": {
          "id": 123,
          "name": "Jane"
        },
        "start_time": 3,
        "duration": 2000,
        "created": "2023-01-01 00:00:00 UTC",
        "updated": "2023-01-01 00:00:05 UTC"
      },
      {
        "id": 2,
        "section": "summary",
        "marker": "h2-summary",
        "xpath": "/html/body/h2",
        "md5": "0cc175b9c0f1b6a831c399e269772661",
        "content_type": "text",
        "text": "This article is about text-to-speech",
        "audio_url": null,
        "image_url": null,
        "language": {
          "code": "en_GB",
          "name": "English"
        },
        "voice": {
          "id": 123,
          "name": "Jane"
        },
        "start_time": 2006,
        "duration": 6000,
        "created": "2023-01-01 00:00:00 UTC",
        "updated": "2023-01-01 00:00:05 UTC"
      },
      {
        "id": 3,
        "section": "body",
        "marker": "paragraph-1",
        "xpath": "/html/body/p[1]",
        "md5": "0cc175b9c0f1b6a831c399e269772661",
        "content_type": "text",
        "text": "Example title",
        "audio_url": null,
        "image_url": null,
        "language": {
          "code": "en_GB",
          "name": "English"
        },
        "voice": {
          "id": 123,
          "name": "Jane"
        },
        "start_time": 8009,
        "duration": 1991,
        "created": "2023-01-01 00:00:00 UTC",
        "updated": "2023-01-01 00:00:05 UTC"
      }
    ],
    "ads_enabled": true,
    "auto_segment_updates_enabled": true,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd",
    "status": "processed",
    "type": "manual_segment",
    "source_id": "example-source-id-1",
    "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
      }
    ],
    "segments": [
      {
        "id": 1,
        "section": "title",
        "content_type": "text",
        "text": "This is a title",
        "voice": {
          "id": 1
        }
      },
      {
        "id": 2,
        "section": "body",
        "content_type": "text",
        "text": "This is new paragraph",
        "voice": {
          "id": 1
        }
      },
      {
        "id": 3,
        "section": "body",
        "content_type": "image",
        "image_url": "https://example.com/image.jpeg"
      },
      {
        "id": 4,
        "section": "body",
        "content_type": "text",
        "text": "This is another paragraph",
        "voice": {
          "id": 1
        }
      },
      {
        "id": 5,
        "section": "body",
        "content_type": "audio",
        "audio_url": "https://example.com/image.mp3"
      },
      {
        "id": 6,
        "section": "body",
        "content_type": "text",
        "text": "This is another paragraph",
        "voice": {
          "id": 1
        },
        "created": "2023-01-01 00:00:00 UTC",
        "updated": "2023-01-01 00:00:05 UTC"
      }
    ],
    "ads_enabled": true,
    "auto_segment_updates_enabled": true,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Query Parameters

​
segments
enum<string>

The level of detail to show for segments in the response: 'none', 'partial' or 'full'

Available options:
partial,
full
​
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[statuses][]
string[]

filter by content statuses

​
filter[created][from]
string

filter by created time from (ISO 8601)

​
filter[created][to]
string

filter by created time to (ISO 8601)

​
filter[updated][from]
string

filter by updated time from (ISO 8601)

​
filter[updated][to]
string

filter by updated time to (ISO 8601)

​
filter[publish_date][from]
string

filter by publish date from (ISO 8601)

​
filter[publish_date][to]
string

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]
enum<string>

This is used to order content

Available options:
created,
publish_date,
duration,
published,
status
​
order[dir]
enum<string>

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

Available options:
asc,
desc

Response

200
application/json
OK
​
id
string

Unique UUID or the source_id for the object

​
status
enum<string>

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
​
type
enum<string>

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

Available options:
auto_segment,
manual_segment,
audio_upload
​
title
string | null

The content title

​
summary
string | null

The content summary

​
body
string | null

The content body

​
title_enabled
boolean

The flag to enable title segments in audio

​
body_enabled
boolean

The flag to enable body segments in audio

​
summary_enabled
boolean

The flag to enable summary audio

​
summary_title_enabled
boolean

The flag to include title text and audio segments in summaries

​
source_id
string | null

The externally-provided source identifier of the content

​
source_url
string | null

The URL that contains the source content

​
author
string | null

The author of the content

​
image_url
string | null

The feature image URL of the content

​
metadata
object | null

The arbitrary metadata associated with content

​
audio
object[] | null

The array of audio files for the entire content

​
video
object[] | null

The array of video files for the entire content

​
summarization
object
​
segments
object[] | null

The array of segments in the content

​
published
boolean

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

​
publish_date
string | null

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

​
ai_summary_prompt
string | null

The last used AI prompt for summary generation

​
ai_summary_updates_enabled
boolean

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

​
auto_segment_updates_enabled
boolean

Whether the media files will be regenerated when the text content is updated with auto_segment

​
background_track
object | null
​
summarization_settings
object | null
​
video_settings
object | null
​
language
string | null

The default language of the content

​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)

Previous
Create content
Next