Skip to main content
POST
Generate shorts script

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
topic
string
required
Required string length: 3 - 500
product_id
string<uuid>
article_id
string<uuid>

Optional article ID. When provided, shorts_title, shorts_hashtags, and shorts_script are saved to article metadata.

duration
enum<string>
default:short
Available options:
short,
long
requested_duration_seconds
enum<integer>

Exact target runtime in seconds. When present, this controls the script word budget.

Available options:
5,
10,
15
style
enum<string>
default:hook
Available options:
hook,
educational,
cta
language
string
default:en
Required string length: 2 - 5

Response

Script generated

script
string
required

Voiceover script text (also used as post description)

title
string
required

Catchy video title (max 100 chars), used as YouTube/TikTok title

hashtags
string[]
required

2-3 relevant hashtags with # prefix

Maximum array length: 5
word_count
integer
required
Required range: x >= 1
estimated_duration_sec
integer
required
Required range: x >= 1
parts
string[]
required
Minimum array length: 1
credits_charged
integer
required
Required range: x >= 0