Edge VAR Requests

Submit a Video Assistant Referee request

Accepts a recorded clip URL + camera id, persists a VarRequest, and enqueues a background job that calls the Intelligence DRS service (Modal-hosted, ~30-60s). The response returns immediately with {id, status:"pending"}. Clients should then open a WebSocket connection to /cable and subscribe to VarRequestChannel with the returned id to receive every state transition (processing -> completed with playback_url, or failed with error). See the /cable path for the subscription contract. The VarRequest is owned by the authenticated user. Only that user can subscribe to its channel.

post/v1/edge/var-requests

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Request body

Example request

{
  "var_request": {
    "playlist_url": "https://dbyctxsmb6sh0.cloudfront.net/1248729/292/master.m3u8",
    "camera_id": "48"
  }
}

Response

VAR request accepted and queued for processing.

idstring uuid

VarRequest identifier; used as the subscription id on the VarRequestChannel.

status'pending' | 'processing' | 'completed' | 'failed'
playback_urlstring nullable

Rendered overlay video URL. Present only when status is "completed".

errorstring nullable

Failure reason (sourced from VarRequest.error_message). Present only when status is "failed".

Changes

No recorded changes to this operation across all 1 revision of this API.