Gaard

API reference, configuration, and integration guides for the Gaard platform.

Getting started

New to Gaard? Start here: what the platform does, how to sign in, and the vocabulary used everywhere else.

What is Gaard? The platform in five minutes: solutions, surfaces, and how a video becomes a decision.

Quickstart: Web App Sign in, explore the dashboard, and review your first classification.

Quickstart: API Send your first video to Gaard for classification in three steps.

Core Concepts Tenants, solutions, flows, sites and cameras, risk levels, and labels.

Day-to-day work with AI video classification: submitting clips, reviewing results, and improving the model with feedback.

Submitting Video Send video for classification from the web app or the API.

Reviewing Classifications Work through classification results in the review workspace.

Search & Filtering Build filters over sites, cameras, risk, labels, and video attributes.

Labeling & Feedback Mark true and false positives, apply custom labels, and improve results.

Exclusion Zones Mask regions of a camera view so they are ignored during classification.

Exporting Data Export results as CSV, build datasets, and download annotated clips.

Manage your tenant: people, credentials, platform behavior, and the flows that organize incoming video.

Users & Roles Invite members and understand what user, admin, and super roles can do.

API Tokens Create credentials for programmatic access and scope them to flows.

Platform Configuration Tune thresholds, retention, and classification settings for your tenant.

Flows What a flow is, when to create one, and how tokens and webhooks attach to it.

Get classification results into your own systems: pick a delivery method and connect your alarm platform.

Choosing a Delivery Method Polling, webhooks, or SFTP: pick the right way to receive classifications.

SFTP Delivery Deliver classification results as files over SFTP or FTP.

Alarm Platforms Connect Gaard to Azursoft, Evalink, Prysm, or a SIA DC-09 receiver.

Where Gaard runs and how your data is protected.

Cloud vs On-Premises The two ways to run Gaard and how to choose between them.

Security & Data Isolation How Gaard isolates tenants, scopes access tokens, and encrypts data.

Data Retention & GDPR How long Gaard keeps your data, how to change it, and GDPR compliance.

Complete reference for the Gaard REST API: endpoints, response schemas, webhooks, and scoring.

API v3.0 Overview Base URL, authentication, and the shape of the API.

Endpoints Classify videos, retrieve results, and manage labels.

Response Structure Full response schema returned by the classify and results endpoints.

Classification Result Detailed classification result type, status constants, and video fields.

Webhooks Configure webhooks, understand when they fire, and inspect payloads.

Risk, Labels, and Scores How Gaard derives risk levels and labels from classification scores.