Call API Endpoint
API request
Below are the details of the API endpoint that needs to be called in order to receive the embedLocation, which will be used to embed in the iframe.
API response
The response received will be dependent on which communication method was included in the API request body.
The available communication methods and associated responses can be seen here: Communication Methods
API example
Request body
A simple example using text as input can be seen here: https://support.autoscriber.com/article/314-scribe-api-text-example
An example of the API request bosy using audio (where the communication method is SSE can be seen below:
{
"priority": 1,
"billingReference": "EHRName_Test",
"userId": "user123",
"communication": [{"method":"SSE"}],
"patient": [{"gender":"male"}],
"in": [{"type":"conversation", "language":"en", "audioType":"mp3"}],
"out": [{"type":"standard_en", "togglecodes":true, "coding_systems":SNOMED_CT}]
} API example response
An example response to the above request can be seen below:
{
"id": "<ID>",
"location": "https://io.autoscriber.com/v1/scribe/<ID>",
"chunkLocation": "https://io.autoscriber.com/v1/scribe/<ID>"
}JSON Posting chunks to chunkLocation
When posting audio chunks to the chunkLocation (like in this example), the following code can be used:
{
"index": 0,
"base64": "<STRING>",
"final": false
}Since this example has the communication method SSE , once you have sent the "final": true audio chunk, you will receive the resultant summary and transcript via the connection established with the location .