api-reference
REST API
Overview

REST API Overview

The Interstitial REST API provides direct HTTP access to services and data.

Base URL

http://localhost:3001/api/v1

Endpoints

Services

  • GET /services - List all available services
  • GET /services/:id - Get service metadata
  • GET /services/:id/health - Check service health
  • POST /services/:id/mcp - MCP protocol endpoint

Sensors

  • GET /sensors - List sensors
  • GET /sensors/:id - Get sensor details
  • POST /sensors/:id/mcp - Sensor-specific MCP endpoint

Projects

  • GET /projects - List projects/feeds
  • GET /projects/:id - Get project details
  • POST /projects/:id/mcp - Project-specific MCP endpoint

Authentication

All endpoints require an API key in the x-api-key header.

Response Format

All responses are JSON. Errors follow this format:

{
  "error": "Error message",
  "code": "ERROR_CODE"
}

Rate Limits

Rate limits are applied per API key. Check response headers for limit information.

OverviewProjects