Create stream

curl --request POST \
  --url https://api.overshoot.ai/v1beta/streams \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.overshoot.ai/v1beta/streams"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.overshoot.ai/v1beta/streams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.overshoot.ai/v1beta/streams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.overshoot.ai/v1beta/streams"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.overshoot.ai/v1beta/streams")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.overshoot.ai/v1beta/streams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "active",
  "publish": {
    "type": "livekit",
    "url": "<string>",
    "token": "<string>"
  },
  "expires_at_ms": 123,
  "ttl_seconds": 300
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": {
    "error": "region_error",
    "expected_region": "us-west1",
    "requested_region": "us-central1"
  }
}

{
  "detail": "<string>"
}

Streams

Create stream

Create a new video inference stream. Returns connection details for the chosen transport.

Workflow: Create stream → connect video source → receive results on WebSocket → send keepalives → close when done.

Transport options:

Native (default, recommended): Omit source. Response includes livekit.url and livekit.token for publishing video.
WebRTC: Set source.type: 'webrtc' with an SDP offer. Response includes webrtc answer and turn_servers.
LiveKit: Set source.type: 'livekit' with your room URL and token.

Processing modes:

Clip mode: Send target_fps, clip_length_seconds, delay_seconds for temporal analysis (motion, actions).
Frame mode: Send interval_seconds for static analysis (OCR, object detection).

Limits: 5 concurrent streams per API key. Requires credits.

POST

streams

Create stream

curl --request POST \
  --url https://api.overshoot.ai/v1beta/streams \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.overshoot.ai/v1beta/streams"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.overshoot.ai/v1beta/streams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.overshoot.ai/v1beta/streams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.overshoot.ai/v1beta/streams"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.overshoot.ai/v1beta/streams")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.overshoot.ai/v1beta/streams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "active",
  "publish": {
    "type": "livekit",
    "url": "<string>",
    "token": "<string>"
  },
  "expires_at_ms": 123,
  "ttl_seconds": 300
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": {
    "error": "region_error",
    "expected_region": "us-west1",
    "requested_region": "us-central1"
  }
}

{
  "detail": "<string>"
}

What you get

The response carries:

id — pass this in every later URL: /v1beta/streams/{id}/... plus stream URLs you embed in chat completion messages.
publish.url + publish.token — feed these to a LiveKit client SDK to connect a video source. Any LiveKit publisher works (browser, native, server-to-server). The token is short-lived; use the one returned by /keepalive if your publisher reconnects later.
expires_at_ms + ttl_seconds — the lease deadline. Call /keepalive before it elapses (every ~2 minutes is safe). After expiry the stream’s state flips to ended and stays there.

The stream sits in active state immediately, even before the first frame arrives. GET /streams/{id} returns last_frame_at_ms: null until a publisher actually delivers a frame.

Authorizations

Authorization

string

header

required

Every public HTTP request requires Authorization: Bearer <api_key>, except GET /models and the public /billing/pricing endpoints.

401 means the key is missing, unknown, or revoked.
403 means the key is valid but cannot access the requested resource.
The publish token returned by POST /streams is only for publishing media to LiveKit. It does not replace the API key for HTTP calls.

Headers

X-Overshoot-Region

enum<string>

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.

Available options:

us-west1,

us-central1

Response

Stream created.

string<uuid>

required

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

state

enum<string>

required

Always active for a freshly created stream.

Available options:

active

publish

object

required

WebRTC publish target. Connect with the LiveKit client SDK.

Show child attributes

expires_at_ms

integer

required

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

ttl_seconds

integer

required

Lease TTL in seconds. Currently 300 for all streams.

Example:

300

Chat completions Get stream

⌘I

​What you get

Authorizations

Headers

Response

What you get