Skip to main content
POST
/
api
/
agent
/
shorts
Generate short-form video
curl --request POST \
  --url https://www.citedy.com/api/agent/shorts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "avatar_url": "<string>",
  "article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resolution": "480p",
  "aspect_ratio": "9:16",
  "speech_text": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "generating",
  "video_url": "<string>",
  "credits_charged": 1,
  "estimated_seconds": 2
}

Authorizations

​
Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
​
prompt
string
required
Required string length: 10 - 2000
​
avatar_url
string<uri>
required
​
duration
enum<integer>
required
Available options:
5,
10,
15
​
article_id
string<uuid>

Optional article ID. When provided, shorts_video_url is saved to article metadata on completion.

​
resolution
enum<string>
default:480p
Available options:
480p,
720p
​
aspect_ratio
enum<string>
default:9:16
Available options:
9:16,
16:9,
1:1
​
speech_text
string
Required string length: 5 - 1000

Response

Generation accepted. Poll GET /api/agent/shorts/{id} with the same Authorization: Bearer <AGENT_API_KEY> header for status.

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
generating
​
video_url
string | null
required
​
credits_charged
integer
required
Required range: x >= 0
​
estimated_seconds
integer
required
Required range: x >= 1