Skip to main content
POST
Start Vision Session

Authorizations

x-api-key
string
header
required

Body

application/json
livekit_url
string
required

wss:// URL of the LiveKit room Hawkeye should join.

Example:

"wss://your-livekit-domain.livekit.cloud"

access_token
string
required

LiveKit access token with roomJoin: true for that room.

Example:

"eyJhbGciOi..."

max_duration
integer
required

Session cap in minutes. Hawkeye disconnects when reached.

Example:

10

participant
string

Participant identity to analyse. Defaults to "auto" (first non-agent participant).

Example:

"auto"

callback_url
string

WebSocket URL to receive real-time class-detection alerts.

Example:

"wss://your-callback-endpoint.example.com/vision"

modules
object

Modules to enable. Each key is a module name; each value is the list of classes to alert on. Pass an empty array to enable a module with all its default classes. Omit modules entirely for all defaults.

Example:

Response

Vision session accepted

session_id
string<uuid>
Example:

"8f2a1e5b-4c9d-4a3f-9c11-2c07be7d1c22"

status
string
Example:

"IN_QUEUE"

max_duration
integer
Example:

10

modules
string[]
Example: