Call the /scribe API Endpoint
4 min
API request
Below are the details of the API endpoint that needs to be called before installing and initialising the SDK.
Call Autoscriber Endpoint
POST
https://io.autoscriber.com/v1/scribe
API response
The response received will be dependent on which communication method was incldued 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"}],
"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>"
}You must then use the API response from /scribe (above) when initialising the SDK.