Complete reference documentation for the Canoptics API. Base URL: https://api.canoptics.ai/v1
Authenticate requests by including your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
API keys can be created and managed in your dashboard settings.
Canoptics uses standard HTTP response codes. Errors return JSON with a message and error code:
{
"error": {
"code": "invalid_api_key",
"message": "The API key provided is invalid or expired."
}
}
List endpoints support cursor-based pagination:
GET /v1/risks?limit=50&cursor=abc123
List all risk assessments with optional filtering.
| Name | Type | Description |
|---|---|---|
| region | string | Filter by region ID |
| min_score | number | Minimum risk score (0.0-1.0) |
| limit | integer | Number of results (default: 50, max: 200) |
{
"data": [
{
"id": "risk_abc123",
"span_id": "span_xyz789",
"risk_score": 0.87,
"clearance_m": 1.2,
"growth_rate_m_yr": 2.4,
"species": ["oak", "pine"],
"updated_at": "2026-02-22T10:00:00Z"
}
],
"has_more": true,
"cursor": "next_page_cursor"
}
Retrieve a specific risk assessment by ID.
List all spans in your network.
| Name | Type | Description |
|---|---|---|
| corridor_id | string | Filter by corridor |
| include_geometry | boolean | Include GeoJSON geometry |
Bulk import span data from GIS formats.
List generated work orders.
Generate new work orders based on current risk scores.
{
"region_id": "region_abc",
"min_risk_score": 0.7,
"group_by": "area",
"max_orders": 100
}
List all regions in your organization.