--- title: Call API Endpoint slug: api-docs-v1/call-api-endpoint docTags: createdAt: 2025-08-14T10:29:25.356Z --- 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 :::ApiMethodV2 ```json { "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\": \"\",\n \"location\": \"https://api.autoscriber.com/v1/embed/\",\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/", "children": [] }, { "name": "embedLocation", "kind": "optional", "type": "string", "description": "E.g.: https://embed.autoscriber.com/?token=eyJhbGc...", "children": [] } ], "autoGeneratedAnchorSlug": "call-autoscriber-endpoint", "legacyHash": "PcE839yrJyQNkNwWXxHDz" } ``` ::: An example of the API (also see on the right panel) is as follows: ```json { "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: ```json { "id": "", "location": "https://api.autoscriber.com/v1/embed/", "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.