Search documentation
Search pages, API reference sections, and guide headings.
Summary
This guide shows how to execute prompt runs against indexes, selected media items, and playground content, then inspect state and results.
Pick the right target type
- Use
indexfor whole-collection processing. - Use
videosfor selected media IDs. - Use
playgroundwhen the workflow is isolated to playground content.
Execute a run
from videovector import VideoVector
with VideoVector(api_key="sk_live_...") as client:
run = client.prompt_runs.execute(
prompt_id="prompt_episode_extract",
target={"type": "index", "index_id": "idx_archive"},
video_segmentation_type="smart",
audio_segmentation_type="content_aware",
processing_model="gemini-2.5-flash",
enable_transcription=True,
enable_image_embedding=True,
idempotency_key="prompt-run-archive-2026-04-20",
)
Use fixed segmentation only when you need it
If you choose fixed segmentation, include the matching duration field.
{
"video_segmentation_type": "fixed",
"video_segment_duration": 15,
"audio_segmentation_type": "fixed",
"audio_segment_duration": 30
}
Inspect status and results
After execution:
- Poll the run status or subscribe to the processing event stream.
- Inspect terminal state and failure counts.
- Retrieve segment results for a media item.
- Retrieve the media-wide result if
video_levelis enabled.
curl https://playground-api-stg-udk7d32fva-uc.a.run.app/api/v2/prompt-runs/run_123 \
-H "Authorization: Bearer <token-or-api-key>"
Retry failed segments
If the run ends with failures, inspect the failed segment manifest and retry only the affected segments instead of rerunning the entire workflow.
curl -X POST https://playground-api-stg-udk7d32fva-uc.a.run.app/api/v2/prompt-runs/run_123/videos/vid_456/segments/seg_789/retry \
-H "Authorization: Bearer <token-or-api-key>"
Cancel safely
Use cancellation when the operator's intent changed. Already-started work may finish, but no new media items should start after the stop is observed.
Related documentation
A prompt run applies one prompt to one target with explicit execution settings. Segment-level extraction and video-level synthesis are related but distinct stages.
Prompt runs are the execution boundary for extraction. The API exposes run creation, status inspection, cancellation, segment results, media-wide synthesis, failed-segment manifests, and debug-oriented LLM call access.
This guide shows how to choose the right public search mode for retrieval, filtering, comparison, conversational review, and analyst-style queries.
