Call API Endpoint

api request 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 { "name" "call autoscriber endpoint", "method" "post", "url" "https //io autoscriber com/v1/scribe", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "jstw4zpbtvvjsuxlrvytt", "language" "curl", "code" "", "customlabel" "" }, { "id" " xo5rcnlj qr5t9lcguwu", "language" "javascript", "code" "", "customlabel" "" }, { "id" "xgkco3ztyqaatapgptcck", "language" "python", "code" "", "customlabel" "" }, { "id" "zimrblzqmsgdc1ijzfd a", "language" "java", "code" "", "customlabel" "" } ], "selectedlanguageid" "jstw4zpbtvvjsuxlrvytt" }, "results" { "languages" \[ { "id" "lbnejup76ixy1fctw6vk8", "language" "200", "code" "{\n\\"id\\" \\"\<id>\\",\n\\"location\\" \\"https //io autoscriber com/v1/scribe/\<id>\\", \n\\"chunklocation\\" \\"https //io autoscriber com/v1/scribe/\<id>\\"\n}", "customlabel" "" } ], "selectedlanguageid" "lbnejup76ixy1fctw6vk8" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "api key", "kind" "required", "type" "string", "description" "your api key received in the previous step", "" "your api key received in the previous step" }, { "name" "content type", "kind" "required", "type" "string", "description" "value application/json", "" "required" } ], "bodydataparameters" \[ { "name" "priority", "kind" "optional", "type" "integer", "description" "value between 1 9, you can prioritise certain requests within your bandwidth ", "" "value between 1 9, you can prioritise certain requests within your bandwidth " }, { "name" "billingreference", "kind" "required", "type" "string", "description" "this is the value (between 0 and 40 characters) autoscriber uses to distinguish between ehrs, environments and customers therefore, please use the following guidelines \n\nehr test environment \n\n\\"ehrname test\\"\n\nehr prod environment \n\n\\"ehrname prod\\"\n\nonce a customer starts using the integration, please use the following guidelines \n\n\\"ehrname customername test\\" or \\"ehrname customername prod\\"\n", "" "this is the value (between 0 and 40 characters) autoscriber uses to distinguish between ehrs, environments and customers therefore, please use the following guidelines \n\nehr test environment \n\n\\"ehrname test\\"\n\nehr prod environment \n\n\\"ehrname prod\\"\n\nonce a customer starts using the integration, please use the following guidelines \n\n\\"ehrname customername test\\" or \\"ehrname customername prod\\"\n" }, { "name" "userid", "kind" "optional", "type" "string", "description" "an optional userid that enables the api to personalise the response value must between 0 and 40 characters ", "" "an optional userid that enables the api to personalise the response value must between 0 and 40 characters " }, { "name" "communication", "kind" "required", "type" "object", "description" "configuring the communication methods (see category in the left panel)", "" "configuring the communication methods (see category in the left panel)", "children" \[ { "name" "method", "kind" "required", "type" "string", "description" "see communication methods category in the left panel\n\noptions include get|socketio|sse|webhook" }, { "name" "webhook", "kind" "optional", "type" "object", "description" "required if method==webhook", "children" \[ { "name" "url", "kind" "optional", "type" "string", "description" "the url autoscriber should call (required if method==webhook)" }, { "name" "headers", "kind" "optional", "type" "string", "description" "optional headers autoscriber will use when posting to your url (e g auth headers)" } ] } ], "schema" \[ { "name" "method", "kind" "required", "type" "string", "description" "see communication methods category in the left panel\n\noptions include get|socketio|sse|webhook" }, { "name" "webhook", "kind" "optional", "type" "object", "description" "required if method==webhook", "children" \[ { "name" "url", "kind" "optional", "type" "string", "description" "the url autoscriber should call (required if method==webhook)" }, { "name" "headers", "kind" "optional", "type" "string", "description" "optional headers autoscriber will use when posting to your url (e g auth headers)" } ] } ] }, { "name" "in", "kind" "required", "type" "object", "description" "the inputs needed for the api this is either \\"conversation\\", \\"text\\" or \\"transcript\\" ", "" "required", "children" \[ { "name" "type", "kind" "required", "type" "string", "description" "the type of input, either \\"conversation\\", \\"text\\" or \\"transcript\\" " }, { "name" "language", "kind" "required", "type" "string", "description" "the language of the input must be one of the supported languages en|nl|de " }, { "name" "audiotype", "kind" "optional", "type" "string", "description" "required if type == conversation\n\nthe format of the audio options include mp3,webm, wav, flac, ogg, m4a " }, { "name" "text", "kind" "optional", "type" "string", "description" "required if type==text\n\nthe text that needs to be summarised" }, { "name" "transcript", "kind" "optional", "type" "string", "description" "required if type==transcript\n\nthe transcript of the conversation, which needs to be in the below format \n\n{\\"text\\" \\"i have a headache \\", \\"speaker\\" \\"patient\\"}, {\\"text\\" \\"since when?\\", \\"speaker\\" \\"doctor\\"}, {\\"text\\" \\"since a couple of weeks, its very busy at work\\", \\"speaker\\" \\"patient\\"}" } ], "schema" \[ { "name" "type", "kind" "required", "type" "string", "description" "the type of input, either \\"conversation\\", \\"text\\" or \\"transcript\\" " }, { "name" "language", "kind" "required", "type" "string", "description" "the language of the input must be one of the supported languages en|nl|de " }, { "name" "audiotype", "kind" "optional", "type" "string", "description" "required if type == conversation\n\nthe format of the audio options include mp3,webm, wav, flac, ogg, m4a " }, { "name" "text", "kind" "optional", "type" "string", "description" "required if type==text\n\nthe text that needs to be summarised" }, { "name" "transcript", "kind" "optional", "type" "string", "description" "required if type==transcript\n\nthe transcript of the conversation, which needs to be in the below format \n\n{\\"text\\" \\"i have a headache \\", \\"speaker\\" \\"patient\\"}, {\\"text\\" \\"since when?\\", \\"speaker\\" \\"doctor\\"}, {\\"text\\" \\"since a couple of weeks, its very busy at work\\", \\"speaker\\" \\"patient\\"}" } ] }, { "name" "out", "kind" "required", "type" "object", "description" "the types of outputs required", "" "required", "children" \[ { "name" "type", "kind" "optional", "type" "string", "description" "this refers to the templates that you want to make available for selection \n\nsee the \\"templates\\" tab for specific template names and values available " }, { "name" "togglecodes", "kind" "optional", "type" "boolean", "description" "to indicate if you want to receive medical coding with the note " }, { "name" "coding systems", "kind" "optional", "type" "string", "description" "whether snomed ct or icd10 medical codes are generated \n\nif coding is needed, then either \\"snomed ct\\" or \\"icd10\\" must be included \n\nif togglecodes is set as true, then this is required \n\nif togglecodes is false, this line must be left out " } ], "schema" \[ { "name" "type", "kind" "optional", "type" "string", "description" "this refers to the templates that you want to make available for selection \n\nsee the \\"templates\\" tab for specific template names and values available " }, { "name" "togglecodes", "kind" "optional", "type" "boolean", "description" "to indicate if you want to receive medical coding with the note " }, { "name" "coding systems", "kind" "optional", "type" "string", "description" "whether snomed ct or icd10 medical codes are generated \n\nif coding is needed, then either \\"snomed ct\\" or \\"icd10\\" must be included \n\nif togglecodes is set as true, then this is required \n\nif togglecodes is false, this line must be left out " } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" true } api response api response the response received will be dependent on which communication method method was incldued in the api request body the available communication methods methods and associated responses can be seen here communication methods docid\ yrcjraaamdwoiqwdclhkj 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 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>" } 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