Skip to main content
POST

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
name
string
required

The project name

​
language
object
required
​
title
object
​
summary
object
​
body
object
​
background_track
object | null
​
auto_publish_enabled
boolean

When true, automatically distribute content once generated (default is true)

​
auto_video_publish_enabled
boolean

When true, automatically distribute video content once generated (default is true)

​
avatar_url
string<uri>

The project's avatar URL

Maximum string length: 2048
​
pause_after_title_segments_seconds
number
Required range: 0 <= x <= 3
​
pause_after_segments_seconds
number
Required range: 0 <= x <= 3
​
time_zone
string

The project time zone (IANA time zone name)

​
environment
enum<string> | null
Available options:
production,
staging

Response

200 - application/json

successful

​
id
integer

Unique identifier for the object

​
name
string

The project name

​
language
string

The default language of the project (ISO 639-1 code with optional region, e.g., en_GB)

Pattern: ^[a-z]{2}(_[A-Z]{2})?$
​
language_data
object

Additional language metadata for the project

​
environment
enum<string> | null
Available options:
production,
staging
​
logo_color
string | null
​
content_total_count
integer
​
content_updated
string<date-time> | null
​
title
object
​
summary
object | null
​
body
object
​
background_track
object | null
​
auto_publish_enabled
boolean

When true, automatically distribute content once generated (default is true)

​
auto_video_publish_enabled
boolean

When true, automatically distribute video content once generated (default is true)

​
time_zone
string

The project time zone (IANA time zone name)

​
avatar_url
string<uri> | null

The project's avatar URL

Maximum string length: 2048
​
pause_after_title_segments_seconds
number
Required range: 0 <= x <= 3
​
pause_after_segments_seconds
number
Required range: 0 <= x <= 3
​
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)