Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • TwelveLabs API
    • Introduction
    • Authentication
    • Typical workflows
  • API Reference
    • Manage indexes
    • Upload videos
    • Manage videos
    • Any-to-video search
    • Create video embeddings
    • Create text, image, and audio embeddings
    • Analyze videos
    • Error codes
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
API ReferenceAnalyze videos

POST
https://api.twelvelabs.io/v1.3/gist
POST
/v1.3/gist
1curl -X POST https://api.twelvelabs.io/v1.3/gist \
2     -H "x-api-key: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "video_id": "6298d673f1090f1100476d4c",
6  "types": [
7    "title",
8    "topic"
9  ]
10}'
Try it
200Successful
1{
2  "id": "56dd2567-9b34-4ee9-9fbb-c20fc283e5bf",
3  "title": "From Consumerism to Minimalism: A Journey Toward Sustainable Living",
4  "topics": [
5    "Shopping Vlog Lifestyle",
6    "Minimalism Lifestyle",
7    "Sustainable Living"
8  ],
9  "hashtags": [
10    "#BlackFriday",
11    "#Vlog"
12  ],
13  "usage": {
14    "output_tokens": 100
15  }
16}
Was this page helpful?
Previous

Summaries, chapters, or highlights

Next
Built with
This endpoint analyzes videos and generates titles, topics, and hashtags. <Note title="Note"> This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page. </Note>
Titles, topics, or hashtags

Authentication

x-api-keystring
Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Request

Request to generate a gist for a video.
video_idstringRequired
The unique identifier of the video that you want to generate a gist for.
typeslist of enumsRequired
Specifies the type of gist. Use one of the following values: - `title`: A title succinctly captures a video's main theme, such as "From Consumerism to Minimalism: A Journey Toward Sustainable Living," guiding viewers to its content and themes. - `topic`: A topic is the central theme of a video, such as "Shopping Vlog Lifestyle", summarizing its content for efficient categorization and reference. - `hashtag`: A hashtag, like "#BlackFriday", represents key themes in a video, enhancing its discoverability and categorization on social media platforms.
Allowed values:

Response

The gist of the specified video has successfully been generated.
idstring or null
Unique identifier of the response.
titlestring or null
Suggested title for the video.
topicslist of strings or null
An array of topics that are relevant to the video.
hashtagslist of strings or null
An array of hashtags that are relevant to the video.
usageobject or null
The number of tokens used in the generation.

Errors

Your API key.

Note

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

The gist of the specified video has successfully been generated.

Specifies the type of gist. Use one of the following values:

  • title: A title succinctly captures a video’s main theme, such as “From Consumerism to Minimalism: A Journey Toward Sustainable Living,” guiding viewers to its content and themes.
  • topic: A topic is the central theme of a video, such as “Shopping Vlog Lifestyle”, summarizing its content for efficient categorization and reference.
  • hashtag: A hashtag, like “#BlackFriday”, represents key themes in a video, enhancing its discoverability and categorization on social media platforms.

This endpoint analyzes videos and generates titles, topics, and hashtags.

Note

This endpoint is rate-limited. For details, see the Rate limits page.