Communication Methods
The Autoscriber SDK and API support the following communication methods:
- Get
- SSE
- Webhook
Get
This is the simplest option but not recommended as you won't get any real-time results.
{
... rest of body
"communication": {
"method": "get"
}
}To retrieve the note, send a Get to the location received in the previous step:
https://io.autoscriber.com/v1/scribe/<RANDOM ID>Socket.io
This will set up a socket connection for you to send your audio over and it will return resuls in real-time.
{
... rest of body
"communication": {
"method": "socketio"
}
}{
"index": 0,
"base64": "<STRING>",
"final": false
}Once you have sent the "final": true audio chunk, you will receive the final note via the socket established (seen in the response of the above POST).
SSE
Using server-sent events the response with contain a keep-alive header and sends back results in real-time.
{
... rest of body
"communication": {
"method": "sse"
}
}{
"index": 0,
"base64": "<STRING>",
"final": false
}Once you have sent the "final": true audio chunk, you will receive the resultant summary and transcript via the connection established with the location (seen in the response of the above POST).
Webhook
You provide a webhook which we'll call (in real-time) with the results. This does require that you have an endpoint that is available over the internet .
{
... rest of body
"communication": {
"method": "webhook",
"webhook": {
"url": "https://YOUR_ENDPOINT",
"headers": {"Authorization": "Basic ..."}
}
}
}