Get RTSP camera state
Returns the camera's public state, including a signed playback link when the camera is supposed to be streaming. Pass refreshPlayback=1 to re-sign that link instead of serving the cached one — send it only after the playback host answered 403 for the link you were given, and play the link in that response.
curl -X GET "https://api.spkey.co/rtsp-cameras/example_string?refreshPlayback=0" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY"
import requests
import json
url = "https://api.spkey.co/rtsp-cameras/example_string?refreshPlayback=0"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.spkey.co/rtsp-cameras/example_string?refreshPlayback=0", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.spkey.co/rtsp-cameras/example_string?refreshPlayback=0", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/rtsp-cameras/example_string?refreshPlayback=0')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"cameraId": "example_string",
"name": "John Doe",
"status": "working",
"placementStatus": "pending",
"placementError": "example_string",
"streamId": "example_string",
"hlsPath": "example_string",
"signedHlsUrl": "example_string",
"hlsExpiresAt": 3.14,
"httpSnapshotUrl": "example_string",
"signedPreviewUrl": "example_string",
"previewExpiresAt": 3.14,
"ownerId": "example_string",
"orgId": "example_string",
"role": "viewer",
"accessGrants": [
{
"userId": "example_string",
"role": "viewer",
"grantedAt": "example_string"
}
],
"runtimeStatus": "example_string",
"runtimeError": "example_string",
"runtimeChangedAt": "example_string",
"runtimeObservedAt": "example_string",
"recordingEnabled": true,
"retentionDays": 3.14,
"monitoring": true,
"createdAt": "example_string",
"updatedAt": "example_string"
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/rtsp-cameras/{id}Target server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
RTSP camera UUID (aggregate id)
Re-sign the playback link instead of serving the cached one. Send it only after the playback host answered 403 for the link you were given.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
RTSP camera UUID (aggregate id)
Query Parameters
Re-sign the playback link instead of serving the cached one. Send it only after the playback host answered 403 for the link you were given.
01truefalseResponses
workingstoppeddeletedpendingrunningfailedreleasedviewermanager