Communication Methods

the autoscriber sdk and api support the following communication methods communication methods /#get communication methods /#socketio communication methods /#sse communication methods /#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" } }{ "id" "\<random id>", "location" "https //io autoscriber com/v1/scribe/\<random id>" } to retrieve the note, send a get to the location received in the previous step https //io autoscriber com/v1/scribe/\<random id> { \<note here> } 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" } } { "id" "\<random id>", "location" "https //io autoscriber com/v1/scribe/\<random id>", "endpoint" "https //autoscriber webpubsub azure com", "path" "/clients/socketio/hubs/autoscriber api", "token" "eyjhbgci " } { "index" 0, "base64" "\<string>", "final" false } { \<note here> } once you have sent the "final" true 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" } } { "id" "\<random id>", "location" "https //io autoscriber com/v1/scribe/\<random id>" "chunklocation" "https //io autoscriber com/v1/scribe/\<random id>" } { "index" 0, "base64" "\<string>", "final" false } { \<note here> } once you have sent the "final" true 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 "} } } } { "id" "\<random id>", "chunklocation" "https //io autoscriber com/v1/scribe/\<random id>" }