> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Add recording visual-redaction regions > Add one or more spatiotemporal visual-redaction regions to a completed video-room recording so a player overlay or an export pipeline can blur/pixelate a face or on-camera PII (a badge, a document, a whiteboard). Each region is a normalised bounding box (`{ x, y, w, h }` as fractions of the frame, so it is resolution-independent) that applies over a `[start_ms, end_ms]` window with a visual `effect` and a provenance `source`. Submit a single box or a whole face-detection track (up to 200 regions per request). Boxes and windows are clamped to the frame and the recording's duration; each window must be at least 100ms. Up to 500 regions per recording. Requires the `voice:write` scope and is audit-logged. ## OpenAPI ````yaml /openapi.yaml post /api/v1/recordings/{id}/visual-redactions openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway paths: /api/v1/recordings/{id}/visual-redactions: post: tags: - Recordings summary: Add recording visual-redaction regions description: >- Add one or more spatiotemporal visual-redaction regions to a completed video-room recording so a player overlay or an export pipeline can blur/pixelate a face or on-camera PII (a badge, a document, a whiteboard). Each region is a normalised bounding box (`{ x, y, w, h }` as fractions of the frame, so it is resolution-independent) that applies over a `[start_ms, end_ms]` window with a visual `effect` and a provenance `source`. Submit a single box or a whole face-detection track (up to 200 regions per request). Boxes and windows are clamped to the frame and the recording's duration; each window must be at least 100ms. Up to 500 regions per recording. Requires the `voice:write` scope and is audit-logged. parameters: - schema: type: string minLength: 1 maxLength: 128 in: path name: id required: true description: >- Recording id to add the redaction region(s) to. Must be a completed `video_room` recording with stored media. requestBody: required: true content: application/json: schema: type: object required: - regions properties: regions: type: array minItems: 1 maxItems: 200 description: >- One or more redaction regions to add. All-or-nothing — the whole request is rejected if any region is invalid. items: type: object required: - start_ms - end_ms - bbox properties: start_ms: type: integer minimum: 0 description: >- Region start offset in milliseconds from the recording start. end_ms: type: integer minimum: 0 description: >- Region end offset in milliseconds. Must be greater than start_ms and at least 100ms beyond it. bbox: type: object description: >- Normalised bounding box in fractions of the frame ([0,1]). `x`/`y` are the top-left corner; `w`/`h` the size. required: - x - 'y' - w - h properties: x: type: number minimum: 0 maximum: 1 'y': type: number minimum: 0 maximum: 1 w: type: number exclusiveMinimum: 0 maximum: 1 h: type: number exclusiveMinimum: 0 maximum: 1 effect: type: string enum: - blur - pixelate - mosaic - box default: blur description: >- The visual technique a player/export applies to the boxed region. source: type: string enum: - manual - face_detection - on_camera_pii default: manual description: >- What produced the region — provenance for the audit trail. label: type: string minLength: 1 maxLength: 200 description: Optional operator reason or detector label. responses: '201': description: The added redaction region(s). content: application/json: schema: type: object additionalProperties: true properties: data: type: object additionalProperties: true properties: recording_id: type: string regions: type: array items: $ref: '#/components/schemas/VisualRedactionRegion' total: type: integer description: >- Total redaction regions on the recording after this add. meta: type: object properties: request_id: type: string timestamp: type: string format: date-time '400': description: >- Invalid recording id or payload, the recording is not completed, a region window/box is invalid, or the per-recording redaction limit (500) is reached. '404': description: Video recording not found. components: schemas: VisualRedactionRegion: type: object description: >- A persisted spatiotemporal visual-redaction region over a completed video-room recording. The normalised `bbox` (fractions of the frame) applies over the `[start_ms, end_ms]` window; a player overlay or export pipeline reads this to blur/pixelate a face or on-camera PII. required: - id - start_ms - end_ms - bbox - effect - source - label - created_by - created_at - updated_at - duration_ms properties: id: type: string description: Region id (`vred_<32 hex>`). start_ms: type: integer description: Region start offset in milliseconds from the recording start. end_ms: type: integer description: Region end offset in milliseconds from the recording start. duration_ms: type: integer description: Derived window length (`end_ms - start_ms`). bbox: type: object description: Normalised bounding box in fractions of the frame ([0,1]). required: - x - 'y' - w - h properties: x: type: number 'y': type: number w: type: number h: type: number effect: type: string enum: - blur - pixelate - mosaic - box source: type: string enum: - manual - face_detection - on_camera_pii label: type: string nullable: true description: Operator reason or detector label, or null. created_by: type: string created_at: type: string format: date-time updated_at: type: string format: date-time securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````