Get Stream Status

GET

stream

{stream_id}

curl -X GET "https://client.camb.ai/apis/stream/1234" \
  -H "x-api-key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://client.camb.ai/apis/stream/1234",
    headers={"x-api-key": "YOUR_API_KEY"},
)

response.raise_for_status()
print(response.json())

{
  "stream_id": 1234,
  "status": 3,
  "source": {
    "type": 1,
    "playback_url": null
  },
  "targets": [
    {
      "id": "spanish-out",
      "type": 1,
      "state": "active",
      "playback_url": null,
      "destination_url": "srt://delivery.example.com:9100"
    }
  ],
  "scheduled_at": "2026-08-01T10:00:00Z",
  "started_at": "2026-08-01T10:00:05Z",
  "stopped_at": null,
  "task_id": "b8f2f1f0-3c6a-4f5e-9b2a-1c2d3e4f5a6b",
  "error": null
}

Overview

Returns the current state of a stream. The response shape is the same whether the stream is scheduled, live, or finished, which makes it suitable for dashboards and polling loops. Use it to:

Track the stream through its lifecycle (scheduled → setting up → started → ended).
Read the playback URLs of Camb.ai-hosted outputs (SRT listener, HLS recording).
Check per-target delivery state and surface errors.

When polling, a cadence of 5–15 seconds is plenty. Back off once the stream reaches a terminal status (4, 5, or 6).

curl -X GET "https://client.camb.ai/apis/stream/1234" \
  -H "x-api-key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://client.camb.ai/apis/stream/1234",
    headers={"x-api-key": "YOUR_API_KEY"},
)

response.raise_for_status()
print(response.json())

{
  "stream_id": 1234,
  "status": 3,
  "source": {
    "type": 1,
    "playback_url": null
  },
  "targets": [
    {
      "id": "spanish-out",
      "type": 1,
      "state": "active",
      "playback_url": null,
      "destination_url": "srt://delivery.example.com:9100"
    }
  ],
  "scheduled_at": "2026-08-01T10:00:00Z",
  "started_at": "2026-08-01T10:00:05Z",
  "stopped_at": null,
  "task_id": "b8f2f1f0-3c6a-4f5e-9b2a-1c2d3e4f5a6b",
  "error": null
}

Reading the response

status - the stream lifecycle status: 1 scheduled, 2 setting up, 3 started, 4 ended, 5 interrupted, 6 error.
targets[].state - each output progresses scheduled → active → completed, or failed on error.
targets[].playback_url - set for Camb.ai-hosted outputs; this is where you or your viewers connect.
targets[].destination_url - set for push outputs; the endpoint Camb.ai is delivering to.
error - populated when status is 6.

Errors

404 - No stream with this ID belongs to your team.
422 - Invalid stream_id.

Authorizations

x-api-key

string

header

required

The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.

Path Parameters

stream_id

integer

required

Identifier returned when the stream was created.

Response

Current state of the stream.

Current state of a stream. The shape is identical whether the stream is scheduled, live, or finished.

stream_id

integer

status

enum<integer>

Lifecycle status.

Available options:

1,

2,

3,

4,

5,

6

source

SourceView · object | null

Source connection details.

Hide child attributes

source.type

enum<integer> | null

Best-effort protocol of the source, inferred from its URL. May be null.

Available options:

1,

2,

3,

4,

5,

6

source.playback_url

string | null

URL where the source can be played back, when available.

targets

TargetView · object[]

State and URLs of each output.

Hide child attributes

targets.id

string

Target identifier from the create payload.

targets.type

enum<integer>

Output protocol/type.

Available options:

1,

2,

3,

4,

5,

6

targets.state

enum<string>

Lifecycle state of this target output.

Available options:

scheduled,

deferred,

active,

completed,

failed

targets.playback_url

string | null

URL to play this output, for Camb.ai-hosted outputs.

targets.destination_url

string | null

URL this output is being pushed to, for push-type targets.

scheduled_at

string<date-time> | null

started_at

string<date-time> | null

stopped_at

string<date-time> | null

task_id

string | null

Setup task identifier.

error

string | null

Failure description when status is 6 (error).

Last modified on July 24, 2026

Update a StreamUpdate a stream's configuration or apply live adjustments, including turning dubbing on and off, without recreating it.

curl -X GET "https://client.camb.ai/apis/stream/1234" \
  -H "x-api-key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://client.camb.ai/apis/stream/1234",
    headers={"x-api-key": "YOUR_API_KEY"},
)

response.raise_for_status()
print(response.json())

{
  "stream_id": 1234,
  "status": 3,
  "source": {
    "type": 1,
    "playback_url": null
  },
  "targets": [
    {
      "id": "spanish-out",
      "type": 1,
      "state": "active",
      "playback_url": null,
      "destination_url": "srt://delivery.example.com:9100"
    }
  ],
  "scheduled_at": "2026-08-01T10:00:00Z",
  "started_at": "2026-08-01T10:00:05Z",
  "stopped_at": null,
  "task_id": "b8f2f1f0-3c6a-4f5e-9b2a-1c2d3e4f5a6b",
  "error": null
}

Getting Started

Models

Tutorials

SDK Guides

Hosting Platforms

Integrations

API Reference

Other Products

Release Logs

Get Stream Status

Overview

Reading the response

Errors

Authorizations

Path Parameters

Response

​Overview

​Reading the response

​Errors

​Related endpoints

Authorizations

Path Parameters

Response

Overview

Reading the response

Errors

Related endpoints