Streams

Creates a live stream and returns a publish token. The current request body is empty. The retained frame history is fixed at 600 seconds.

The publish token is scoped to this stream and grants media publish permissions. Renew it through /keepalive before it expires.

post/streams

Request

  • Base URL
    https://api.overshoot.ai/v1beta
  • Auth
    HTTP bearer

Headers

X-Overshoot-Region'us-west1' | 'us-central1'

Optional hint to route the request to the region that owns the stream. If the request reaches the wrong region the API returns 409 with a region_error body.

Request body

Example request

{
  "source": {
    "url": "rtsp://user:pass@camera.example.com:554/stream"
  }
}

Response

Stream created.

idstring uuid required

Unique stream identifier. Use this in every subsequent stream URL.

state'active' required

Always active for a freshly created stream.

expires_at_msinteger required

Wall-clock Unix ms when the lease will expire if not renewed via /keepalive.

ttl_secondsinteger required

Lease TTL in seconds. Currently 300 for all streams.

Example response

{
  "ttl_seconds": 300
}

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status