Skip to main content
PUT

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

project id

Body

application/json
​
name
string

The project name

​
description
string | null

A short description of the publication, used by the AI agent and AI assistant surfaces.

Maximum string length: 1000
​
language
object
​
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)

​
generate_audio
boolean

When false, new content is prepared and indexed without audio generation unless content generate_audio is provided. Changing it affects future content only (default is true)

​
integration_import_content_from
string<date-time> | null

New content published before this time (inclusive cutoff) isn't imported by RSS feeds, Ghost and Magic Embed. Other content creation isn't affected. Changing it doesn't affect existing content (default is null, no restriction)

​
integration_generate_audio_from
string<date-time> | null

Audio is generated only for new RSS feed, Ghost and Magic Embed content published at or after this time, earlier content is prepared and indexed without audio. Other content creation isn't affected. Changing it doesn't affect existing content (default is null, no restriction)

​
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
string | null
​
logo_color
string | null

Response

200 - application/json

successful

​
id
integer

Unique identifier for the object

​
name
string

The project name

​
description
string | null

A short description of the publication, used by the AI agent and AI assistant surfaces.

Maximum string length: 1000
​
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,
archived
​
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)

​
generate_audio
boolean

When false, new content is prepared and indexed without audio generation unless content generate_audio is provided. Changing it affects future content only (default is true)

​
integration_import_content_from
string<date-time> | null

New content published before this time (inclusive cutoff) isn't imported by RSS feeds, Ghost and Magic Embed. Other content creation isn't affected. Changing it doesn't affect existing content (default is null, no restriction)

​
integration_generate_audio_from
string<date-time> | null

Audio is generated only for new RSS feed, Ghost and Magic Embed content published at or after this time, earlier content is prepared and indexed without audio. Other content creation isn't affected. Changing it doesn't affect existing content (default is null, no restriction)

​
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)