Gateway

Open async job websocket

Opens a persistent websocket session for owned async batch or video job updates. WebSocket handshake uses HTTP GET upgrade semantics and returns 101 Switching Protocols on success (not 200). The socket emits a job.snapshot immediately after upgrade and subsequent job.updated envelopes when the normalized async job payload changes. If close_on_terminal is enabled, the gateway closes the socket after a terminal completed, failed, cancelled, or expired update.

get/async/{kind}/{id}/ws

Request

  • Base URL: https://api.phaseo.app/v1
  • URL: https://api.phaseo.app/v1/async/{kind}/{id}/ws
  • Auth: HTTP bearer

Path parameters

kind'batch' | 'video' required

Async job kind.

idstring required

Gateway-owned async job id.

Query parameters

interval_msinteger

Polling interval used by the websocket recovery loop.

close_on_terminalboolean

Close the socket after a terminal lifecycle update.

Changes

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