List content

GET

projects

{project_id}

content

List content items

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/content"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/content', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/content",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beyondwords.io/v1/projects/{project_id}/content"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.beyondwords.io/v1/projects/{project_id}/content")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/content")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "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"
        },
        "preprocessing_settings": {
          "ai_preprocessing_enabled": true
        },
        "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"
        },
        "preprocessing_settings": null,
        "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"
        },
        "preprocessing_settings": null,
        "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
        },
        "preprocessing_settings": {
          "ai_preprocessing_enabled": true
        }
      },
      {
        "id": 2,
        "section": "body",
        "content_type": "text",
        "text": "This is new paragraph",
        "voice": {
          "id": 1
        },
        "preprocessing_settings": null
      },
      {
        "id": 3,
        "section": "body",
        "content_type": "image",
        "image_url": "https://example.com/image.jpeg",
        "preprocessing_settings": null
      },
      {
        "id": 4,
        "section": "body",
        "content_type": "text",
        "text": "This is another paragraph",
        "voice": {
          "id": 1
        },
        "preprocessing_settings": null
      },
      {
        "id": 5,
        "section": "body",
        "content_type": "audio",
        "audio_url": "https://example.com/image.mp3",
        "preprocessing_settings": null
      },
      {
        "id": 6,
        "section": "body",
        "content_type": "text",
        "text": "This is another paragraph",
        "voice": {
          "id": 1
        },
        "preprocessing_settings": null,
        "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"
  }
]

{
  "code": 401,
  "message": "Unauthorized"
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

project_id

string

required

The numeric ID of your project

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[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]

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

segments

enum<string>

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

Available options:

partial,

full

Response

string | null

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

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

Required string length: 1 - 500

summary

string | null

The content summary

Maximum string length: 2000

body

string | null

The content body

Maximum string length: 100000

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

tags

string[]

Arbitrary tags associated with the content, used for playlist filtering

image_url

string | null

deprecated

The feature image URL of the content

metadata

object | null

The arbitrary metadata associated with content

audio

object[]

The array of audio files for the entire content

Show child attributes

video

object[]

The array of video files for the entire content

Show child attributes

audio_with_intro_outro

object[]

Show child attributes

summarization

object

Show child attributes

segments

object[] | null

The array of segments in the content

Show child attributes

published

boolean

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

video_published

boolean

Whether the content will appear in the BeyondWords video players and podcast video 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

Maximum string length: 1000

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

Show child attributes

feature_image

object | null

Show child attributes

feature_video

object | null

Show child attributes

summarization_settings

object | null

Show child attributes

video_settings

object | null

Show child attributes

preprocessing_settings

object | null

Show child attributes

language

string | null

The default language of the content

created

string<date-time>

Time at which the object was created (ISO 8601)

updated

string<date-time>

Time at which the object was updated (ISO 8601)

OverviewConfigure which HTML elements are included or excluded from audio generation

List content items

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/content"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/content', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/content",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beyondwords.io/v1/projects/{project_id}/content"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.beyondwords.io/v1/projects/{project_id}/content")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/content")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "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"
        },
        "preprocessing_settings": {
          "ai_preprocessing_enabled": true
        },
        "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"
        },
        "preprocessing_settings": null,
        "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"
        },
        "preprocessing_settings": null,
        "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
        },
        "preprocessing_settings": {
          "ai_preprocessing_enabled": true
        }
      },
      {
        "id": 2,
        "section": "body",
        "content_type": "text",
        "text": "This is new paragraph",
        "voice": {
          "id": 1
        },
        "preprocessing_settings": null
      },
      {
        "id": 3,
        "section": "body",
        "content_type": "image",
        "image_url": "https://example.com/image.jpeg",
        "preprocessing_settings": null
      },
      {
        "id": 4,
        "section": "body",
        "content_type": "text",
        "text": "This is another paragraph",
        "voice": {
          "id": 1
        },
        "preprocessing_settings": null
      },
      {
        "id": 5,
        "section": "body",
        "content_type": "audio",
        "audio_url": "https://example.com/image.mp3",
        "preprocessing_settings": null
      },
      {
        "id": 6,
        "section": "body",
        "content_type": "text",
        "text": "This is another paragraph",
        "voice": {
          "id": 1
        },
        "preprocessing_settings": null,
        "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"
  }
]

{
  "code": 401,
  "message": "Unauthorized"
}

Getting started

Content

Extraction

Pronunciation settings

Script settings

Video settings

Background music settings

Voices

Distribution

Integrations

Analytics

Monetization

Organization

Authorizations

Path Parameters

Query Parameters

Response