Skip to main content
Try out the search function on a sample index in the Search playground

Setup

1

Create an API key

First create an API key using the instructions in API keys
2

Install the client

Next install the AskVideos client if using Python. Or consult the REST API reference for other frameworks.
3

Create an index

Next, create an index. For this tutorial, we will use an index with the name ‘test_index’
4

Add some videos

Next, add some videos to the index. Now we are ready to get started with searching!

Search using text

The returned results look like this:
Where the results are a dictionary of lists where the key of the dictionary is the video_id and the list items are segments of the video that are in the top_k results. Each segment contains a score representing how close of a match the segment is to the query and the start and end timestamps within the video.

Search using an image

Search using a video

Next steps

In addition to finding moments, AskVideos can also answer questions based on the videos in the index.

Generate answers

Ask questions and generate answers from video content.