API Reference / API Reference
API Reference

API Reference

Reference for every Detectivision API endpoint: moderation checks, live sessions, actions, flags and status, with schemas and an OpenAPI 3.1 file.

On this page

The Detectivision API is a JSON-over-HTTPS API. Every endpoint is described here, and in machine-readable form in the OpenAPI 3.1 file.

Base URL https://api.detectivision.ai
Authentication Api-Key: <your key> header on every endpoint except status. See Authentication.
Format JSON requests and responses (Content-Type: application/json), except files: live frames are sent as raw images, censored copies and stream samples come back as images or videos.
Times Unix seconds (startedAt, endedAt) or ISO 8601 (updatedAt).
Versioning The version is in the path (/api/v1). Fields may be added to responses without a new version; existing fields and their meaning do not change.
Calling from browsers Not supported: call the API from your server, so your key stays secret.

Moderation#

Endpoint
POST /api/v1/moderation Moderate content
GET /api/v1/moderation/{id}/censored Download a censored copy
GET /api/v1/moderation/{id} Read a request back
POST /api/v1/moderation/{id}/actions Take one of your actions on a request
GET /api/v1/actions List your actions
GET /api/v1/flags List the flags your account may send

Live sessions#

Endpoint
GET /api/v1/live/sessions List live sessions
POST /api/v1/live/sessions Start a live session
GET /api/v1/live/sessions/{id} Get a live session and its results
DELETE /api/v1/live/sessions/{id} Stop a live session
POST /api/v1/live/sessions/{id}/frames Send a camera frame
GET /api/v1/live/sessions/{id}/frames/{seq} Get a stream sample's picture

Status#

Endpoint
GET /api/v1/status Get the service status
GET /api/v1/status/history Status history

Account#

Endpoint
GET /api/v1/account Read your account's name, email, plan and credits