Changelog
Dated changes to the DeepFrame API contract (v1alpha1).
2026-08-23 - v1alpha1 Contract Frozen
The v1alpha1 contract is frozen by the api01 first-key readiness program. This alpha has no compatibility promise. Breaking changes land here with a date.
The frozen surface includes:
snake_casewire names and one unified run status with kind-specific detail.- Resource renames, including the
reportsresource andreport-templatesresource. - The
{data, next_cursor, has_more}list envelope. - RFC 9457
application/problem+jsonerrors with a stable catalog. - Standard Webhooks envelopes and the five-event vocabulary:
video.indexed,video.failed,run.completed,run.failed, andrun.canceled. - Prefixed opaque public ids.
- Typed answer payloads, curated public provenance, evidence paths, and preserved uncertainty.
- Stored, versioned profiles and report templates.
- Alpha workspace opt-in, route permissions, and rate-limit response headers.
Read the API reference for the exact OpenAPI operation contract. Read Conventions for the alpha stability boundary.