Skip to main content

vidcontext

Python SDK for the VidContext video intelligence API.

Analyze any video and get structured text output — context summaries, ad breakdowns, competitor analysis, and more.

Install

pip install vidcontext

Quick start

import vidcontext

# Uses VIDCONTEXT_API_KEY env var
result = vidcontext.analyze("video.mp4", mode="context")
print(result.result)

Async usage

from vidcontext import VidContext

async with VidContext(api_key="vc_...") as client:
    result = await client.analyze("video.mp4", mode="ad")
    print(result.result)

Sync usage

from vidcontext import SyncVidContext

with SyncVidContext(api_key="vc_...") as client:
    result = client.analyze("video.mp4", mode="context")
    print(result.result)

    credit_info = client.get_credits()
    print(f"Credits: {credit_info.credits}")

Fire-and-forget

job = vidcontext.submit("video.mp4", mode="editor")
print(job.job_id)  # Check status later

Analysis modes

Mode Output
context Scene-by-scene description for AI agents
editor Shot list with timecodes for video editors
analysis Deep content analysis with themes and structure
ad Ad performance breakdown with scores
ecommerce Product and UX analysis for online stores
training Training/educational content evaluation
ugc User-generated content quality assessment
competitor Competitive intelligence from video content

Account methods

with SyncVidContext() as client:
    profile = client.get_profile()
    credits = client.get_credits()
    usage = client.get_usage()
    packs = client.get_credit_packs()
    keys = client.list_api_keys()

Error handling

from vidcontext import VidContextError, AuthenticationError, JobTimeoutError

try:
    result = vidcontext.analyze("video.mp4")
except AuthenticationError:
    print("Bad API key")
except JobTimeoutError:
    print("Processing took too long")
except VidContextError as e:
    print(f"API error: {e}")

Requirements

  • Python 3.10+
  • httpx (installed automatically)

Get an API key

Sign up at vidcontext.com and go to Developer settings.

Metadata

Release files for vidcontext 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vidcontext 0.2.0
File Size Uploaded Provenance Actions
vidcontext-0.2.0.tar.gz 10.6 kB Without provenance Details for vidcontext-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vidcontext 0.2.0
File Interpreter ABI Platform Actions
vidcontext-0.2.0-py3-none-any.whl Python 3 none any Details for vidcontext-0.2.0-py3-none-any.whl

Total release size: 25.7 kB

Release files / vidcontext-0.2.0.tar.gz

Download URL vidcontext-0.2.0.tar.gz
Size 10.6 kB
Tags Source
SHA-256 checksum
How to use checksums
977190002b5f5c5c19ea3bb626753e70a23dce58299a90ca0b5b1ea8aef77bf0
BLAKE2b-256 checksum
How to use checksums
6212da3284e29fc7139413f11f7bb4a4d1cce600feaf5a81c297ac13a2809e9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / vidcontext-0.2.0-py3-none-any.whl

Download URL vidcontext-0.2.0-py3-none-any.whl
Size 15.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cfd2015ce655ec5b15044c5c36f39f73ac47345336578f6b25a6dc5ef0d44f24
BLAKE2b-256 checksum
How to use checksums
7e5b866cd8c5b2346237d3dcfcba770da254777a144a2e967d67aef8d13544bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for vidcontext 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page