Authoring

Plan a creative video

Build a free, plan-aware art-direction plan before authoring project JSON. The response includes scene roles and timing, style/layout directions, creative-library and stock-media queries, variation seeds, recent-asset exclusions, and the fallback workflow used when no complete template fits.

This endpoint does not enqueue a render or consume credits.

post/api/render/creative-plan/api-key

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/render/creative-plan/api-key
  • Auth: API key in header x-api-key

Request body

briefstring required

What the video should communicate, for whom, and the desired outcome.

variationMode'consistent' | 'fresh' | 'explore'

Stable repeatable output, one new direction, or 2-5 materially different directions.

exploreCountinteger
aspectRatio'16:9' | '9:16' | '1:1' | '4:5' | 'custom'
durationnumber

Desired final duration. The response caps it to the caller's plan.

stylestring

Built-in style-pack id or auto.

motionIntensity'restrained' | 'balanced' | 'energetic'
preferredMedia'image' | 'video' | 'mixed'
recentAssetSlugsstring[]

Recently used creative-library slugs to exclude from fresh or explore work.

Response

Creative plan generated

creativePlanVersionstring required
schemaVersionstring
sourceOfTruthstring
planLimitsobject
requestobject required
variationobject required
searchQueriesobject
exclusionsstring[]
directionsobject[] required

One direction for consistent/fresh or 2-5 materially different directions for explore.

creativeWorkflowobject required

Template selection, no-exact-match fallback, anti-repetition, build-order and quality-gate rules.

nextActionsstring[] required
warningsstring[]

Example response

{
  "creativePlanVersion": "1.0.0"
}

Changes

No recorded changes to this operation across all 1 revision of this API.