API ReferenceAPI overview

API Reference

This portal links the public-safe DrSimon API surface used by partner SDKs and host applications.

Core endpoints

AreaEndpointsPurpose
SessionsPOST /api/v1/sessions/start, POST /api/v1/sessions/endBind lifecycle, product, tenant, and device profile
IngestPOST /api/v1/engine/ingestUpload primitive observations only
ProctoringPOST /api/v1/engine/proctoring/session/startStart tenant-scoped proctoring analysis
Reports/api/v1/reports/*Fetch report references and summaries
Segments/api/v1/segments/*Fetch segment-level analysis outputs

Required headers

Authorization: Bearer <partner-or-host-token>
X-DrSimon-Protocol: 1
X-DrSimon-SDK: <platform>/<version>
X-DrSimon-Tier: 0
X-DrSimon-Batch-Id: <ulid>
Content-Type: application/json

Runtime OpenAPI

Use the deployed engine OpenAPI when validating integration details:

  • Test engine: https://test-engine.drsimon.ai/docs
  • Production engine: https://engine.drsimon.ai/docs