API Reference

Raad API

RESTful API for aerial data collection and site management

Overview

The Raad API provides a RESTful interface for managing your account's campaigns, sites, and collected aerial data. All endpoints return JSON:API formatted responses and follow standard HTTP conventions.

Pagination — List endpoints support pagination using page and per_page query parameters. Default page size is 25, maximum is 100.

Filtering — Most collection endpoints support filtering. Check individual resource documentation for supported filters.

Base URL

All API requests should be made to:

https://app.raad.com/api/v1

Authentication

All API endpoints (except sign-in) require a JWT Bearer token. Obtain a token via the Authentication endpoint, then include it in every request:

cURL
curl https://app.raad.com/api/v1/campaigns \
  -H "Authorization: Bearer <JWT_TOKEN>"

Resources

The API exposes the following core resources:

Campaigns

3 endpoints

  • GET /api/v1/campaigns
  • POST /api/v1/campaigns
  • GET /api/v1/campaigns/{id}

Sites

7 endpoints

  • GET /api/v1/sites
  • POST /api/v1/sites
  • GET /api/v1/sites/{id}
  • GET /api/v1/sites/{site_id}/geometries
  • POST /api/v1/sites/{site_id}/geometries
  • GET /api/v1/sites/{site_id}/geometries/{id}
  • PATCH /api/v1/sites/{site_id}/geometries/{id}

Artifacts

5 endpoints

  • GET /api/v1/artifacts
  • GET /api/v1/artifacts/favorites
  • GET /api/v1/artifacts/{id}
  • GET /api/v1/artifacts/{id}/download
  • GET /api/v1/artifacts/{id}/thumbnail

Data Models

For detailed information about the structure of each resource, see the Data Models reference.