Skip to main content

API Reference

ShieldLabs exposes two sets of endpoints:

Public Endpoints (no JWT required)

These endpoints use your public_key and secret_key directly in the URL. Use them from your server to query session data.
EndpointDescription
GET /pub/{public_key}/{secret_key}/debug/{search_type}/{value}Debug snapshots — last 1–20 sessions
GET /pub/{public_key}/{secret_key}/history/{search_type}/{value}Full history with pagination

Dashboard API (JWT required)

Used by the ShieldLabs dashboard. Available for programmatic access if needed. Base URL: https://api.shieldlabs.ai Authentication: Authorization: Bearer <access_token> Get a token via POST /api/auth/login.

Overview

Authentication, base URLs, and conventions

Data Models

Site, Snapshot, Score, Pattern, and other schemas

Debug Snapshots

Query recent sessions by identifier

Session History

Paginated history for any identifier

Score Query

Get score for a specific session

Webhook Verify

Verify webhook signatures