API

Overview

The Video Query API provides endpoints that enable agile, user-in-the-loop mining of video datasets. Rather than requiring an upfront specification of actions and investment in labeling data for those actions, Video Query API embraces early exploration by a user of evolving questions and ideas. The effort spent increases only as the user iterates to, focuses down on, and validates a particular line of inquiry. This app enables agile browsing through a large dataset, in order to discover and zoom in on relevant data in a dynamic and interactive way.

Running the API Server

Assuming the server and database have already been set up, execute

python3 manage.py runserver

Optional : If you want to use the API development server from a browser, go to http://127.0.0.1:8000/. (For production, use the API production URL.) You do not need to open this URL to use the client. There is full documentation of the API at the URL, including python and javascript code samples for calling each API endpoint.

Primary API endpoints:

GET /   
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "videos": "http://127.0.0.1:8000/videos/",
    "search-sets": "http://127.0.0.1:8000/search-sets/",
    "queries": "http://127.0.0.1:8000/queries/",
    "query-results": "http://127.0.0.1:8000/query-results/",
    "matches": "http://127.0.0.1:8000/matches/",
    "features": "http://127.0.0.1:8000/features/",
    "video-clips": "http://127.0.0.1:8000/video-clips/"
}

For full documentation, go to http://127.0.0.1:8000, log in, and click on "Documentation" in the navigation bar.