Call API Endpoint

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 initialized hgjhgi wdwedwe name call autoscriber endpoint method post url https io autoscriber com v1 embed description tab examples examples languages id fs6nhxaanhfb 9nd3ol7z language curl code customlabel id axn7ukb50g 0kspxg91e1 language javascript code customlabel id n6nlg3pjxxostxdst51ws language python code customlabel id e3ysjlc8 ufcqmo5bxv 8 language java code customlabel selectedlanguageid fs6nhxaanhfb 9nd3ol7z results languages id lbnejup76ixy1fctw6vk8 language 200 code n id id n location https api autoscriber com v1 embed id n embedlocation https embed autoscriber com ?token eyjhbgc n customlabel selectedlanguageid lbnejup76ixy1fctw6vk8 request pathparameters queryparameters headerparameters name api key kind required type string description your api key received in https app archbee com public preview jjb083silzjs ilbwklec preview wbkcgizdzikyxuo4swchy your api key received in https app archbee com public preview jjb083silzjs ilbwklec preview wbkcgizdzikyxuo4swchy 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 config kind required type object description configuring the embedded screen object children name webhook kind required type object description configuration for webhook children name url kind required type string description the url autoscriber should call when posting the note name headers kind optional type string description optional headers we ll use when posting to your url e g auth headers name displayname kind optional type string description display name for the user interface name gender kind optional type string description the patient s gender this can either me male female or leave this parameter blank if unknown name specialty kind optional type string description the user s specialty name preferredmicrophone kind optional type string description preferred microphone device id name interface language kind optional type array description languages the user can select from options include en nl de name templates kind optional type array description output types the user can select from see the section on templates here n nthe order in which you list the templates will determine what order they are displayed to users in the embedded app name sorttemplates kind optional type boolean description if this is left out the default value is true n nif true is assigned templates will be sorted alphabetical per available language n nif false templates will be sorted in the order that they are listed in the templates attribute name editing kind optional type boolean description allow the user to edit the text after the note gas been generated name crossorigintarget kind optional type string description optionally include the url of the parent if included the embedded app will push the state to the parent name theme kind required type object description change the main colour children name primarycolor kind required type string description a hex color string name exitaftersync kind optional type boolean description if yes the autoscriber app will close after the approve and synchronise button has been clicked and the generated note synced with your ehr name askconsent kind optional type boolean description whether the user has to click consent before recording name newtemplate kind optional type boolean description whether a user is allowed to generate multiple outputs 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 webhook kind required type object description configuration for webhook children name url kind required type string description the url autoscriber should call when posting the note name headers kind optional type string description optional headers we ll use when posting to your url e g auth headers name displayname kind optional type string description display name for the user interface name gender kind optional type string description the patient s gender this can either me male female or leave this parameter blank if unknown name specialty kind optional type string description the user s specialty name preferredmicrophone kind optional type string description preferred microphone device id name interface language kind optional type array description languages the user can select from options include en nl de name templates kind optional type array description output types the user can select from see the section on templates here n nthe order in which you list the templates will determine what order they are displayed to users in the embedded app name sorttemplates kind optional type boolean description if this is left out the default value is true n nif true is assigned templates will be sorted alphabetical per available language n nif false templates will be sorted in the order that they are listed in the templates attribute name editing kind optional type boolean description allow the user to edit the text after the note gas been generated name crossorigintarget kind optional type string description optionally include the url of the parent if included the embedded app will push the state to the parent name theme kind required type object description change the main colour children name primarycolor kind required type string description a hex color string name exitaftersync kind optional type boolean description if yes the autoscriber app will close after the approve and synchronise button has been clicked and the generated note synced with your ehr name askconsent kind optional type boolean description whether the user has to click consent before recording name newtemplate kind optional type boolean description whether a user is allowed to generate multiple outputs 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 query parameter value queryparameters hastryitout true response name id kind optional type string description the request id name location kind optional type string description e g https api autoscriber com v1 embed id children name embedlocation kind optional type string description e g https embed autoscriber com ?token eyjhbgc children an example of the api (also see on the right panel) is as follows { "priority" "1", "billingreference" "ehrname", "userid" "user123", "config" { "webhook" { "url" "https //example com/webhook", "headers" {"authorization" "bearer your token here"} }, "displayname" "jane doe", "gender" "female", "specialty" "gp", "preferredmicrophone" "device id 1234", "preferred languages" "nl", "languages" \["en", "nl"], "templates" \["standard en"], "sorttemplates" "false", "editing" \["true"], "crossorigintarget" "https //parent example com", "theme" { "primarycolor" "#ff5733" }, "exitaftersync" true, "askconsent" true, "newtemplate" true, "togglecodes" true, "coding systems" \["snomed ct"] } } similarly, an example response can be seen below { "id" "\<id>", "location" "https //api autoscriber com/v1/embed/\<id>", "embedlocation" "https //embed autoscriber com/?token=eyjhbgc " } for the response, the following can be noted the embedlocation is the full iframe src url , including the token the token is your jwt and is embedded as a query parameter in embedlocation you can use embedlocation directly as the value for the src attribute in your iframe