RtspCameraRegister an RTSP camera owned by the caller

Register an RTSP camera owned by the caller

Creates a camera and returns the id the server assigned to it — the id is the camera's storage prefix, so it is never taken from the request. Ownership follows the credentials: a JWT creates a B2C camera for that user, an org API key an org-owned one. Use the returned cameraId on every later call.

curl -X POST "https://api.spkey.co/rtsp-cameras" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "name": "John Doe",
  "rtspUrl": "example_string",
  "username": "John Doe",
  "password": "example_string",
  "httpSnapshotUrl": "example_string"
}'
{
  "success": true,
  "cameraId": "example_string",
  "version": 3.14,
  "placementStatus": "pending"
}
POST
/rtsp-cameras
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Human-readable camera name, shown in the app

Min length: 1
rtspUrlstring
Required

RTSP source URL (e.g. rtsp://1.2.3.4:554/stream)

Min length: 1
usernamestring

RTSP authentication username

passwordstring

RTSP authentication password

httpSnapshotUrlstring

Optional HTTP JPEG/PNG snapshot endpoint

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Body

application/json
namestring
Required

Human-readable camera name, shown in the app

rtspUrlstring
Required

RTSP source URL (e.g. rtsp://1.2.3.4:554/stream)

usernamestring

RTSP authentication username

passwordstring

RTSP authentication password

httpSnapshotUrlstring

Optional HTTP JPEG/PNG snapshot endpoint

Responses

successboolean
Required
Allowed values:true
cameraIdstring
Required

Server-assigned camera UUID — use it on every later call

versionnumber
Required
placementStatusstring
Required
Allowed values:pendingrunning