API Reference

The Inpera API is built with NestJS and provides RESTful endpoints for all platform features.

Base URL

https://api.inpera.app

Modules

Endpoint	Description
Overview	API basics
Authentication	Login, register, tokens
Projects	Project CRUD
Annotations	Visual feedback
Webhooks	Event notifications
Errors	Error handling

Authentication

JWT-based with HTTP-only cookies:

Authorization: Bearer YOUR_TOKEN

Project key for embed script:

x-project-key: YOUR_PROJECT_KEY

Quick Examples

Create Annotation

POST /annotations
{
  "projectId": "uuid",
  "content": "Feedback text",
  "url": "https://example.com"
}

List Projects

GET /projects/organization/:orgId

Collect Data

POST /v1/collect
x-project-key: pk_xxx
{
  "snapshot": {...},
  "events": [...]
}