API Metadata Guide

Using Metadata with Beyond Verbal REST API

Metadata field of the START request allows to attach arbitrary information to each analysis session.

Most common usage of the metadata field is to uniquely identify particular user, device or group of users for later aggregated analysis. We highly recommend not to provide any personal information for this purpose. We recommend to generate speaker IDs in form of number using hash.

Set the clientId field value to your unique identifier. Example

POST 5 https://apiv5.beyondverbal.com/api/v5/recording/start

Authorization: Bearer 21G2BA4iZJavSJQbsyuppWmfSMLgLn-**gDTCfguhzGa_k8

{
“dataFormat”: {“type”: “WAV”},
“metadata”:{“clientId” : some speaker ID, for example 111222}
}

Example where clientId is a phone number:

POST https://apiv5.beyondverbal.com/api/v5/recording/start

Authorization: Bearer 21G2BA4iZJavSJQbsyuppWmfSMLgLn-**gDTCfguhzGa_k8

{
  “dataormat”: {“type”: “WAV”},
  “metadata”:{“clientId”: “+991199483679”, “phone” : “+991199483679”}
}


Example where the clientId is email:

POST https://apiv5.beyondverbal.com/api/v5/recording/start

Authorization: Bearer 21G2BA4iZJavSJQbsyuppWmfSMLgLn-**gDTCfguhzGa_k8

{
    “dataormat”: {“type”: “WAV”},
     “metadata”:{
          “clientId”: “someone@someplace.com”,
            “email” : “someone@someplace.com”
      }
}