Jump to Content
Home
Documentation
Recipes
APIs & SDKs
Discussions
Log In
APIs & SDKs
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Documentation
Recipes
APIs & SDKs
Discussions
Get one
Search
JUMP TO
Overview
Formant API & SDK Overview
Agent SDK
Agent SDK installation and overview
Telemetry data ingestion
Ingesting basic datapoints
Managing datapoint throttling
Charting numeric data
Streaming image and video data
Teleop
Handling teleop command streams
Sending teleop observe streams
Example of sending and receiving data
Receiving teleop heartbeats
Teleop Button Status
Handling commands
Creating events
Reading application configuration
Buffering and retrying API calls
Use the Formant agent to authenticate API calls
Agent SDK reference
Troubleshooting
Detect if agent is unable to upload data
Protos
Cloud SDK
Cloud SDK installation and overview
Cloud SDK reference
Troubleshooting
Web Toolkit
Web Toolkit Overview
Data SDK
A tour of the Data SDK
Intermodule Communication
Real-Time Connections with WebRTC
Connect over a local network
Build a React Native app with Formant functionality
Build a Node.js app with Formant functionality
Data SDK Reference
UI SDK
Adding a custom view to Formant
URL Query Parameters
SDK Versions, Distributions, Changelogs, and Licensing
fctl
fctl overview and installation
SSH to your robot via fctl
Port forwarding via fctl
File transfer over Secure Copy Protocol (SCP) via fctl
Create and configure devices programmatically via fctl
Create service account using fctl
Query data via fctl
Configure a VPN connection to your robot via SSH
Troubleshooting fctl
SSO
Configure OpenID Connect (OIDC) SSO via API
Formant admin-api
Account
Post
post
List
get
Get one
get
Patch
patch
Delete
delete
Get account tree
get
Get children
get
Adapter
Post
post
List
get
Get one
get
Patch
patch
Delete
delete
Annotation
Post
post
Get one
get
Patch
patch
Delete
delete
Annotation Template
Post
post
Get one
get
Patch
patch
Delete
delete
List
get
Query annotation field values
post
Inspect spreadsheet
post
Auth
Generate an auth token for an embedded view
Login
post
Check sso
post
Login sso
post
Login external
post
Login google
post
Refresh
post
Create service account
post
Forgot password
post
Resend invitation
post
Confirm forgot password
post
Resend confirmation code
post
Change password
post
Device credentials
post
Get features
get
Command
Post
post
Patch
patch
Get one
get
Query
post
Command Template
Post
post
Get one
get
Patch
patch
Delete
delete
List
get
Custom Event
Post
post
Batch
post
Device
Post
post
Provision device
post
Filter
post
Query
post
Count
post
Get tags
post
Get one
get
Patch
patch
Disable
post
Put configuration
put
Get commands
get
Get views
get
Generate device provisioning token
post
Unprovision device
post
Post configuration
post
Validate stream configuration
post
Get configuration
get
Get updated configuration
get
Get geo ip
get
Get updated agent version
get
Device Details
Get all
post
Get one
get
Document Set
Get all
get
Create
post
Get one
get
Update
patch
Delete
delete
Event
Get one
get
Query
post
Count
post
Counts
post
Counts by device
post
Event types
post
Users
post
Annotation templates
post
Devices
post
Stream types
post
Stream names
post
Tags
post
Severities
post
Histogram
post
View
post
Export sheet
post
Seek
post
File
Begin upload
post
Complete upload
post
List
get
Get
get
Patch
patch
Delete
delete
Get url
get
Query
post
Fleet
Post
post
List
get
Get one
get
Patch
patch
Delete
delete
Get devices
get
Insight
Get all
get
Create
post
Get one
get
Update
patch
Delete
delete
Get latest
get
Insight Result
Get all
get
Create
post
Get one
get
Delete
delete
Intervention Request
List
get
Get one
get
Patch
patch
Post
post
Intervention Response
Post
post
Key Value
Store item
post
List
get
Query
post
Remove item
delete
Role
Post
post
List
get
Get one
get
Patch
patch
Delete
delete
Schedule
Post
post
Get one
get
Patch
patch
Delete
delete
Query
post
Tag Template
Post
post
List
get
Get one
get
Delete
delete
Task Summary
Post
post
Batch
post
Delete
delete
Task Summary Format
Post
post
List
get
Teleop View
Get all
get
Get one
get
User
Post
post
Get all
get
Get one
get
Patch
patch
Get strategy
get
Query
post
Get user count per account id
get
View
Get all
get
Post
post
Get one
get
Patch
patch
Delete
delete
Reorder
post
Formant query-api
Analytics
List new rows
post
List aggregates
post
List tables with columns
get
List device streams
post
List task reports
post
Count
Active devices
post
Metadata
List metadata
post
List metadata with current value
post
List stream names
post
List device ids
post
Online Devices
Online
get
Last seen
get
Presence
Count
post
Count v 2
post
Query
Query
post
Export sheet
post
Seek
Seek
post
Stream Current Value
Query
post
Device streams
post
Usage Metrics
Query
post
Get one
get
https://api.formant.io/v1/admin/shares/
{code}
Get a share
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
