{"info":{"_postman_id":"25b8883b-c3cc-49fb-bcae-aa3c53f21cb2","name":"Loom Analytics API Documentation","description":"

This Collection provides developers with the API calls and corresponding documentation to integrate their applications with Loom Analytics' automation products. The API calls are organized into folders where the General folder contains the common API calls for all of the products, while the other folders contain the respective product specific calls.

Additional detailed documentation for these API calls is available in the Loom Analytics Knowledge Base at https://support.loomanalytics.com/developer-api-documentation.

More information about Loom Analytics products is available at https://www.loomanalytics.com.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1817208","collectionId":"25b8883b-c3cc-49fb-bcae-aa3c53f21cb2","publishedId":"2s93kz5Qe6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-24T18:19:37.000Z"},"item":[{"name":"General","item":[{"name":"Ping","id":"80bae4fc-9311-4d8f-a625-4ffd5a10e610","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key\": \"{{api_key}}\",\n \"secret\": \"{{secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/ping","description":"

Description: Used to confirm the status of the Base URL endpoint and validity of the API key and secret

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
- Format: string
- Replace with your API Key
\n
Secret: Secret generated along with the API Key by the Team Administrator
- Format: string
- Replace with the secret key provided
\n

Expected Response

{

\"msg\": \"sys_up...\"

}

Link to KB article: https://support.loomanalytics.com/api-call-ping

\n","urlObject":{"path":["ping"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80bae4fc-9311-4d8f-a625-4ffd5a10e610"}],"id":"2251fb16-cabf-4208-bb90-ae29b08c3132","description":"

This folder contains the common API calls for integrating with the various Loom Analytics solutions. You will need the following to begin working with this REST API:

A Team Administrator account on a Loom Analytics enterprise
Base URL - Available in your Loom Analytics enterprise account - Integrations page - General tab
API Key, Secret - Available in your Loom Analytics enterprise account - Integrations page - General tab. The Secret is only available when the key pair is first generated. Save the Secret in a safe file to ensure it is accessible after it it generated. If you misplace the Secret, you will have to Delete the key pair and regenerate it.
Sample Job Profile - For the solutions on Loom Analytics, each workflow has a custom JSON format for the body of the job API call, and it depends on the Profile and workflow for the job. A sample JSON for the type of workflow job call you will be making through the API can be simulated on the Integrations page - solution tab. You will need to copy the Sample JSON from there to paste into your Sumit Job API call
Read access to any files submitted in the calls - For the API to access the files being submitted through the Submit Job calls, read access to the files will be needed.

\n","_postman_id":"2251fb16-cabf-4208-bb90-ae29b08c3132"},{"name":"Claudio - Transcription Assistant","item":[{"name":"List Profiles","event":[{"listen":"prerequest","script":{"id":"10e3e3ec-61e0-483b-8a7b-c6d5da76603f","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3ffde831-d2df-4e35-a0a5-117a81c5d284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key\": \"{{api_key}}\",\n \"secret\": \"{{secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{oa_base_url}}/profiles","description":"

Description: API to get list of all profiles available to the user.

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
\n
- Format: string
  \n
- Replace with your API Key
  \n
\n
Secret: Secret generated along with th
\n
e API Key by the Team Administrator
\n
- Format: string
  \n
- Replace with the secret key provided
  \n
\n

Expected Responses:

On Successful API call:

{\"msg\":\"SUCCESS: Profiles found. \",\"result\":[{\"profile_id\":\"49I49L1R18H52\",\"profile_name\":\"General Transcription\",\"profile_description\":\"For transcribing conversations\"},{\"profile_id\":\"31U84P13J60R19\",\"profile_name\":\"Insurance Interview\",\"profile_description\":\"Recorded statements, field notes, summary reports and Examination under oath (EUO) proceedings \"},{\"profile_id\":\"49Q80X60F53E93\",\"profile_name\":\"Legal Dictation\",\"profile_description\":\"For Legal Dictation, court proceedings, depositions and discoveries\"}],\"return\":\"msg,result\"}

If user has no access to profiles

{\"msg\":\"SUCCESS: Profiles not found. \",\"result\":[],\"return\":\"msg,result\"}

Note: The above response is an example, the actual results may vary depending on user access.

\n","urlObject":{"path":["profiles"],"host":["{{oa_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ffde831-d2df-4e35-a0a5-117a81c5d284"},{"name":"Generate Sample Request JSON","event":[{"listen":"prerequest","script":{"id":"10e3e3ec-61e0-483b-8a7b-c6d5da76603f","exec":[""],"type":"text/javascript","packages":{}}}],"id":"40a0fed1-f9eb-48cb-b771-258f2d52b774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key\": \"{{api_key}}\",\n \"secret\": \"{{secret}}\",\n \"profile_id\": \"72S92Z76L59V98\"\n}","options":{"raw":{"language":"json"}}},"url":"{{oa_base_url}}/profiles/request/generate","description":"

Description: Used to confirm the status of the Base URL endpoint and validity of the API key and secret

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
\n
- Format: string
  \n
- Replace with your API Key
  \n
\n
Secret: Secret generated along with the API Key by the Team Administrator
\n
- Format: string
  \n
- Replace with the secret key provided
  \n
\n
Profile ID: Profile ID for which the API has to generate sample request JSON
\n
- Format: string
  \n
- Replace with profile id obtained from List Profile API call
  \n
\n

Expected Response

On successful API call

{\"msg\":\"SUCCESS: Sample request generated for profile General Transcription. \",\"result\":[{\"key\":\"\",\"secret\":\"\",\"form_id\":\"94F76F4W30R27\",\"profile_id\":\"87A90X1K42Y77\",\"is_raw\":\"<1 to get raw transcript | 0 to get url of formatted transcript>\",\"profile_name\":\"General Transcription\",\"job_name\":\"\",\"job_data\":null,\"audio_files\":[{\"audio_filename\":\"\",\"audio_location\":\"\",\"audio_start\":\"00:00:00\",\"audio_end\":\"00:00:00\"}]}],\"return\":\"msg,result\"}

The above JSONis identical to the JSON generated on Claudio Web App.

Response when there is an error:

{\"msg\":\"ERROR: Unexpected error occured. Profile not found. Please contact administrator. \",\"err_code\":\"ERR_C_TA_GP_001\"}

Link to KB article: https://support.loomanalytics.com/api-call-ping

\n","urlObject":{"path":["profiles","request","generate"],"host":["{{oa_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40a0fed1-f9eb-48cb-b771-258f2d52b774"},{"name":"Upload Audio","id":"09f43512-2575-4f0e-8836-b7be9fa626c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"key","value":"A6DRW9Cugzapi63bc1abeb1ea3","type":"text"},{"key":"secret","value":"rrPgUflcEby58dISjqjHtFc6cH4o2Rapi63bc1abeb1ea7","type":"text"},{"key":"audio","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/vpudipeddi/Downloads/AUD LEPINE.m4a"],"src":"/C:/Users/vpudipeddi/Documents/Audio_Samples_Test_Files/Mp3/newTest_1.mp3"}]},"url":"{{base_url}}/jobs/audios/upload","description":"

Description: API to upload a new audio to Claudio - Transcription Assistant.

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
\n
- Format: string
  \n
- Replace with your API Key
  \n
\n
Secret: Secret generated along with the API Key by the Team Administrator
\n
- Format: string
  \n
- Replace with the secret key provided
  \n
\n
Audio File: The audio file to be transcribed
\n
- Key: audio
\n

Expected Response:

{ \"msg\": \"SUCCESS: File `[name of the audio file with extension]` uploaded. \", \"audio_url\": \"[URL of the uploaded audio file]\", \"return\": \"msg,audio_url\"}

\n","urlObject":{"path":["jobs","audios","upload"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09f43512-2575-4f0e-8836-b7be9fa626c7"},{"name":"Upload Documents","id":"3ea337d0-d713-431a-82c9-7d4484232efc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"key","value":"SOudapkuarapi67610fe4646ee","type":"text"},{"key":"secret","value":"2mPhXqUtfgvgqMAAWZSCPSKtCfjFaOapi67610fe4646f1","type":"text"},{"key":"file","type":"file","src":"/C:/Users/vpudipeddi/Downloads/LOI_Ex1.docx"}]},"url":"{{oa_base_url}}/jobs/files/upload","description":"

Description: API to upload a new documents to Claudio - Transcription Assistant.

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
- Format: string
- Replace with your API Key
\n
Secret: Secret generated along with the API Key by the Team Administrator
- Format: string
- Replace with the secret key provided
\n
Document: The document sent as attachment
- Key: file
\n

Expected Response:

{ \"msg\": \"SUCCESS: File `[name of the document file with extension]` uploaded. \", \"file_url\": \"[URL of the uploaded document]\", \"return\": \"msg,file_url\"}

\n","urlObject":{"path":["jobs","files","upload"],"host":["{{oa_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ea337d0-d713-431a-82c9-7d4484232efc"},{"name":"Submit Job","id":"2d526f4b-fef7-4b47-aa3b-44fd14448739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"key\": \"{{api_key}}\",\r\n \"secret\": \"{{secret}}\",\r\n \"form_id\": \"18P53P4Z63A71\",\r\n \"profile_id\": \"40X22D76D26A83\",\r\n \"is_raw\": 0,\r\n \"profile_name\": \"IME with Structura Doc Extraction\",\r\n \"job_name\": \"VatTest101\",\r\n \"job_data\": [\r\n {\r\n \"key\": \"specialist_name\",\r\n \"ui_label\": \"Medical Specialist\",\r\n \"type\": \"string\",\r\n \"ui_type\": \"string\",\r\n \"ui_desc\": \"Approved Medical Specialist name\",\r\n \"input_value\": \"VarTest101\"\r\n },\r\n {\r\n \"key\": \"specialist_credentials\",\r\n \"ui_label\": \"Specialist Shorthand Credentials\",\r\n \"type\": \"string\",\r\n \"ui_type\": \"string\",\r\n \"ui_desc\": \"Approved Medical Specialist shorthand credentials\",\r\n \"input_value\": \"VarTest101\"\r\n },\r\n {\r\n \"key\": \"specialist_bio\",\r\n \"ui_label\": \"Specialist Bio\",\r\n \"type\": \"string\",\r\n \"ui_type\": \"string\",\r\n \"ui_desc\": \"Medical specialist bio\",\r\n \"input_value\": \"VarTest101\"\r\n }\r\n ],\r\n \"audio_files\": [\r\n {\r\n \"audio_filename\": \"MP3.mp3\",\r\n \"audio_location\": \"FrM3LfmF6HWQ90T1MAD20VK6EZ+N3xstVuflldK0daJdx5iuUSriPeEnvkx4G2hrWri4tOaiulM1wrIB+IM110n516KkObytRW+SuYkVN6w30XG+d4YhRkU/nDaJc12AUoTdlxH0bYgS76fqH1OQJO8jkbG9eqBjxw7C0IR84uJ7QNY\",\r\n \"audio_start\": \"00:00:00\",\r\n \"audio_end\": \"00:00:00\"\r\n }\r\n ],\r\n \"attachments\": [\r\n {\r\n \"filename\": \"LOI_Ex1.docx\",\r\n \"doc_type\": \"loi\",\r\n \"location\": \"FrM3LfmF6HWQ90T1MAD20VK6EZ+N3xstVuflldK0daJdx5iuUSriPeEnvkx4G2hrWri4tOaiulM1wrIB+IM110n516KkObytRW+SuYkVN6w30XG+d4YhRkU/nDaJc12AUoTdlxH0bYgS76fqH1OQJO8jkbG9eqBjxw7C0IVjmJNTSNTBLteHFA\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{oa_base_url}}/jobs/submit","description":"

Description: Submit a new job to Claudio - Transcription Assistant

Mandatory Parameters:

API Key: API Key btained by logging into Loom Analytics enterprise Team Administrator account
- Format: string
- Replace with your API Key
\n
Secret: Secret generated along with the API Key
- Format: string
- Replace with the secret key provided
\n
sample job JSON - obtained by logging into Loom Analytics enterprise Team Administrator account

Expected Response:

{

\"message\": \"SUCCESS: Job submitted successfully. Please use the polling endpoint to check job status. \",

\"poll_endpoint\": \"\",

\"job_reference_id\": \"\",

\"return\": \"message, poll_endpoint, job_reference_id\"

}

Link to KB article:

https://support.loomanalytics.com/api-call-submit

\n","urlObject":{"path":["jobs","submit"],"host":["{{oa_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d526f4b-fef7-4b47-aa3b-44fd14448739"},{"name":"Submit Job Copy","id":"ec5a290a-8dc2-42b7-9e5f-e073b6fd3621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"key\": \"bG9rUyjvZVapi66d5c8c8b2453\",\r\n \"secret\": \"fZaSJhG643bAbUSROQCxxO7Pk9xbmUapi66d5c8c8b2456\",\r\n \"form_id\": \"\",\r\n \"profile_id\": \"47L80Q20J94D24\",\r\n \"is_raw\": \"0\",\r\n \"profile_name\": \"Document Direct Spire Medical\",\r\n \"job_name\": \"2630684\",\r\n \"job_data\": null,\r\n \"audio_files\": [\r\n {\r\n \"audio_filename\": \"2630684\",\r\n \"audio_location\": \"FrM3LfmF6HWQ90TxNQDy21S6VMjCzQJhHqbqmcS9NK9T3cThQjWhcew2uwZyGHx1EKKjp+ay4FUz0ekD5dk3xA7u3\\\\/mxZJCOElGxpfUjNtEyzjWxefRXJUU5nDSeMlfFPN6dhlCvXYNS672pFW3KMuoglYq7Jf46lVqHx\\\\/0Cpq1g\",\r\n \"audio_start\": \"00:00:00\",\r\n \"audio_end\": \"00:00:00\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/jobs/submit","description":"

Description: Submit a new job to Claudio - Transcription Assistant

Mandatory Parameters:

API Key: API Key btained by logging into Loom Analytics enterprise Team Administrator account
- Format: string
- Replace with your API Key
\n
Secret: Secret generated along with the API Key
- Format: string
- Replace with the secret key provided
\n
sample job JSON - obtained by logging into Loom Analytics enterprise Team Administrator account

Expected Response:

{

\"message\": \"SUCCESS: Job submitted successfully. Please use the polling endpoint to check job status. \",

\"poll_endpoint\": \"\",

\"job_reference_id\": \"\",

\"return\": \"message, poll_endpoint, job_reference_id\"

}

Link to KB article:

https://support.loomanalytics.com/api-call-submit

\n","urlObject":{"path":["jobs","submit"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec5a290a-8dc2-42b7-9e5f-e073b6fd3621"},{"name":"Poll Job","id":"f156bc59-0d3f-4a57-a7b4-dc0e6b3336cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key\": \"{{api_key}}\",\n \"secret\": \"{{secret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{oa_base_url}}/jobs/00AoLoform69799634a72d4/poll","description":"

Description: API to check the job status by polling

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
- Format: string
- Replace with your API Key
\n
Secret: Secret generated along with the API Key by the Team Administrator
- Format: string
- Replace with the secret key provided
\n
Job Reference ID: Unique ID for job created
- Format: string
- Replace {{job_reference_id}} with the Job reference ID obtained in the response of Submit Job API
\n

Expected Responses

When job status is Complete and is_raw is 0

{

\"msg\": \"SUCCESS: Job completed. \",\n\"transcript_location\": [],\n\"media_files\": [],\n\"return\": \"msg, transcript_location, media_files\"\n\n

}

When job status is Complete and is_raw is 1

\"msg\": \"SUCCESS: Job completed. \",\n\"finished_transcript\": [],\n\"media_files\": [],\n\"return\": \"msg, transcript_location, media_files\"\n\n

Update: updated transcript_location to return an array of transcript locations instead of a string

Note: If the transcript is deleted, the URL of the transcript will contain a PDF indicating that the transcript is deleted

When job status is In-Progress

{

\"msg\": \"NOTICE: The job is in progress. Please try again after some time. \",\n\"media_files\": []\n\n

}

Link to KB article: https://support.loomanalytics.com/api-call-poll-job

\n","urlObject":{"path":["jobs","00AoLoform69799634a72d4","poll"],"host":["{{oa_base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f156bc59-0d3f-4a57-a7b4-dc0e6b3336cf"},{"name":"Delete Transcript and Audios","id":"a909864c-2ebd-4850-8738-9fc607a56719","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"key\": \"{{api_key}}\",\n \"secret\": \"{{api_key}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/jobs/{{job_reference_id}}/delete","description":"

Description: API to delete generated transcript

Mandatory Parameters:

API Key: API Key generated by the Team Administrator
- Format: string
- Replace with your API Key
\n
Secret: Secret generated along with the API Key by the Team Administrator
- Format: string
- Replace with the secret key provided
\n
Job Reference ID: Unique ID for job created
- Format: string
- Replace {{job_reference_id}} with the Job reference ID obtained in the response of Submit Job API
\n

Link to KB article:

https://support.loomanalytics.com/api-call-delete-transcript

\n","urlObject":{"path":["jobs","{{job_reference_id}}","delete"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a909864c-2ebd-4850-8738-9fc607a56719"}],"id":"71cad898-29c2-48be-b050-98fcee795e74","_postman_id":"71cad898-29c2-48be-b050-98fcee795e74","description":""}]}