API reference

The AcuSight REST API gives you programmatic access to the platform — devices, projects and datasets, training and models, and metrics. Every endpoint page in this section is generated from the platform’s OpenAPI spec, so it stays current with the running API.

New to the API? REST API overview & auth is the friendlier starting point — base URL, auth, and the endpoints you’ll reach for first. This page orients you to the generated reference.

Base URL

All requests go to your AcuSight host under the /api prefix:

https://acusight.io/api

Self-managed deployments use your own host in place of acusight.io.

Authentication

Two credentials, for two audiences: Bearer token — user API. For everything you do as a signed-in user. The token comes from an authenticated AcuSight session and is automatically scoped to your organization. Grab yours from a signed-in session in a few seconds — see Get your token.

curl https://acusight.io/api/organization \
  -H "Authorization: Bearer <TOKEN>"

Device key — device API. Edge agents authenticate with a device key (adk_…) issued during provisioning. It only works for /device/... endpoints — it isn’t a general-purpose API key.

curl https://acusight.io/api/device/self \
  -H "X-Device-Key: adk_<DEVICE_KEY>"

More on tokens and org scoping in the overview.

Response format

Responses are JSON. Most endpoints return a consistent envelope:

{
  "success": true,
  "data": { ... },
  "meta": { "total": 100, "count": 20, "offset": 0, "limit": 20 }
}

Errors use the same envelope with success: false and an error object carrying a code, a message, and optional details.

Pagination

List endpoints accept limit (default 50) and offset (default 0), and return total, count, offset, and limit in meta:

curl "https://acusight.io/api/data/batches?limit=50&offset=50" \
  -H "Authorization: Bearer <TOKEN>"

Browse the reference

The pages in this section are generated from the OpenAPI spec — grouped by service, with parameters, request bodies, and response schemas for every endpoint. Treat them as the source of truth; the overview covers the conventions (auth, envelope, pagination, org scoping) that apply across all of them.

API reference

Base URL

Authentication

Response format

Browse the reference

Next steps

REST API overview & auth

Co-Pilot & MCP

​Base URL

​Authentication

​Response format

​Pagination

​Browse the reference

​Next steps

REST API overview & auth

Co-Pilot & MCP

Base URL

Authentication

Response format

Pagination

Browse the reference

Next steps