Documentation

Getting Started with Canoptics

Everything you need to integrate and use the Canoptics vegetation intelligence platform.

Introduction

Canoptics is a vegetation intelligence platform that uses satellite imagery, LiDAR data, and machine learning to predict vegetation risk for critical infrastructure. This documentation covers everything you need to integrate Canoptics into your operations.

Key Features

  • Growth Prediction: Forecast vegetation growth 6+ months ahead
  • Risk Scoring: Continuous risk assessment for every asset
  • Work Order Generation: Automated prioritization and dispatch
  • GIS Integration: Native support for ArcGIS, QGIS, and more

Quickstart

Get up and running with Canoptics in minutes. This guide assumes you have access to your API credentials from the dashboard.

1. Install the SDK

Install the Canoptics SDK using your preferred package manager:

npm install @canoptics/sdk

Or using pip for Python:

pip install canoptics

2. Initialize the Client

import { Canoptics } from '@canoptics/sdk'; const client = new Canoptics({ apiKey: process.env.CANOPTICS_API_KEY, region: 'us-west-2' });

3. Query Risk Data

// Get high-risk spans in a region const risks = await client.risks.list({ region: 'western-grid', minRiskScore: 0.8, limit: 100 }); console.log(`Found ${risks.length} high-risk spans`);

Authentication

All API requests require authentication using an API key. You can generate API keys from the Canoptics dashboard under Settings → API Keys.

API Key Authentication

Include your API key in the Authorization header:

curl https://api.canoptics.ai/v1/risks \ -H "Authorization: Bearer YOUR_API_KEY"

Data Model

Canoptics organizes data around a hierarchical structure of regions, corridors, and spans. Understanding this model is key to effective integration.

Regions

Top-level organizational units, typically representing service territories or geographic areas.

Corridors

Linear infrastructure routes (transmission lines, distribution feeders, pipelines, etc.) within a region.

Spans

Individual segments between structures (poles, towers). This is the primary unit of analysis for vegetation risk.

Risk Scoring

Each span receives a risk score from 0.0 to 1.0, updated weekly as new satellite imagery is processed.

Score Components

  • Clearance Score: Current distance between vegetation and conductors
  • Growth Score: Predicted encroachment based on species and growth rate
  • Failure Score: Probability of vegetation-caused failure
  • Impact Score: Consequence severity if failure occurs

Work Orders

Canoptics can automatically generate and prioritize work orders based on risk scores and your configured thresholds.

// Generate work orders for high-risk spans const workOrders = await client.workOrders.generate({ region: 'western-grid', minRiskScore: 0.7, groupByArea: true }); // Export to your work management system await client.workOrders.export(workOrders, { format: 'maximo', includeGeometry: true });

GIS Integration

Export risk data directly to your GIS platform for visualization and analysis.

Supported Formats

  • Shapefile (.shp)
  • GeoJSON
  • KML/KMZ
  • File Geodatabase

ArcGIS Integration

Connect Canoptics directly to ArcGIS Online or ArcGIS Enterprise:

// Sync to ArcGIS feature layer await client.integrations.arcgis.sync({ featureServiceUrl: 'https://your-org.maps.arcgis.com/...', layerId: 'vegetation_risks', updateMode: 'replace' });

API Overview

The Canoptics API is organized around REST principles. All endpoints return JSON and use standard HTTP response codes.

For complete API documentation, see the API Reference.

Webhooks

Receive real-time notifications when risk scores change or new high-risk spans are identified.

// Example webhook payload { "event": "risk.threshold_exceeded", "timestamp": "2026-02-22T14:30:00Z", "data": { "span_id": "span_abc123", "risk_score": 0.87, "previous_score": 0.65, "factors": ["rapid_growth", "storm_damage"] } }

Need help?

Our team is here to help you get the most out of Canoptics.