Overview
What the DeepFrame API does and where to start.
The DeepFrame API turns video into evidence-backed decisions. Upload and index a video once, then reuse it for Search, Workflow Review, and Analysis. Findings and Answers keep their result state and reviewable evidence, and Reports format that existing answer data.
What You Can Build
Choose the result you need first. All three paths reuse the same indexed video.
Search
Search reusable indexed evidence in natural language and inspect ranked, timestamped matches.
Workflow Review
Apply a stored rulebook and inspect evidence-backed Findings with result state and provenance.
Analysis
Run a stored profile and report template to produce named Answers with typed fields and evidence.
How DeepFrame Works
- Upload. Create an upload session with the exact
file_size. Send bytes to the returned storage target, record multipart receipts when needed, and complete the upload. The server owns content type, duration, and upload strategy. - Index. Wait for the video
statusto becomecompleted. Indexed video is reusable knowledge. - Choose a path. Reuse the indexed evidence for Search, Workflow Review, or Analysis.
- Inspect results. Search returns timestamped matches. Workflow Review returns Findings. Analysis returns named Answers with typed fields.
- Report. Select existing answer data with a stored report template, or use the rerender endpoint for a new presentation view.
- Decide. Keep
found,not_found,uncertain, andnot_checkeddistinct. Each claim must retain a reviewable evidence path.
Base URL And Versioning
All routes use this base URL:
https://api.deepframe.cloud/api/v1alpha1/api/v1alpha1 is an alpha channel. The contract is frozen for this revision, but DeepFrame makes no compatibility promise. Breaking changes land in a new dated alpha revision. A profile, report template, and run can also pin immutable versions so the selected instructions, answer fields, and presentation can be reproduced. See Conventions for versioning and response headers.
Authentication
Send a Public API Alpha key - the alpha key type that grants access to the DeepFrame API - as a bearer token:
curl --fail-with-body "$BASE_URL/api/v1alpha1/videos" \
-H "Authorization: Bearer $DEEPFRAME_API_KEY"The key carries workspace identity and route permissions. A platform admin must opt the workspace into the Public API Alpha before it accepts alpha traffic. See Authentication.
Start Here
Quickstart
Upload one small video, wait for indexing, and make your first search.
Authentication
API keys, route permissions, and workspace access.
Uploads
Direct and multipart upload sessions and processing status.
Find
Analyze And Review
Rulebooks And Workflows
Author rules and bind them to indexed video.
Analysis
Stored analysis profiles, typed Answers, evidence, and report references.
Runs And Status
The unified run status model and polling recipe.
Findings, Answers, And Reports
The difference between workflow Findings, analysis Answers, and presentation Reports.
Reports And Templates
Select and format existing answer data with supported report blocks.
Operate The Integration
Webhooks
The event envelope, signatures, and delivery history.
Errors
RFC 9457 problem details and retry guidance.
Production Readiness
A launch checklist and the enterprise questions this alpha portal does not answer.
Conventions
Pagination, idempotency, rate limits, and alpha stability.
Changelog
Dated changes to the alpha contract.
API Reference
The API reference documents every operation in the checked-in OpenAPI contract. It includes the request and response examples, response headers, error responses, and code samples for each operation.