List stream

Mints a short-lived way in to one camera.

GET /v1/patrol/camera/{name}/stream

Patrol → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/patrol/camera/{name}/stream`
Method	`GET`
Operation	`get_patrol_camera_by_name_stream`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Mints a short-lived way in to one camera.

The credential is kept in KMS, at the one place a camera's credential is kept — the org's own patrol namespace, named for the camera — and what comes back is minted from it rather than being it: the camera's address with the user and password removed, bounded by an expiry, and signed so that whatever opens the camera can tell a live ticket from a made-up one. The caller receives something that opens one camera for five minutes and says nothing about how.

A camera whose row points anywhere but its own place, and one with no credential registered, is 404.

Request

1 field.

Field	In	Type	Required	Description
`name`	path	string	yes	Name is the camera's document name, from the path.

Response

Status	Body	Meaning
`200`	patrol.patrolStreamOut	ok
`default`	problem-details	refused

200 body — 3 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolStream	—
`data.expires`	body	string	—	Expires is when that address stops working.
`data.url`	body	string	—	URL is the address to open the stream at.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo patrol camera stream list <name>

.ts

.py

.go

.rs

.java

import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolCameraByNameStream({ name: 'name' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).get_patrol_camera_by_name_stream(name='name')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatrolAPI.GetPatrolCameraByNameStream(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, patrol_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = patrol_api::get_patrol_camera_by_name_stream(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PatrolApi(client).getPatrolCameraByNameStream();

curl https://api.hanzo.ai/v1/patrol/camera/<name>/stream \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool patrol, op get_patrol_camera_by_name_stream — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "patrol",
         "arguments": {
           "op": "get_patrol_camera_by_name_stream",
           "input": {
             "name": "<name>"
           }
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet stream NextList camera