API reference

The DeepFrame v1alpha1 public API. Alpha access requires a Public API Alpha key or an existing operator-issued alpha key.

Base URLs

• https://api.deepframe.cloud
• https://api.dev.deepframe.cloud

Authentication

Every request uses the Authorization: Bearer header. Set DEEPFRAME_API_KEY in your environment:

Authorization: Bearer $DEEPFRAME_API_KEY

API conventions

API keys

Authenticate with the Authorization: Bearer <API key> header. The key must be active, must belong to your organization, and must have alpha access enabled. A workspace admin can create a Public API Alpha key in the DeepFrame developer settings after accepting the current API Terms. The workspace must be explicitly opted in by a platform admin before alpha traffic is allowed.

Versioning

This alpha revision has no compatibility promise. Breaking changes ship as v1alpha2, and a prior alpha revision may receive a 30-day sunset through the Deprecation and Sunset headers.

Errors

Synchronous HTTP errors use RFC 9457 application/problem+json responses with stable type URIs. HTTP 200 asynchronous resources use a nested error object with code, title, detail, and next_action; that object has no HTTP status member.

Date-times

Date-times in request and response bodies are RFC 3339 UTC strings with an explicit offset, for example 2026-08-08T10:15:00.000Z. The exceptions are HTTP headers that carry their own date formats (Retry-After, Sunset) and the webhook webhook-timestamp header, which is a Unix timestamp in seconds.

Pagination

List endpoints use an opaque cursor envelope with a default limit of 25 and a maximum of 100. Pass next_cursor unchanged as cursor.

Idempotency

Mutating POST endpoints accept Idempotency-Key. A key is remembered for 24 hours, scoped to your workspace and to the route you sent it to. Reusing it with a different request body or path is rejected rather than replayed.

Rate limits

Authenticated responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. The server-owned Public API Alpha budget is 10,000 requests per hour for the workspace, shared by all alpha keys. X-RateLimit-Limit reports the effective per-key limit and X-RateLimit-Remaining is also constrained by the shared workspace budget. An existing operator-issued key may have a lower per-key limit. Exhausted budgets return 429 with Retry-After.

Webhooks

An authenticated workspace can register HTTPS endpoints for video.indexed, video.failed, run.completed, run.failed, and run.canceled events, inspect delivery history, and request redelivery.

Endpoints