---
title: Call API Endpoint
slug: api-docs-v1/VxFC-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.
:::ApiMethodV2
```json
{
"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\": \"\",\n\"location\": \"https://io.autoscriber.com/v1/scribe/\", \n\"chunkLocation\": \"https://io.autoscriber.com/v1/scribe/\"\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 needs to be the template that you want generated based on the input provided. \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 needs to be the template that you want generated based on the input provided. \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."
}
]
},
{
"name": "patient",
"kind": "optional",
"type": "object",
"description": "",
"": "patient",
"children": [
{
"name": "gender",
"kind": "optional",
"type": "string",
"description": "Possible values: neutral, female, male"
}
],
"schema": [
{
"name": "gender",
"kind": "optional",
"type": "string",
"description": "Possible values: neutral, female, male"
}
]
}
],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Body Parameter",
"value": "bodyDataParameters"
},
"hasTryItOut": true,
"autoGeneratedAnchorSlug": "call-autoscriber-endpoint",
"legacyHash": "PcE839yrJyQNkNwWXxHDz"
}
```
:::
##
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](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` can be seen below:
```json
{
"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:
```json
{
"id": "",
"location": "https://io.autoscriber.com/v1/scribe/",
"chunkLocation": "https://io.autoscriber.com/v1/scribe/"
}
```
### JSON Posting chunks to chunkLocation
When posting audio chunks to the chunkLocation (like in this example), the following code can be used:
```json
{
"index": 0,
"base64": "",
"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 .