Video APIv1 Home OpenAPI spec

Docs › Redaction

Redaction fields

Blur or black out regions of a video, each during a time window. Redactions go in the redactions option of complete; see Processing options for the request body.

FieldDescription
type"box" (solid black bar: irreversible, the safest choice for text) or "blur".
shape"rect" (default) or "ellipse" (fills the box).
x, y, w, hTop-left corner and size, as fractions of the final frame (0–1). For screen + camera videos that's the combined picture.
start, endSeconds on the output timeline (after any trim). end: null = until the end.

Following moving content

For something that moves, like a face walking across the frame, give the region a track of keyframes instead of x, y, w, h. It glides smoothly between them, resizing as it goes:

{ "type": "blur", "shape": "ellipse", "start": 4, "end": 12,
  "track": [ { "time": 4,  "x": 0.10, "y": 0.30, "w": 0.15, "h": 0.25 },
             { "time": 8,  "x": 0.45, "y": 0.28, "w": 0.18, "h": 0.30 },
             { "time": 12, "x": 0.80, "y": 0.30, "w": 0.15, "h": 0.25 } ] }

Add a keyframe wherever the motion changes direction or speed. Up to 50 keyframes per region.