Create

post

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

Creates a content item in your project

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
After submitting a POST request, the content status will be set to 'queued' since generating the audio may take several minutes, after which the status will update to 'processed'

You have three options when it comes to generating audio: auto_segment, manual_segment, or audio_upload. See Content overview to learn more.

Path Params

project_id

string

required

The numeric ID of your project

Query Params

segments

string

enum

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

Allowed:

Body Params

Create content with auto segment type

type

string

enum

required

Defaults to auto_segment

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

Allowed:

title

string

The content title

summary

string

The content summary

body

string

required

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

published

boolean | null

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 | null

Whether adverts will play for this content in the BeyondWords players

auto_segment_updates_enabled

boolean | null

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

title_voice_id

integer | null

The id of the voice used to generate the audio of the title text.

summary_voice_id

integer | null

The id of the voice used to generate the audio of the summary text.

body_voice_id

integer | null

The id of the voice used to generate the audio of the body text.

ai_summary_updates_enabled

boolean

Whether the summary segments will be regenerated

language

string | null

The default language of the content, format is ISO 639-1 (with underscore delimiter like en_GB)

background_track

object | null

summarization_settings

object | null

video_settings

object | null

Response

201successful