Skip to main content
POST
/
streams
/
{stream_id}
/
keepalive
Error
A valid request URL is required to generate request examples
{
  "status": "<string>",
  "stream_id": "<string>",
  "ttl_seconds": 123,
  "credits_remaining_cents": 123,
  "cost_cents": 123,
  "seconds_charged": 123,
  "state": "pending",
  "livekit_token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.overshoot.ai/llms.txt

Use this file to discover all available pages before exploring further.

The v0.2 API is deprecated. New integrations should use v1.

Authorizations

​
Authorization
string
header
required

Provide your API key in the Authorization header as 'Bearer <api_key>'

Path Parameters

​
stream_id
string
required

Response

Lease renewed, credits charged

Keepalive response with billing summary. Streams expire after TTL seconds without a keepalive.

​
status
string
required
Allowed value: "ok"
​
stream_id
string
required

Stream identifier

​
ttl_seconds
integer
required

Seconds until stream expires without another keepalive

​
credits_remaining_cents
integer
required

Credits remaining after this charge (in cents)

​
cost_cents
number
required

Credits charged for this keepalive interval (in cents)

​
seconds_charged
number
required

Seconds of streaming time charged

​
state
enum<string>
required

Current stream state: pending (no frames yet), active (inferencing), idle (frames stopped)

Available options:
pending,
active,
idle
​
livekit_token
string | null

Refreshed LiveKit JWT for native sources. Use this to maintain the connection.