menu logo

API/File/status

Get the current status and results of a file.

Authentication

All API requests require an API key to be included in the headers:

Authorization: Bearer [access-key]

Endpoint

GET https://infer.intron.health/file/v1/status/:file_id

Path variables

Field Type Description Required Default Options
file_id String the file id generated in response when the file was queued yes

Query params

Field Type Description Required Default Options
get_structured_post_processing String if true the post-processed results will be structured as json else it will be a MarkDown formated text no f f|t

Basic request and response sample

                    
                        curl --location 'https://infer.intron.health/file/v1/status/file-id' \
                        --header 'Authorization: Bearer my-api-key'
                    
                
                    
                    import requests

                    url = "https://infer.intron.health/file/v1/status/file-id"

                    payload = {}
                    headers = {
                        'Authorization': 'Bearer my-api-key'
                    }

                    response = requests.request("GET", url, headers=headers, data=payload)

                    print(response.text)
                    
                
                    
                        const myHeaders = new Headers();
                        myHeaders.append("Authorization", "Bearer my-api-key");
                        
                        const requestOptions = {
                          method: "GET",
                          headers: myHeaders
                        };
                        
                        fetch("https://infer.intron.health/file/v1/status/file-id", requestOptions)
                          .then((response) => response.text())
                          .then((result) => console.log(result))
                          .catch((error) => console.error(error));
                    
                
                    
                    {
                        "status": "Ok",
                        "message": "file status found",
                        "data": {
                        "processing_status": "FILE_TRANSCRIBED",
                        "audio_file_name": "file-1",
                        "audio_transcript": "hello world",
                        "processed_audio_duration_in_seconds": 20
                        }
                    }

Request and response with diarization

                    
                    {
                        "status": "Ok",
                        "message": "file status found",
                        "data": {
                        "processing_status": "FILE_TRANSCRIBED",
                        "audio_file_name": "file-1",
                        "audio_transcript": "
                            SPEAKER_01: Hello world.  
                            SPEAKER_02: Welcome.
                        ",
                        "processed_audio_duration_in_seconds": 20
                        }
                    }
                    
                
                    
                        curl --location 'https://infer.intron.health/file/v1/status/file-id' \
                        --header 'Authorization: Bearer my-api-key'
                    
                
                    
                    import requests

                    url = "https://infer.intron.health/file/v1/status/file-id"

                    payload = {}
                    headers = {
                        'Authorization': 'Bearer my-api-key'
                    }

                    response = requests.request("GET", url, headers=headers, data=payload)

                    print(response.text)
                    
                
                    
                        const myHeaders = new Headers();
                        myHeaders.append("Authorization", "Bearer my-api-key");
                        
                        const requestOptions = {
                          method: "GET",
                          headers: myHeaders
                        };
                        
                        fetch("https://infer.intron.health/file/v1/status/file-id", requestOptions)
                          .then((response) => response.text())
                          .then((result) => console.log(result))
                          .catch((error) => console.error(error));

Request and response using post processing file category of file_category_telehealth

                    
                    {
                        "status": "Ok",
                        "message": "file status found",
                        "data": {
                        "processing_status": "FILE_TRANSCRIBED",
                        "audio_file_name": "file-1",
                        "audio_transcript": "hello world",
                        "processed_audio_duration_in_seconds": 20,
                        "transcript_soap_note": "MarkDown formated text",
                        "transcript_summary": "MarkDown formated text",
                        "transcript_suggestions": "MarkDown formated text",
                        "transcript_differential_diagnosis": "MarkDown formated text",
                        "transcript_followup_instructions": "MarkDown formated text",
                        "transcript_practice_guidelines": "MarkDown formated text",
                        "transcript_entity_list": "MarkDown formated text",
                        "transcript_treatment_plan": "MarkDown formated text",
                        "transcript_clerking": "MarkDown formated text",
                        "transcript_icd_codes": "MarkDown formated text"
                        }
                    }
                    
                
                    
                        curl --location 'https://infer.intron.health/file/v1/status/file-id' \
                        --header 'Authorization: Bearer my-api-key'
                    
                
                    
                    import requests

                    url = "https://infer.intron.health/file/v1/status/file-id"

                    payload = {}
                    headers = {
                        'Authorization': 'Bearer my-api-key'
                    }

                    response = requests.request("GET", url, headers=headers, data=payload)

                    print(response.text)
                    
                
                    
                        const myHeaders = new Headers();
                        myHeaders.append("Authorization", "Bearer my-api-key");
                        
                        const requestOptions = {
                          method: "GET",
                          headers: myHeaders
                        };
                        
                        fetch("https://infer.intron.health/file/v1/status/file-id", requestOptions)
                          .then((response) => response.text())
                          .then((result) => console.log(result))
                          .catch((error) => console.error(error));

Request and response using post processing file category of file_category_telehealth with structured output

                
                {
                    "status": "Ok",
                    "message": "file status found",
                    "data": {
                        "processing_status": "FILE_TRANSCRIBED",
                        "audio_file_name": "file-1",
                        "audio_transcript": "hello world",
                        "processed_audio_duration_in_seconds": 20,
                        "transcript_soap_note": {
                            "text": "MarkDown formated text",
                            "subjective": "",
                            "objective": "",
                            "assessment": "",
                            "plan": ""
                        },
                        "transcript_summary": {
                            "text": "MarkDown formated text"
                        },
                        "transcript_suggestions": {
                            "text": "MarkDown formated text"
                        },
                        "transcript_differential_diagnosis": {
                            "text": "MarkDown formated text"
                        },
                        "transcript_followup_instructions": {
                            "text": "MarkDown formated text"
                        },
                        "transcript_practice_guidelines": {
                            "text": "MarkDown formated text"
                        },
                        "transcript_icd_codes": {
                            "text": "MarkDown formated text"
                        },
                        "transcript_entity_list": {
                            "text": "MarkDown formated text",
                            "patient_complaints": "",
                            "relevant_medical/surgical_history": "",
                            "examinations_and_examination_findings": ""
                            "medical_diagnosis": ""
                        },
                        "transcript_treatment_plan": {
                            "text":"MarkDown formated text"
                        },
                        "transcript_clerking": {
                            "text":"MarkDown formated text",
                            "presenting_complaint_(pc)": "",
                            "history_of_presenting_complaint_(hpc)": "",
                            "past_medical_and_surgical_history_(pmhx)": "",
                            "physical_examination_(pe)": ""
                        }
                    }
                }
                
            
                    
                        curl --location 'https://infer.intron.health/file/v1/status/file-id?get_structured_post_processing=t' \
                        --header 'Authorization: Bearer my-api-key'
                    
                
                    
                    import requests

                    url = "https://infer.intron.health/file/v1/status/file-id?get_structured_post_processing=t"

                    payload = {}
                    headers = {
                        'Authorization': 'Bearer my-api-key'
                    }

                    response = requests.request("GET", url, headers=headers, data=payload)

                    print(response.text)
                    
                
                    
                        const myHeaders = new Headers();
                        myHeaders.append("Authorization", "Bearer my-api-key");
                        
                        const requestOptions = {
                          method: "GET",
                          headers: myHeaders
                        };
                        
                        fetch("https://infer.intron.health/file/v1/status/file-id?get_structured_post_processing=t", requestOptions)
                          .then((response) => response.text())
                          .then((result) => console.log(result))
                          .catch((error) => console.error(error));

Quotas and Limits

  • Rate limit: 100 requests per minute