Generate consultation summary
Generates a consultation summary with information extracted from a raw text (stt, vtt, plain-text,…) transcription.
Below we will describe the entire process that allows the successful completion of consultation summary generation.
Request description
Endpoint: /api/v1/generate-consultation-summary
Method: POST
Remember: you can see the URL to consume this API in the Introduction section.
Header
{
"Content-Type": "application/json",
"Authorization": "Bearer <accessToken>"
}
Authorization: We'll pass the token obtained during the authentication process. You can reuse the generated tokens, as they have a 2-hour lifespan. Review this page: Credentials
To set the API version on a specific request, you can add a specific header named X-Invox-Medical-Api-Version with the value of the version you are targeting:
X-Invox-Medical-Api-Version: 2026-03-01
Payload structure
type IGenerateSummaryPayload = {
transcript: string;
outputFormat: SummaryOutputFormat;
outputLanguage: string;
};
type SummaryOutputFormat = "SUMMARY" | "SOAP_TEMPLATE";
Responses
Correct response
Successful request
Describe the characteristics of a satisfactory response
200
Response example:
{
"clinicalNote": "Clinical note content",
"generationTime": 6.52
}
interface IGenerateSummaryResponse {
clinicalNote: string | ISOAPTemplate;
generationTime: number;
}
interface ISOAPTemplate {
fields: ISOAPField[];
}
interface ISOAPField {
name: string;
description: string;
value: string;
}
Wrong responses
Unauthorized request
Describes the response when the request is not authorized
401
Response body
type GenerateConsultationSummaryResponseType = {
messsage: string;
};
Forbidden request
Describes the response when the API Key is not allowed to consume this service
403
Response body
type GenerateConsultationSummaryResponseType = {
messsage: string;
errorType: string;
};
CONSULTATION-SUMMARYBad request
Describe the features of a bad request
400
Response body
type GenerateConsultationSummaryResponseType = {
messsage: string;
errorType: GENERATE_CONSULTATION_SUMMARY_ERROR_TYPE;
}
enum GENERATE_CONSULTATION_SUMMARY_ERROR_TYPE {
INVALID_OUTPUT_FORMAT= 'invalidOutputFormat'
MISSING_OUTPUT_LANGUAGE = 'missingOutputLanguage',
INVALID_LANGUAGE = 'invalidLanguage',
}