Jobs

Generate clips

Complete clipping workflow for an owned recording. PrismClip prepares transcripts and visual scenes, selects up to count clips matching instruction, prepares framing, captions and cloud renders internally. Set render=false to review candidate moment sets first. Poll get_workflow for progress, candidates and authenticated media URLs. Stable Idempotency-Key prevents duplicate workflows.

post/api/v1/projects/{projectId}/clips

Request

  • Base URL: https://prismclip.com
  • URL: https://prismclip.com/api/v1/projects/{projectId}/clips
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

Owned project ID

Headers

Idempotency-Keystring required

Stable retry key; changed requests require a new key

Request body

instructionstring required

Requested topics, answers, scenes, or editorial preferences; empty selects general highlights

evidence_mode'speech' | 'visual' | 'mixed' required

Speech uses the transcript only; visual skips transcription; mixed prepares both. Audio sources use speech.

countinteger required
min_duration_secondsinteger required
max_duration_secondsinteger required
renderboolean required

False returns candidate moment sets for review before rendering

aspect_ratio'original' | '16:9' | '1:1' | '9:16' required
framing'full-frame' | 'background-fill' | 'tracked' required
captionsboolean required
caption_style'progressive' | 'page' | 'scroll' required
caption_size'standard' | 'large'
style_preset_idstring

Owned saved preset ID, or default

tracking_motion'cut' | 'fast-pan' | 'smooth-follow' required
transition'hard-cut' | 'fade' required
intro_enabledboolean
outro_enabledboolean
audio_motion'waveform' | 'bars' | 'pulse'
audio_background_colorstring
audio_waveform_colorstring

Response

Durable workflow state; poll get_workflow until terminal.

Changes

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