Complete API documentation for integrating with Perimi
Include your API key in the Authorization header of all requests:
Authorization: Bearer YOUR_API_KEYGenerate API keys from your dashboard:
/api/v1/streamsCreate a new video stream
{
"name": "Warehouse Camera 1",
"location": "Building A - Entrance",
"connection_url": "rtsp://192.168.1.100:554/stream",
"credentials": {
"username": "admin",
"password": "password123"
},
"tags": ["entrance", "high-priority"]
}/api/v1/streamsList all streams
{
"streams": [
{
"stream_id": "warehouse-cam-1_abc123",
"name": "Warehouse Camera 1",
"status": "active",
"last_frame": "2024-09-14T10:30:00Z"
}
]
}/api/v1/anomaliesGet anomaly detections
{
"anomalies": [
{
"id": "anomaly_123",
"stream_id": "warehouse-cam-1_abc123",
"type": "motion_detection",
"confidence": 0.92,
"timestamp": "2024-09-14T10:25:00Z",
"location": {"x": 150, "y": 200}
}
]
}200 OKRequest successful201 CreatedResource created204 No ContentSuccessful deletion400 Bad RequestInvalid request data401 UnauthorizedInvalid API key404 Not FoundResource not found429 Rate LimitedToo many requestsOfficial Python library with full API coverage
pip install perimi-pythonBrowser and Node.js compatible SDK
npm install @perimi/sdk