GuardX - AI-Powered Safety Monitoring

Quick Start

Get started with the GuardX API in minutes. All API requests require authentication using your API key.

1

Get your API key

Generate keys in Settings → API Keys

2

Make your first request

Test with the example on the right

3

Build your integration

Use webhooks for real-time events

cURL

curl https://api.guardx.cc/v1/incidents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Response
{
  "data": [
    {
      "id": "inc_2xK9mN3p",
      "type": "ppe_violation",
      "severity": "high",
      "device_id": "thor_cam_01",
      "timestamp": "2024-01-15T09:23:41Z",
      "resolved": false
    }
  ],
  "meta": {
    "total": 847,
    "page": 1
  }
}

Authentication

The GuardX API uses API keys for authentication. Include your key in the Authorization header of all requests.

API Keys

Generate multiple keys with different permissions. Rotate keys without downtime.

OAuth 2.0

Enterprise SSO integration with SAML and OpenID Connect support.

Scoped Permissions

Fine-grained access control for read, write, and admin operations.

Core Endpoints

Essential API endpoints for integrating GuardX into your systems.

GET /incidents

List all incidents

Retrieve a paginated list of safety incidents with filtering and sorting options.

?severity=high,critical ?device_id=thor_* ?since=2024-01-01 ?resolved=false

GET /incidents/{id}

Get incident details

Retrieve detailed information about a specific incident including media, timeline, and response actions.

GET /devices

List all devices

Get status and configuration for all Thor devices in your organization.

GET /analytics/summary

Get analytics summary

Aggregated safety metrics, trends, and KPIs for dashboards and reporting.

POST /webhooks

Create webhook

Register endpoints to receive real-time notifications for incidents, device status, and system events.

PUT /zones/{id}

Update safety zone

Configure detection zones, rules, and automated response actions.

Real-time Webhooks

Receive instant notifications when safety events occur. Configure multiple endpoints with event filtering.

Automatic retries with exponential backoff

HMAC signature verification

Event type filtering

Delivery logs and debugging tools

Event Types

incident.created incident.resolved device.offline zone.breach alert.triggered

Webhook Payload

{
  "id": "evt_3xL8nM4q",
  "type": "incident.created",
  "created": "2024-01-15T09:23:41Z",
  "data": {
    "incident": {
      "id": "inc_2xK9mN3p",
      "type": "ppe_violation",
      "severity": "high",
      "description": "Hard hat not detected",
      "device": {
        "id": "thor_cam_01",
        "name": "Loading Dock A",
        "location": "Building 3"
      },
      "zone": {
        "id": "zone_5",
        "name": "Construction Area"
      },
      "media": {
        "thumbnail": "https://...",
        "video_clip": "https://..."
      }
    }
  }
}