API Reference

REST API

Complete reference for Inpera REST API endpoints

API Overview

The Inpera REST API provides programmatic access to all Inpera features. All API requests are made over HTTPS to api.inpera.app.

The API uses standard HTTP methods and response codes. All responses are in JSON format.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Core Endpoints

Here are the main API endpoints:

MethodEndpointDescription
GET/v1/snapshotsList all snapshots
POST/v1/snapshotsCreate a new snapshot
GET/v1/snapshots/:idGet snapshot details
POST/v1/annotationsCreate an annotation

Example Request

Here's an example of creating a snapshot:

const response = await fetch('https://api.inpera.app/v1/snapshots', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://example.com',
    name: 'Homepage',
    projectId: 'your-project-id'
  })
});

const snapshot = await response.json();