Get Running in 5 Minutes
Install the SDK and start building inspection apps immediately.
Install the SDK
npm install @inspectapi-io/sdkInitialize the Client
import { InspectAPI } from '@inspectapi-io/sdk';
const api = new InspectAPI({
apiKey: 'your-api-key',
tenant: 'your-tenant-id',
});Create Your First Inspection
// Create a new inspection
const inspection = await api.inspections.create({
templateId: 'fire-safety',
locationId: location.id,
assignedTo: inspector.id,
});
// SDK handles offline sync automatically!What the SDK Handles for You
Focus on building your UI—we handle the hard parts.
Offline-First
All operations work without internet. Data syncs when back online.
Smart Sync
Intelligent conflict resolution and background sync with retry logic.
Local Cache
IndexedDB-backed cache for instant access to templates and data.
Photo Compression
Automatic image optimization before upload (configurable quality).
PWA Ready
Service worker integration for true offline PWA experience.
TypeScript
Full TypeScript definitions with autocomplete and type safety.
Common Operations
Fetch Templates
Get all inspection templates available for your tenant.
// Fetch available templates
const templates = await api.templates.list();
// Each template includes:
// - Checklist items
// - Scoring rules
// - Required fields
// - Photo requirementsSave Findings
Record inspection findings with photos—works offline!
// Save a finding (works offline!)
const finding = await api.findings.create({
inspectionId: inspection.id,
itemId: 'fire-extinguisher-check',
status: 'fail',
severity: 'high',
notes: 'Extinguisher expired',
photos: [photoBlob], // SDK compresses automatically
});Resources
Additional tools and references for developers
npm Packages
JavaScript/TypeScript SDK and plugins.
Bubble Plugin
Native integration for Bubble.io apps.
Coming SoonAPI Reference
Full REST API documentation.
Coming SoonTutorials
Step-by-step integration guides.
Coming SoonReady to Start Building?
Contact us and start building inspection apps today.