Twelve Labs icon

Twelve Labs

Interact with Twelve Labs API for video understanding

Analysis → Chat with Video

AI-generated

Summary

Send a natural language prompt to chat with and analyze a specific video within a given index using AI-powered video understanding.

Inputs

  • Index ID (required) — The ID of the index containing the video to analyze.
  • Video ID (required) — The ID of the video to analyze.
  • Prompt (required) — The question or prompt to ask about the video to receive insightful responses.
  • Additional Options — Optional parameters including 'Temperature' to control randomness in AI responses (0 deterministic to 1 creative) and 'Stream Response' to optionally stream the output as it is generated.

Output shape

a single JSON object containing the indexId, videoId, prompt, AI-generated response text, and temperature setting used

The response includes the AI's answer to the user's prompt about the video. If streaming is enabled, partial responses may be streamed. Errors are returned in an error envelope if the operation fails.

Examples

Example 1: Analyze a video within an index by asking what happens during the footage.

Set 'Index ID' and 'Video ID' to specify the video. Enter a prompt such as 'What happens in this video?'. Optionally adjust 'Temperature' and streaming preference. The node returns an AI-generated chat response describing the content and context of the specified video.

Discussion