Quickstart
This guide shows how to upload a video, build a knowledge store, and generate an overview of your video content. Additionally, the platform allows for entity extraction and tracking, search functionality, content organization, and more. To explore the capabilities of the platform, see the Guides section. For common tasks and multi-step workflows, see the Recipes section.
Key concepts
This section explains the key concepts and terminology used in this guide:
- Asset: Your uploaded content. Once created, you can reference the same asset across multiple operations without uploading the file again.
- Knowledge store: A persistent store of your videos plus the understanding the platform derives from them - spatiotemporal context, a typed ontology, and embeddings - that together enable corpus-level reasoning.
- Ingestion configuration: An optional set of instructions that controls what the platform extracts during indexing. You can provide a natural-language description or a JSON schema.
- Knowledge store item: An asset added to a knowledge store. The platform processes each item asynchronously. When processing finishes, the item is ready for downstream tasks.
Workflow
Upload your video as an asset, then create a knowledge store. Add the asset to the knowledge store. The platform indexes the content asynchronously. When processing finishes, use the Responses API to generate a response from the knowledge store. Note that this guide includes an optional ingestion configuration to show how to guide extraction.
Prerequisites
-
To use the platform, you need an API key:
-
Python 3.8+ with
requestsinstalled: -
A video file or a publicly accessible video URL that points directly to a media file.
-
Upload limits: Public video URLs up to 4 GB or local video files up to 200 MB. For local files up to 4 GB, see the Upload content page.
Starter code
Copy and paste the code below, replacing the placeholders surrounded by <> with your values.
Code explanation
Check the status of the asset
You only need this step for URL uploads larger than 200 MB. The platform processes these files asynchronously.
Create a knowledge store
Create a knowledge store and provide an ingestion config that tells Jockey what to extract. The ingestion config is optional, but it improves the quality of the results. This example uses a natural-language description. The platform also supports defining a JSON schema for structured extraction. For details, see the Configure ingestion page.