Skip to navigation

Predefined formats for video analysis will be sunset and removed

Update: This deprecation was completed on February 15, 2026. See the February 15, 2026 entry for details.

The /gist and /summarize endpoints, which generate text based on predefined formats, will be sunset and removed on February 15, 2026. Instead, use the /analyze endpoint, which provides structured JSON responses.

This consolidation provides the same capabilities with the following benefits:

  • Reduced API surface area: A single endpoint simplifies integration and maintenance
  • Fully customizable schemas: Define custom fields, naming conventions, and schema variations to match your requirements
  • Improved chapterization quality: Significantly better chapter detection and segmentation
  • Better adherence to rules: Enhanced accuracy when applying duration-based chapter rules
  • More stable output: Predictable, consistent responses across requests

Actions required

Complete these migration steps before February 15, 2026:

1

Update your code to use the /analyze endpoint instead of /gist and /summarize.

2

Define a schema for the /analyze endpoint that outlines the expected structure for the response.

The prompt in the example below requests the title of a video, and the schema defines a field named title for the response.

import json
from twelvelabs import TwelveLabs
from twelvelabs.types import ResponseFormat
client = TwelveLabs(api_key="<YOUR_API_KEY>")
text = client.analyze(
video_id="<YOUR_VIDEO_ID>",
prompt="Provide the title of this video",
response_format=ResponseFormat(
type="json_schema",
json_schema={
"type": "object",
"properties": {
"title": {"type": "string"}
},
"required": ["title"],
},
),
)
data = json.loads(text.data) if text.data else {}
print(f"Title: {data.get('title', 'N/A')}")

For more examples demonstrating how to use structured JSON responses instead of the /gist and /summarize endpoints, see the Structured responses page.

3

Test your changes by comparing outputs and finalizing your schemas before February 15, 2026.

Support

For migration assistance, contact our support team at support@twelvelabs.io.