Documentation/API Reference

API Reference

Complete API documentation for integrating with Perimi's video intelligence platform

Most Popular

REST API

HTTP-based API for direct integration with any programming language

RESTful endpoints
JSON request/response
OpenAPI 3.0 spec
Rate limiting included
View Documentation

Python SDK

Official Python library with full API coverage and utilities

Pip installable package
Type hints included
Async/await support
Built-in authentication
View Documentation

JavaScript SDK

Browser and Node.js compatible SDK for web applications

NPM package available
TypeScript definitions
Promise-based API
React hooks included
View Documentation

API Quick Start

1

Get API Key

Generate an API key from your dashboard settings

Dashboard → Settings → API Keys → Generate New Key
2

Authentication

Include your API key in the Authorization header

Authorization: Bearer YOUR_API_KEY
3

Make Requests

Start making API calls to manage streams and get data

curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.perimi.ai/v1/streams

Core API Concepts

Key concepts to understand before using the API

Streams

Streams represent video feeds from cameras or other sources. Each stream has a unique ID and can be configured with detection zones and alert settings.

GET /v1/streams/{stream_id}

Anomalies

Anomalies are detected events in video streams. They include confidence scores, timestamps, and metadata about what was detected.

GET /v1/anomalies?stream_id={id}

Authentication

All API requests require authentication using Bearer tokens. API keys can be generated from your dashboard.

Authorization: Bearer {API_KEY}

Rate Limits

API requests are rate limited per API key. Check response headers for current limit status and reset times.

X-RateLimit-Remaining: 100

Ready to Start Building?

Choose your preferred integration method and start building with Perimi

Perim - AI-Powered Anomaly Detection for Critical Infrastructure