Intervention Requests

Intervention requests are the ability for a device or server to request some kind of user interaction to occur on a device. We have APIs that represent the list of intervention requests, creation of new intervention requests, and the appending of data to those requests.

Getting a list of intervention requests

GET https://api.formant.io/v1/admin/intervention-requests

Creating a new intervention request

POST https://api.formant.io/v1/admin/intervention-requests

{
    "message": "A teleop for a customer is requested",
    "interventionType": "teleop",
    "time": "2022-02-17T11:41:33.389-08:00",
    "deviceId": "b306de84-33ca-4917-9218-f686730e24e0",
    "tags": {},
    "data": {
        "instruction": "Look at the users item on the table"
    }
}

Adding response to intervention request

POST https://api.formant.io/v1/admin/intervention-responses

{
    "interventionId": "518e24fc-64ef-47bb-be5e-036a97aeafaa",
    "interventionType": "teleop",
    "data": {
        "state": "success",
        "notes": "looks good!"
    }
}

Did this page help you?