whep

Subscribe to a remote WebRTC publisher using WHEP (WebRTC-HTTP Egress Protocol).

Example

curl -X POST "https://api.avflow.dev/v1/jobs" \
  -H "Authorization: Bearer ${AVFLOW_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "whep-ingest",
    "sources": [{
      "name": "whep_src",
      "type": "whep",
      "config": {
        "url": "https://whep.example.com/live/stream/whep",
        "headers": { "Authorization": "Bearer <token>" }
      }
    }],
    "nodes": [],
    "sinks": [{
      "name": "rtmp_out",
      "type": "rtmp_push",
      "inputs": ["whep_src"],
      "config": {
        "urls": ["rtmp://live.example.com/app/key"],
        "encoding": { "videoCodec": "h264", "audioCodec": "aac" }
      }
    }]
  }'

Config

Shares the URLPullSourceConfig JSON shape with other pull sources, but the WHEP source only uses the fields below:

Field	Type	Default	Description
url	string	required	WHEP endpoint URL (https://…).
identity	string	source name	Speaker label for active-speaker and ASR attribution.
displayName	string	identity / source name	Human-readable label for overlays and captions.
headers	map	—	HTTP headers for the WHEP POST (for example, Authorization).

startTimeoutMs, stallTimeoutMs, and loop may appear in the shared struct but are not applied by the WHEP source implementation.

Pricing

Video tier by actual resolution. Source pricing.