Start a short clip from a description

post/creative/videos

Start a short clip from a description. A clip takes minutes: the answer is a running generation; read it until it is ready, and the clip is then in the asset library as an AI-generated draft waiting for review.

Before you call

Credential: Authorization: Bearer $KEY
Scope: files:write
Mcp: rivier_creative_video_generate
Graphql: Mutation.filesCreativeVideo
Sdk: files.creative.video
Cli: files creative video

Request bodyapplication/json, required

promptstringrequired
What the clip should show. At most 2000 characters.
purposestring
At most 80 characters.
modelIdstring
At most 80 characters.
useBrandKitboolean

Responses

202application/json
Success
- idstring (uuid)required
- kindstringrequired
  One of: image, video.
- statestringrequired
  One of: running, ready, refused, failed.
- promptstringrequired
- sentPromptstringrequired
- purposestring or nullrequired
- aspectstring or nullrequired
- seednumber or nullrequired
- assetIdstring (uuid) or nullrequired
- messagestring or nullrequired
- createdBystringrequired
- createdAtstringrequired
- updatedAtstringrequired
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/creative/videos' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "prompt": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown