Open-ended texts

post

https://api.twelvelabs.io/v1.3/generate

This endpoint generates open-ended texts based on your videos, including but not limited to tables of content, action items, memos, and detailed analyses.

NOTES:

This endpoint is rate-limited. For details, see the Rate limits page.
This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the Streaming response guide.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to generate a text representation of a video.

video_id

string

required

The unique identifier of the video for which you wish to generate a text.

prompt

string

required

A prompt that guides the model on the desired format or content.

NOTES:

Even though the model behind this endpoint is trained to a high degree of accuracy, the preciseness of the generated text may vary based on the nature and quality of the video and the clarity of the prompt.
Your prompts can be instructive or descriptive, or you can also phrase them as questions.
The maximum length of a prompt is 375 tokens.

Examples:

Based on this video, I want to generate five keywords for SEO (Search Engine Optimization).
I want to generate a description for my video with the following format: Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.

temperature

float

0 to 1

Defaults to 0.2

Controls the randomness of the text output generated by the model. A higher value generates more creative text, while a lower value produces more deterministic text output.

Default: 0.2
Min: 0
Max: 1

stream

boolean

Defaults to true

Set this parameter to true to enable streaming responses in the NDJSON format.

Default: true

Headers

x-api-key

string

required

Your API key.

NOTE: You can find your API key on the API Key page.

Responses

429

If the rate limit is reached, the platform returns an HTTP 429 - Too many requests error response. The response body is empty.

200The specified video has successfully been processed.

400The request has failed.