content_performance_list
Read Published Content Performance
Read bounded existing provider-reported engagement in the selected workspace, sorted by views. Filters by format, account and publication window. Returns lifetime counters with capture/check times, availability, and saved Project/export lineage when known. Does not import new data, start monitoring or infer attributable leads, sales or revenue.
輸入參數limit必填range必填format必填offset必填search必填platform必填workspaceId必填connectionIds必填
video_storyboard_create
Plan an Approved Video Script
Create a vertical video storyboard for the user-approved script in an existing project. Spends planning credits; returns scene narration, factual review notes, references and the production credit estimate. Does not generate images or animate video. Existing account access applies.
輸入參數script必填voice_idprojectId必填series_idvideo_modelworkspaceId必填story_kit_idvisual_stylecharacter_idsidempotencyKey必填image_model_idcaption_style_id另有 7 個
video_storyboard_get
Review Video Storyboard
Read one authorized storyboard revision, its scene and reference previews, estimate, approvals and bounded polling guidance. Refreshes signed previews. Complete means the editable timeline is assembled; use exports_start and exports_list for a downloadable MP4.
輸入參數projectId必填revisionId必填workspaceId必填
video_storyboard_revise
Revise Selected Storyboard Scenes
Create a new immutable draft from a known revision with selected scene, character or model changes. Preserves other scene definitions; requires review and production approval again. Does not generate media or overwrite an approved revision.
輸入參數projectId必填revisionId必填video_modelworkspaceId必填scene_updatesidempotencyKey必填image_model_idcharacter_updatesstyle_anchor_prompt
video_storyboard_approve
Approve Storyboard Previews
After showing the storyboard and its credit estimate, confirmApproved=true starts production of reference images and scene keyframes. Spends existing credits. This stage produces reviewable previews, not animated videos.
輸入參數projectId必填revisionId必填workspaceId必填idempotencyKey必填confirmApproved必填
video_assets_approve
Approve Previews and Produce Video
After the user approves the generated previews and animation cost, confirmApproved=true starts scene animation, narration and editable timeline assembly. Can replace the project's generated timeline and spend existing credits. Follow the revision and then export the finished project.
輸入參數projectId必填revisionId必填workspaceId必填idempotencyKey必填confirmApproved必填
video_storyboard_asset_regenerate
Regenerate Selected Storyboard Preview
Replace the identified preview after user approval of the new credit cost. A scene_keyframe changes one keyframe; a character_anchor refreshes its dependent keyframes; a style_anchor refreshes every keyframe. Preserves unaffected previews. Does not regenerate an already finished video shot.
輸入參數projectId必填asset_type必填revisionId必填scene_indexworkspaceId必填character_ididempotencyKey必填confirmRegeneration必填
recording_sets_list
List Synchronized Recordings
Read bounded camera and screen recording sets in the selected workspace with status, duration and alignment warnings.
輸入參數limit必填offset必填status必填workspaceId必填
recording_sets_get
Inspect Synchronized Recording
Read one camera and screen recording set, its primary speaker, content windows, alignment and warnings. Separate audio-only tracks are not supported.
輸入參數workspaceId必填recordingSetId必填
recording_sets_create
Create Synchronized Recording
Create an empty camera and screen recording set in the explicit workspace. Requires existing recording-set access; does not import files or start processing.
輸入參數name必填workspaceId必填idempotencyKey必填
recording_sets_track_attach
Attach Camera or Screen Recording
Attach one existing authorized video asset as a camera or screen track. Specify the main speaker when known; alignment happens during finalization.
輸入參數role必填asset_id必填is_primary必填workspaceId必填idempotencyKey必填recordingSetId必填participant_name必填participant_label必填
recording_sets_finalize
Synchronize Recording Tracks
Finalize the collected camera and screen tracks and queue analysis. Can spend existing transcription credits. Inspect returned alignment and warnings before clipping.
輸入參數workspaceId必填idempotencyKey必填recordingSetId必填
recording_sets_clips_create
Clip a Synchronized Recording
Produce a batch from a ready synchronized camera and screen recording, with optional clip count, maximum duration and caption look. Preserves readable screen context through the existing layout pipeline. Can spend existing credits; follows clips_get with the returned batch_id.
輸入參數clipCount必填workspaceId必填captionThemeId必填idempotencyKey必填recordingSetId必填maxDurationSeconds必填
clip_share_get
Read Clip Review Link
Read whether the source video's clip share page is public and which clips are visible. Does not publish content.
輸入參數assetId必填workspaceId必填
clip_share_publish
Publish a Clip Review Link
Make the selected source video's clip page public with reviewed title, description and explicit download permission. Requires confirmPublicSharing=true from the user. Returns the verified public URL; no social network post is made.
輸入參數title必填assetId必填description必填workspaceId必填allowDownloads必填idempotencyKey必填confirmPublicSharing必填
clip_share_unpublish
Unpublish a Clip Review Link
Disable public access to the selected clip page. Changes an existing publication; preserves private projects and exports.
輸入參數assetId必填workspaceId必填idempotencyKey必填
clip_share_visibility_set
Set Shared Clip Visibility
Show or hide one identified clip on an existing public review page after explicit user confirmation. Preserves the other clips and private project data.
輸入參數clipId必填assetId必填visibility必填workspaceId必填idempotencyKey必填confirmPublicSharing必填
projects_list
List Projects
List the user's BlitzReels projects with status, duration, and basic metadata.
輸入參數limitoffsetsearchstatusworkspaceId
Get details for one BlitzReels project, including timeline summary, clips, captions, and current recovery state with an app path and next read tool.
輸入參數projectId必填
projects_inspect
Inspect Project
Read bounded project context for editing, including timeline items, media assets, transcripts, captions, and stable IDs.
輸入參數modesearchprojectId必填assetLimitassetOffsettimelineLimittimelineOffsettranscriptLimitcaptionWordLimittranscriptOffsetcaptionWordOffset
List exports with render status and progress. Completed exports include a signed download URL. Pass exportId to return one export.
輸入參數limitoffsetexportIdprojectIdworkspaceId
exports_caption_track_get
Read Export Caption Track
Read a WebVTT caption track from the completed export's immutable canonical speech snapshot, preserving the actual export trims. Returns unavailable for older exports or unverified speech; never fabricates captions from titles or current edited timelines.
輸入參數exportId必填workspaceId必填
editor_asset_replace
editor asset replace
Replace one shot's media asset while preserving the other timeline items. Revision checked; dryRun previews by default. Requires a current editor snapshot and an asset in the same workspace.
輸入參數dryRun必填itemId必填assetId必填projectId必填workspaceId必填idempotencyKey必填expectedRevision必填
editor_audio_set
editor audio set
Adjust one item's volume and audio fades. Revision checked; dryRun previews by default. Preserves the rest of the project.
輸入參數dryRun必填itemId必填volume必填projectId必填workspaceId必填fadeInSeconds必填fadeOutSeconds必填idempotencyKey必填expectedRevision必填
editor_text_set
editor text set
Create or revise one title or text overlay with explicit timing. Revision checked; dryRun previews by default. This edits project text, not spoken audio or captions.
輸入參數spec必填text必填dryRun必填itemId必填textKind必填projectId必填workspaceId必填startSeconds必填idempotencyKey必填durationSeconds必填expectedRevision必填
editor_crop_set
editor crop set
Adjust the crop of one existing source view after a layout has been applied. Revision checked; dryRun previews by default. Preserves the other shots.
輸入參數crop必填dryRun必填itemId必填projectId必填workspaceId必填idempotencyKey必填expectedRevision必填
editor_assets_insert
editor assets insert
Insert a workspace image, generated shot or audio asset at an explicit project time. Revision checked; dryRun previews by default.
輸入參數dryRun必填assetId必填projectId必填layerIndex必填workspaceId必填startSeconds必填idempotencyKey必填durationSeconds必填expectedRevision必填
editor_items_move
editor items move
Move selected timeline items to explicit times and layers. Revision checked; dryRun previews by default.
輸入參數items必填dryRun必填projectId必填workspaceId必填idempotencyKey必填expectedRevision必填
editor_items_remove
editor items remove
Remove selected timeline items and, if requested, their linked captions. Revision checked; dryRun previews by default. The saved action can be undone.
輸入參數dryRun必填itemIds必填projectId必填workspaceId必填idempotencyKey必填expectedRevision必填removeAssociatedCaptions必填
editor_snapshot_get
Read Editor Snapshot
Read the current revision, stable timeline IDs, captions, style and bounded media context before a precise revision. Signed media links are refreshed by reading again.
輸入參數limit必填offset必填projectId必填workspaceId必填expectedRevision必填
editor_history_list
List Edit History
Read up to 50 saved edit actions, their labels and undo state. Does not restore or change the project.
輸入參數limit必填projectId必填workspaceId必填
editor_edit_undo
Undo Saved Edit
Restore one saved editor action at the expected current revision. Requires the action ID from edit history and an idempotency key. Existing project data is changed.
輸入參數actionId必填projectId必填workspaceId必填idempotencyKey必填expectedRevision必填
clips_candidates_list
Review Clip Candidates
Read existing suggested moments with source ranges, hooks, transcript excerpts and thumbnails before producing videos. Results are bounded; this does not generate suggestions or render clips.
輸入參數limit必填offset必填assetId必填workspaceId必填
captions_words_list
Read Caption Words
Read bounded editable caption words and stable word IDs for one project, optionally matching text.
輸入參數limit必填offset必填matchText必填projectId必填workspaceId必填
captions_words_correct
Correct Caption Words
Replace selected caption words by their stable IDs. Preserves timing and the other captions; this does not change the spoken audio.
輸入參數updates必填projectId必填workspaceId必填idempotencyKey必填
video_feedback_save
Save Video Quality Feedback
Save the user's 1-5 rating and optional quality category/comment against one completed playable video export. Replaces that user's previous feedback for this export; does not change accepted clips or defaults. Requires the feedback storage migration to be installed.
輸入參數rating必填comment必填category必填exportId必填workspaceId必填idempotencyKey必填
captions_source_prepare
Prepare Source Captions
Restore editable project captions from the selected source's completed canonical transcript. Keeps the full recording and avoids duplicate captions on identical retries. Requires source transcription first; no-speech is an explicit successful state.
輸入參數assetId必填projectId必填workspaceId必填idempotencyKey必填
clips_recover
Recover Missing Clips
Recover a terminal batch's missing clip count through the persisted recovery workflow. Preserves accepted clips and returns the recovery batch ID. Can spend existing account credits; retry with the identical idempotency key.
輸入參數batchId必填workspaceId必填idempotencyKey必填targetClipCount必填
workspaces_list
List Workspaces
List bounded workspaces the connected user belongs to, with their role and default workspace. Selecting a workspace for the task does not change account defaults.
輸入參數limit必填offset必填
workspace_context_get
Read Business Context
Read the selected workspace's business audience, offer, reviewed brand defaults, protected vocabulary, editorial purpose, language, avoided terms, pronunciation notes and existing account entitlements. Returns current export quality and watermark constraints without pricing or upgrade links.
輸入參數workspaceId必填
workspace_context_save
Save Reviewed Business Context
Save the user-reviewed business name, audience, offer, conversion goal, tone, protected vocabulary and editorial preferences for the selected workspace. Requires workspace settings permission and confirmReviewed=true; changes future assistant guidance, preserving existing projects. Pronunciation notes guide script drafting; they do not retime or replace source speech.
輸入參數tone必填offer必填audience必填brandName必填workspaceId必填conversionGoal必填idempotencyKey必填protectedWords必填confirmReviewed必填editorialPreferences必填
workspace_brand_scan
Inspect Supplied Business Website
Start extracting a brand profile from the exact website the user supplied and authorized to scan. Saves a draft profile for review; does not apply discovered fields to existing videos. Can spend existing account credits.
輸入參數websiteUrl必填workspaceId必填idempotencyKey必填confirmAuthorizedToScan必填
workspace_brand_scan_get
Read Website Brand Draft
Read one authorized website extraction run and its draft business profile. Show the extracted fields to the user for review before saving them as defaults.
輸入參數runId必填workspaceId必填
List media files in user's library (videos, audio, images)
輸入參數limitoffsetassetTypeworkspaceId
media_transcript_get
Get Media Transcript
Get transcript summary metadata or a bounded window of transcription segments for a video asset.
輸入參數modelimitoffsetassetId必填
projects_create
Create Project
Create a new private BlitzReels video project.
輸入參數name必填seriesIdframeRateaspectRatiodescriptionworkspaceIdidempotencyKey
media_upload_file
Upload File
Import a video, audio, or image file from ChatGPT into the BlitzReels media library. Use this for a file the user attached or picked, and for an image ChatGPT generated in this conversation that the user wants to keep, animate, or edit in BlitzReels.
輸入參數file必填nameprojectIdworkspaceId
media_import_url
Import Media From URL
Import video, audio, images, fonts, SVG or JSON from a direct URL into the private workspace library. Returns a durable asset ID and verified contentHashSha256. Fonts, SVG and JSON are limited to 25 MiB.
輸入參數url必填nameprojectIdworkspaceIdautoTranscribeautoSuggestShortscontentHashSha256autoProcessEnabledautoDescribeAfterTranscribe
media_upload_start
Start Media Upload
Get a presigned URL for direct file upload (for large files)
輸入參數fileName必填projectIdcontentType必填workspaceId
media_upload_finish
Finish Media Upload
Verify uploaded bytes and save a reusable workspace asset after presigned PUT. Returns contentHashSha256, fileSizeBytes and mimeType.
輸入參數fileName必填projectIdstorageKey必填contentType必填workspaceIdfileSizeBytes必填autoTranscribeautoSuggestShortscontentHashSha256autoProcessEnabledautoDescribeAfterTranscribe
media_import_inspect
Inspect Import URL
Inspect a user-provided public social-video or Google Drive URL and return available import metadata without creating media.
輸入參數url必填
media_import_scan_page
Scan Page For Video
Scan a user-controlled public page and return an importable video URL found on it without creating media.
輸入參數url必填confirmAuthorizedToScan
clips_presets_list
List Clip Presets
List available clip batch presets and their clipping/caption defaults.
無需輸入參數。
captions_themes_list
List Caption Themes
List built-in caption looks and saved caption themes available to a workspace.
輸入參數workspaceIdincludeSavedThemesincludeBuiltInLooks
media_narration_get
Read narration timing
Read retained voice inputs, measured duration, audio SHA-256 and word timing. Defaults to 200 words, maximum 500; offset selects the next page. take is null for audio without a retained narration take.
輸入參數limit必填offset必填assetId必填workspaceId
media_assets_get
Get Media Asset
Get metadata and processing state for one media-library asset without returning transcript segments.
輸入參數assetId必填
media_assets_preview
Preview Media Asset
Return one bounded JPEG as MCP image content for visual inspection. Images use the stored visual; videos use the existing thumbnail.
輸入參數assetId必填maxDimension
media_folders_list
List Media Folders
List one bounded level of media-library folders and direct asset counts.
輸入參數limitoffsetworkspaceIdparentFolderId
media_folders_create
Create Media Folder
Create one media-library folder in a workspace and return a retry-safe mutation receipt.
輸入參數name必填iconTypedescriptionworkspaceIdidempotencyKeyparentFolderId
media_assets_update
Update Media Asset
Rename one media asset, edit its description, move it to a folder, or change B-roll eligibility. Provide at least one of name, description, folderId, or allowUsingAsBroll.
輸入參數nameassetId必填folderIddescriptionidempotencyKeyallowUsingAsBroll
media_upscale_estimate
Estimate Video Upscale
Estimate ByteDance upscale eligibility and credits for one stored video. Does not spend credits or queue a job. Call this before media_upscale.
輸入參數assetId必填projectIdworkspaceIdtargetResolution必填
media_upscale
Upscale Video
Queue a ByteDance upscale of one stored video asset to 1080p or 4k. Call media_upscale_estimate first. Spends AI credits and returns a new pending media asset to poll with media_assets_get.
輸入參數assetId必填projectIdworkspaceIdidempotencyKeytargetResolution必填
Create a private BlitzReels clip batch from an existing asset or a user-provided video URL. Supports public social videos, Google Drive, and direct media URLs.
輸入參數urlassetIdseriesIdclipCountselectionworkspaceIdclipPresetIdcaptionThemeIddurationBoundsidempotencyKeyautoTrimSilencecreateSharePage另有 1 個
Get status, generated clips, render counts, and download links for a BlitzReels clip batch.
輸入參數batchId必填workspaceId
clip_batches_delete
Delete Clip Batch
Preview or delete a terminal clip batch. Dry-run is the default; real deletion requires explicit confirmation, retention choice, workspace delete permission, and an idempotency key.
輸入參數dryRunbatchId必填retentionworkspaceIdconfirmDeleteidempotencyKey必填
clips_status_get
Refresh Clip Progress
Read one existing batch's progress, ready clips and renewed signed links without opening or remounting a review widget. Safe for bounded polling and widget refresh; does not recreate or repair clips.
輸入參數batchId必填workspaceId
List bounded managed clips from the selected source or project with their current workflow state.
輸入參數limitoffsetstatusassetIdprojectIdworkspaceId
clips_inspect
Inspect One Clip
Read one managed clip's selected source range, project, workflow state and delivery information.
輸入參數clipId必填workspaceId
clips_reselect
Revise Selected Moment
Replace the source moment for one managed clip using a verified suggestion or explicit time range. Can spend existing account credits. Preserves the other clips; read current state before retrying.
輸入參數clipId必填lookIdendSecondslayoutModeworkspaceIdstartSecondssuggestionIdselectionMode必填idempotencyKey必填captionsEnabledcontentTypeHintmaxDurationSeconds另有 1 個
clips_repair
Repair One Clip Layout
Request a layout repair for one managed clip, such as preserving a screen demo or moving captions away from faces. Changes that clip's project; preserves the other clips.
輸入參數clipId必填repairModeworkspaceIdidempotencyKey必填
clips_export
Export One Clip
Render one managed clip at an existing-account-supported quality. Returns persisted export state; inspect until the accepted delivery file is ready. Can spend existing account credits.
輸入參數clipId必填formatresolutionworkspaceIdidempotencyKey必填coverFrameSeconds
captions_look_apply
Apply Caption Look
Apply a verified caption look to one project. Preserves word overrides unless clearWordOverrides=true. Existing captions are restyled; spoken audio is preserved.
輸入參數lookId必填projectId必填workspaceIdidempotencyKey必填clearWordOverrides
visuals_apply
Apply visual presets
Create or update up to 20 visual blocks in one call after edit timing is settled. Presets: broll-headline, steps, quote, end-screen, key-number, before-after, screenshot-focus, chapter. IDs are scoped to the project; repeating an ID updates it. Asset IDs must belong to the workspace. Atomic, undoable; dryRun validates without writing. Returns IDs and revision. No generation pass.
輸入參數items必填dryRun必填projectId必填idempotencyKey必填expectedRevision必填
update_timeline_clip
Update Timeline Clip
Update one timeline item's start, duration, trim, layer, ignored state, or blurred background. Provide at least one field to update besides timelineItemId.
輸入參數ignoredprojectId必填layerIndexstartSecondsidempotencyKey必填timelineItemId必填trimEndSecondsdurationSecondsexpectedRevisiontrimStartSecondsblurredBackground
batch_update_timeline_clips
Batch Update Timeline Clips
Update timing, trim, layer, or state for up to 100 timeline items in one sequence transaction.
輸入參數updates必填projectId必填idempotencyKey必填expectedRevision
mute_clip_audio
Mute Clip Audio
Set one timeline media item's volume to zero.
輸入參數projectId必填idempotencyKey必填timelineItemId必填expectedRevision
delete_timeline_items
Delete Timeline Items
Preview or delete up to 100 timeline items and optionally remove linked captions.
輸入參數dryRunprojectId必填confirmDeleteidempotencyKeytimelineItemIds必填expectedRevisionremoveAssociatedCaptions
add_text_overlay
Add Title Card
Add an opening title card (hook) or generic text overlay to a project timeline. Defaults to classic white: black text on a white card.
輸入參數kindnamesizetext必填themeprojectId必填layerIndexstartSecondsidempotencyKey必填durationSecondsexpectedRevision
add_transition
Add Transition
Add a timed transition effect, optionally attached to one timeline item and paired with sound.
輸入參數nameeasingpresetintensityprojectId必填includeSfxlayerIndexstartSeconds必填idempotencyKey必填timelineItemIddurationSecondsexpectedRevision
timeline_media_add
Add Media To Timeline
Place an image or video asset onto a BlitzReels project timeline at a timestamp, including B-roll and static images.
輸入參數assetId必填projectId必填layerIndexstartSecondsallowDuplicatepositionPresetanimationPresetdurationSecondsplacementIntent
timeline_audio_add
Add Audio To Timeline
Place an audio asset onto a BlitzReels project timeline at a timestamp for voiceover, music, or sound.
輸入參數loopvolumeassetId必填projectId必填startSecondsfadeInSecondsfadeOutSecondsdurationSeconds
exports_start
Start Export
Export a BlitzReels video or native carousel and return export and job IDs for status checks.
輸入參數formatprojectId必填resolutionidempotencyKeyexpectedRevisioncoverFrameSeconds
generation_options_list
List Generation Options
List the models, defaults, limits, and credit costs available for one generation kind before queueing it. Video duration is an enum per model (durations_seconds), not a min-max range.
輸入參數kind必填
generation_image_create
Generate Image
Queue an AI image generation into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
輸入參數modelprompt必填folderIdresolutionaspectRatioworkspaceIdenhancePromptidempotencyKeyreferenceAssetIds
generation_video_create
Generate Video
Queue video generation, image animation, source-video editing or character replacement into the media library. Editing accepts referenceVideoAssetIds and transformation controls, including original-audio preservation. Spends AI credits and returns a job readable with generation_jobs_get.
輸入參數seedmodelprompt必填folderIdproviderprovenanceresolutionaspectRatioworkspaceIdenhancePromptgenerateAudiosourceAssetId另有 8 個
generation_voiceover_create
Generate Voiceover
Queue a text-to-speech voiceover into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
輸入參數text必填speedvoiceIdvoiceStyleworkspaceIdidempotencyKey
generation_music_create
Generate Music
Queue a background music track into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
輸入參數moodpromptworkspaceIdidempotencyKeydurationSeconds
generation_sound_create
Generate Sound Effect
Queue a sound effect into the BlitzReels media library. Spends AI credits and returns a job to poll with generation_jobs_get.
輸入參數loopprompt必填workspaceIdidempotencyKeydurationSecondspromptInfluence
generation_faceless_create
Generate Faceless Video
Turn a script into a full faceless video project: scene plan, generated visuals, optional voiceover, captions, music, and sound. Spends AI credits and returns a job to poll with generation_jobs_get.
輸入參數script必填voiceIdseriesIdstoryKitIdvideoModelprojectNamevisualStyleworkspaceIdimageModelIdcaptionStyleIdidempotencyKeyplannerModelId另有 6 個
generation_jobs_get
Get Generation Job
Read generation status, failure category, ledger-confirmed credit outcome, prompt history and compatible model alternatives. Alternatives report duration splits, estimated credits and unverified acceptance. reviewUrl opens prompt review and support escalation. Completed jobs include a media ID and download URL.
輸入參數jobId必填workspaceId
generation_jobs_cancel
Cancel Generation Job
Request cancellation of the identified queued or running generation. Work already performed can consume credits; cancellation does not establish a refund.
輸入參數jobId必填workspaceId
generation_plan_brief
Get Generation Plan Brief
Read a generation brief from rawPrompt. Source-video edits return execution for generation_video_create with required assets and transformation controls. New scenes return an authoring grammar and planJsonSchema for generation_plan_validate. The video creation provenance.originalRequest field retains rawPrompt when supplied. This read does not generate media or spend credits.
輸入參數genrerawPromptaspectRatiovisualStylevideoModelIdtargetDurationSeconds
generation_plan_validate
Validate Generation Plan
Validate a self-authored generation plan against the schema and the target model's real capabilities before execution. Returns directive errors to fix and revalidate; only a valid plan is executable.
輸入參數plan必填
characters_list
List Reusable Characters
List bounded reusable characters with identity, voice, facts, and image-reference metadata.
輸入參數limitoffsetworkspaceIdincludeArchived
characters_get
Get Reusable Character
Inspect one reusable character and its ordered reference-image set before planning a story.
輸入參數characterId必填workspaceId
characters_apply
Apply Reusable Character
Create or update a reference-based character for repeatable faceless story generation.
輸入參數name必填typespeciesstoryFactscharacterIdworkspaceIddefaultVoiceIdidempotencyKey必填defaultVoiceStylereferenceAssetIdscanonicalDescriptionconfirmLikenessConsent另有 2 個
story_kits_list
List Story Kits
List bounded reusable Story Kits that bind characters, locations, style, facts, and narrator voice.
輸入參數limitoffsetworkspaceId
story_kits_get
Get Story Kit
Inspect one Story Kit and its revision before generating or updating a story.
輸入參數storyKitId必填workspaceId
story_kits_apply
Apply Story Kit
Create or update a Story Kit with optimistic concurrency and an idempotent mutation receipt.
輸入參數name必填factslocationsstoryKitIddescriptionvisualStyle必填workspaceIdcharacterIdsidempotencyKey必填expectedRevisionnarratorCharacterIdstyleReferenceAssetIds
List optional Series with bounded counts and cover previews.
輸入參數limit必填offset必填workspaceId必填
Read a Series identity, creative defaults and revision.
輸入參數seriesId必填workspaceId必填
series_content
List Series Content
List sources or projects in a Series. Null seriesId lists standalone content. sourceId filters projects by clip origin.
輸入參數kind必填limit必填offset必填search必填seriesId必填sourceId必填workspaceId必填
Create or replace a Growth+ Series identity and defaults. defaultCreationMode selects podcast branding or faceless Story Kit defaults; membership stays mixed. Updates require expectedRevision. Existing content keeps its settings.
輸入參數name必填seriesId必填storyKitId必填description必填logoAssetId必填workspaceId必填coverAssetId必填captionThemeId必填idempotencyKey必填expectedRevision必填defaultCreationMode必填
series_assign
Assign Series Content
Assign, move or detach one source or project using expectedSeriesId. Moving a source does not move existing clips or change branding.
輸入參數kind必填seriesId必填contentId必填workspaceId必填idempotencyKey必填expectedSeriesId必填
series_delete
Delete Series
Delete the Series container at an expected revision and detach its content. Sources, projects and exports are preserved.
輸入參數seriesId必填workspaceId必填idempotencyKey必填expectedRevision必填
customer_measurements_list
Read customer outcomes
Read observed link clicks and self-reported outcomes in a bounded window up to 90 days. Counts are not verified conversions. Provider engagement remains separate.
輸入參數to必填from必填limit必填offset必填workspaceId必填
customer_link_apply
Save customer tracking link
Create a stable HTTPS tracking link or revise its label/enabled state. Destination and content association are immutable. Revisions require expectedRevision; null creates.
輸入參數id必填label必填postId必填enabled必填seriesId必填projectId必填destination必填workspaceId必填idempotencyKey必填expectedRevision必填
customer_outcome_apply
Save self-reported outcome
Record or revise leads, sales, revenue or another measured outcome with source, time and explicit attribution. Revision history is retained; voided records remain visible. No conversion is inferred from clicks.
輸入參數id必填kind必填unit必填value必填postId必填source必填voided必填seriesId必填projectId必填occurredAt必填attribution必填workspaceId必填另有 2 個
learning_quote
Inspect learning evidence
Read bounded Series feedback, metrics, clicks and self-reported outcomes with current owner direction and a cost quote. No model call. Missing or incomparable evidence remains explicit.
輸入參數to必填from必填goal必填language必填seriesId必填workspaceId必填maxVariations必填
learning_start
Propose content variations
Start one bounded model call from a reviewed learning quote and approved credits/USD cap. Saves cited lessons and up to five experimental briefs in the shared brain. Idempotent; never publishes or promises performance.
輸入參數to必填from必填goal必填maxUsd必填quoteId必填language必填seriesId必填maxCredits必填workspaceId必填maxVariations必填idempotencyKey必填expectedEvidence必填
learning_get
Read learning job
Read frozen evidence, exact creative lineage, progress and saved lessons for a workspace learning job. Current owner direction overrides saved suggestions.
輸入參數jobId必填workspaceId必填
learning_control
Control learning job
Cancel a queued or running analysis, recover an unconfirmed dispatch by its existing identity, or deliver a retained result. Resume never repeats an uncertain model call and rejects changed owner direction.
輸入參數jobId必填action必填workspaceId必填
carousels_compile
Compile Carousel
Create or replace a carousel project from a slide document. Server owns chip layout, safezones, and exact export pixels.
輸入參數name必填stylelocaleslides必填platform必填series_idproject_idworkspaceIdclear_existingidempotencyKey必填
carousels_preview
Preview Carousel
Render and store private JPEG previews for the selected carousel slides. Replaces cached previews at deterministic storage keys; preserves the source project and slide document.
輸入參數chrome必填projectId必填workspaceIdslideIndexesidempotencyKey必填
carousels_get
Get Carousel Document
Read the carousel slot document and the named template catalog.
輸入參數projectId必填workspaceId
carousels_patch_slide
Patch Carousel Slide
Patch native slots/media or select a completed Remotion frame artifact and crop. Requires expectedRevision; identical keys replay.
輸入參數croplinesslotsprojectId必填slideIndex必填templateIdworkspaceIdmediaAssetIdidempotencyKey必填expectedRevision必填creativeArtifactId
carousels_expand_recipe
Expand Carousel Recipe
Turn a named recipe or a brief into compile-ready named-template slides. Expand never publishes and never invents metrics.
輸入參數namebriefofferlocaleproductaudienceplatformrecipeId必填workspaceId
carousels_migrate
Migrate Legacy Carousel
Rebuild a compile slot document from a legacy overlay carousel. Then patch slots like any compiled deck.
輸入參數projectId必填workspaceIdidempotencyKey必填
carousels_clone
Clone Carousel
Duplicate a carousel onto a new project. Copies slots. Icon and shot values may be pack filenames or asset:<media_asset_id>.
輸入參數nameprojectId必填workspaceIdidempotencyKey必填
publishing_connections_list
List Publishing Connections
List Instagram accounts connected through the BlitzReels UI for the authenticated workspace, including their connection status.
無需輸入參數。
publishing_instagram_schedule
Schedule Instagram Publish
Schedule a completed project export to Instagram. Optional includeAffiliateCta appends Try BlitzReels for free plus the Affonso tracking URL. Requires an active Instagram account connected in the BlitzReels UI.
輸入參數captionexportIdtimezoneprojectId必填trialReelshareToFeedconnectionIdscheduledFor必填affiliateCtaTextincludeAffiliateCtaaffiliateTrackingUrltrialGraduationStrategy
publishing_accounts_list
Read Connected Publishing Accounts
Read the supported accounts available through the existing workspace and provider access rules. Does not connect new accounts, publish, schedule or bypass provider review.
輸入參數limit必填offset必填workspaceId必填
publishing_video_schedule
Schedule Reviewed Video Publication
Schedule a selected existing video asset to explicit active YouTube, Instagram, Facebook, TikTok, LinkedIn or Threads accounts connected in the BlitzReels UI, using reviewed copy, privacy/consent choices, synthetic-media disclosure, time and timezone. Requires confirmPublish=true. Existing workspace permissions and provider access rules apply. A scheduled receipt is not proof of publication.
輸入參數captiontargets必填timezoneworkspaceId必填project_namescheduled_for必填confirmPublish必填idempotencyKey必填media_asset_id必填affiliate_cta_textinclude_affiliate_ctaaffiliate_tracking_url另有 1 個
publishing_post_get
Verify Video Publication
Read the current targets for one publishing receipt with scheduled/published state and verified remote URLs. Does not retry or publish a failed target.
輸入參數postId必填workspaceId必填
timeline_trim_preview
Preview Timeline Trim
Preview trimming or extending one timeline item without changing the project.
輸入參數projectId必填snapToFrame必填timelineItemId必填expectedRevision必填trimEndDeltaSeconds必填trimStartDeltaSeconds必填
timeline_trim_apply
Apply Timeline Trim
Trim or extend one timeline item at the expected project revision. Changes existing timeline state and returns a retry-safe receipt.
輸入參數projectId必填snapToFrame必填idempotencyKey必填timelineItemId必填expectedRevision必填trimEndDeltaSeconds必填trimStartDeltaSeconds必填
timeline_split_preview
Preview Timeline Split
Preview splitting one timeline item without changing the project.
輸入參數projectId必填snapToFrame必填splitAtSeconds必填timelineItemId必填expectedRevision必填
timeline_split_apply
Apply Timeline Split
Split one timeline item at the expected project revision. Changes existing timeline state and returns a retry-safe receipt.
輸入參數projectId必填snapToFrame必填idempotencyKey必填splitAtSeconds必填timelineItemId必填expectedRevision必填
carousels_slides_reorder
Carousel Slides reorder
Move one carousel slide to a new index. Replaces the existing slide order.
輸入參數to必填from必填projectId必填workspaceIdidempotencyKey必填
carousels_slides_remove
Carousel Slides remove
Remove one carousel slide and its content from the project.
輸入參數index必填projectId必填workspaceIdidempotencyKey必填
carousels_slides_insert
Carousel Slides insert
Insert one new carousel slide from a named template or copy an existing slide. Preserves existing slide content.
輸入參數index必填projectId必填templateIdsourceIndexworkspaceIdidempotencyKey必填
carousels_slides_undo
Carousel Slides undo
Restore the previous carousel document revision, replacing the current slide document.
輸入參數projectId必填workspaceIdidempotencyKey必填
carousels_save_theme
Carousel save theme
Save and activate the current carousel styling as a private theme; removes the oldest saved theme when the 40-theme limit is reached.
輸入參數name必填scopeprojectId必填workspaceIdidempotencyKey必填
carousels_apply_theme
Carousel apply theme
Replace this carousel's styling with an existing saved theme.
輸入參數themeId必填projectId必填workspaceIdidempotencyKey必填
carousels_delete_theme
Carousel delete theme
Delete one saved private carousel theme.
輸入參數themeId必填projectId必填workspaceIdidempotencyKey必填
carousels_save_template
Carousel save template
Save one carousel slide as a private template; removes the oldest saved template when the 40-template limit is reached.
輸入參數name必填scopeprojectId必填slideIndex必填workspaceIdidempotencyKey必填
carousels_apply_template
Carousel apply template
Replace one carousel slide with a saved private template.
輸入參數projectId必填slideIndex必填workspaceIdidempotencyKey必填savedTemplateId必填
carousels_delete_template
Carousel delete template
Delete one saved private carousel slide template.
輸入參數projectId必填workspaceIdidempotencyKey必填savedTemplateId必填
carousels_apply_brand
Carousel apply brand
Replace this carousel's styling with the workspace's saved brand theme.
輸入參數projectId必填workspaceIdidempotencyKey必填
clips_delivery_promote
Promote Reviewed Clip Export
Make one completed export the accepted delivery for a clip after explicit visual-QA confirmation. Replaces the delivery pointer and preserves earlier exports.
輸入參數clipId必填exportId必填workspaceIdidempotencyKey必填confirmVisualQa必填