create_analysis
Ask a question about a video by submitting a video ID and prompt. Returns the answer, confidence, and clip timestamps.
Instructions
Ask a question about a video (POST /v1/analyses). Provide video_id (video_…) and a free-text prompt like "Is there a person in this video?". Analysis runs asynchronously — use wait_for_analysis to block until done. The result contains answer (yes|no|indeterminate), confidence (0-1), clip timestamps, detected_count (count queries), and indeterminate_reason. Recommended: call validate_analysis first to confirm the prompt is assessable and preview the cost before spending credits. For 2–10 prompts on the same video, use create_analysis_batch (each prompt after the first is billed at 50%).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model | No | Model id (see list_models). Defaults to the current default model. | |
| prompt | Yes | Free-text question about the video, e.g. "Is there a person in this video?" | |
| metadata | No | Optional key-value metadata to attach. | |
| video_id | Yes | The video to analyze (video_… id from create_video_from_url). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| error | Yes | ||
| model | Yes | ||
| query | Yes | Compiled interpretation of the prompt (subjects, conditions, query_type, search_terms, prompt_intent, original_prompt, …). Transparency feature: shows how the question was understood. | |
| usage | Yes | Terminal only. Immutable snapshot of the balance after THIS analysis settled. | |
| object | Yes | ||
| origin | Yes | ||
| prompt | Yes | ||
| result | Yes | ||
| status | Yes | ||
| options | Yes | ||
| livemode | Yes | ||
| metadata | No | ||
| progress | Yes | ||
| video_id | Yes | ||
| artifacts | Yes | ||
| narrative | Yes | ||
| created_at | Yes | ||
| parse_mode | Yes | ||
| started_at | Yes | ||
| completed_at | Yes | ||
| queue_position | Yes |