Search documentation
Search pages, API reference sections, and guide headings.
Summary
Add a second prompt layer that rolls segment evidence into one result per media item without replacing the segment-level output.
Video-level synthesis is configured on the prompt, not on the run request.
Use video-level synthesis as the rollup layer for segment-driven video analysis. The media-wide result can summarize timestamped segment evidence while the original segment-level outputs remain available for search, filters, exports, and review.
Choose the fields to carry forward
included_segment_fields should contain the segment fields that matter to the media-wide summary. That list can also include public system fields such as transcription and metadata_text.
Timing context such as start_time and end_time is automatically included. You do not add
those fields manually.
Example prompt definition
from videovector import VideoVector
with VideoVector(api_key="sk_live_...") as client:
prompt = client.prompts.create(
name="Episode review prompt",
prompt_text="Extract the requested evidence per segment.",
json_schema={
"type": "object",
"properties": {
"summary": {"type": "string"},
"risk_level": {"type": "string"},
},
},
video_level={
"instructions_text": "Summarize the full asset and identify the dominant risk pattern.",
"included_segment_fields": ["summary", "risk_level", "transcription"],
"json_schema": {
"type": "object",
"properties": {
"program_summary": {"type": "string"},
"dominant_risk_level": {"type": "string"},
},
},
},
)
Retrieve the result
After a run completes, retrieve the media-wide result from the run rather than searching for it as if it were a segment result.
curl https://playground-api-stg-udk7d32fva-uc.a.run.app/api/v2/prompt-runs/run_123/videos/vid_456/video-result \
-H "Authorization: Bearer <token-or-api-key>"
Design recommendations
- Keep the video-level schema smaller than the segment-level schema.
- Include only the fields that are actually needed for synthesis.
- Use video-level output for rollups and editorial summaries, not for evidence that should remain searchable per segment.
Common mistake
Do not move evidence-level fields out of the segment schema just because a media-wide summary also needs them. Segment search, filters, and exports still depend on the segment-level contract.
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 schemas define what gets extracted, what becomes searchable, and what can be reused in video-level synthesis. This page covers the public schema rules and field-path conventions.
Prompts define the extraction contract. The public API supports prompt CRUD, schema testing, usage inspection, and prompt-definition draft generation.
