Formant Admin API

aid: formant:formant-admin-api
name: Formant Admin API
description: Formant's primary REST API, served from `https://api.formant.io/v1/admin`. Covers devices,
  fleets, streams, views, teleop views, commands and command templates, schedules, events and custom events,
  annotations and annotation templates, files (multipart begin/complete upload), key-value storage, intervention
  requests and responses, document sets, insights, roles, users, service accounts, tag templates, task
  summaries and task-summary formats, sharing tokens, analytics (aggregates, datapoints, table/columns,
  task reports), presence and online-device monitoring, usage metrics, and stream current-value queries.
  Endpoints follow a `<resource>controller` naming convention (e.g. `devicecontrollerquery`, `eventcontrollerhistogram`,
  `fleetcontrollergetdevices`). The reference is rendered as ReadMe-hosted OpenAPI pages but Formant does
  not publish a single downloadable OpenAPI spec file.
humanURL: https://docs.formant.io/reference
baseURL: https://api.formant.io/v1/admin
tags:
- Admin
- Devices
- Fleets
- Streams
- Events
- Commands
- Teleoperation
properties:
- type: Documentation
  url: https://docs.formant.io/reference
- type: Documentation
  url: https://docs.formant.io/reference/devicecontrollerpost
- type: Documentation
  url: https://docs.formant.io/reference/fleetcontrollerlist
- type: Documentation
  url: https://docs.formant.io/reference/eventcontrollerquery
- type: Documentation
  url: https://docs.formant.io/reference/commandcontrollerpost
- type: Documentation
  url: https://docs.formant.io/reference/viewcontrollerpost
- type: Documentation
  url: https://docs.formant.io/reference/interventionrequestcontrollerpost
- type: Documentation
  url: https://docs.formant.io/reference/filecontrollerbeginupload
- type: Documentation
  url: https://docs.formant.io/reference/analyticscontrollerlistaggregates
- type: Documentation
  url: https://docs.formant.io/reference/authcontrollerlogin
- type: Authentication
  url: https://docs.formant.io/reference/authcontrollerlogin
- type: ServiceAccount
  url: https://docs.formant.io/docs/getting-started-create-a-service-account