{"info":{"_postman_id":"ec9eb6ba-65dd-4c9a-a01f-9f98d25d7a67","name":"Loom Analytics API Documentation","description":"<html><head></head><body><p>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.</p>\n<p>Additional detailed documentation for these API calls is available in the Loom Analytics Knowledge Base at <a href=\"https://support.loomanalytics.com/developer-api-documentation.\">https://support.loomanalytics.com/developer-api-documentation.</a></p>\n<p>More information about Loom Analytics products is available at <a href=\"https://www.loomanalytics.com\">https://www.loomanalytics.com</a>.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1817208","collectionId":"ec9eb6ba-65dd-4c9a-a01f-9f98d25d7a67","publishedId":"2s8ZDSbQ5v","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-20T17:50:44.000Z"},"item":[{"name":"General","item":[{"name":"Ping","id":"9e2e3784-4479-4b92-a9e8-55d28ffdeff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n   \"key\": \"yourapikeygoeshere123456abc\",\n    \"secret\": \"yoursecretkeygoeshere123456789abcdefghijklm123\"\n}","options":{"raw":{"language":"json"}}},"url":"<base_url>/ping","description":"<p><strong>Description:</strong> Used to confirm the status of the Base URL endpoint and validity of the API key and secret</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<ul>\n<li><p><strong>API Key:</strong> API Key generated by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with your API Key</p>\n</li>\n</ul>\n</li>\n<li><p><strong>Secret:</strong> Secret generated along with the API Key by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with the secret key provided</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Expected Response</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"msg\": \"SUCCESS: User authenticated. System up. \"\n}\n\n</code></pre>\n<p><strong>Response Parameters</strong></p>\n<ul>\n<li><p>Key Name: msg</p>\n<ul>\n<li><p>Description: Output message with verbose results of the API call.</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key: return</p>\n<ul>\n<li>Description: returns the list of keys to expect in the response</li>\n</ul>\n</li>\n</ul>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-ping\">https://support.loomanalytics.com/api-call-ping</a></p>\n","urlObject":{"path":["ping"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e2e3784-4479-4b92-a9e8-55d28ffdeff4"}],"id":"a7ba6db4-b978-4254-8fac-290e5a2a53c8","description":"<p>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:</p>\n<ol>\n<li><p>A Team Administrator account on a Loom Analytics enterprise</p>\n</li>\n<li><p>Base URL - Available in your Loom Analytics enterprise account - Integrations page - General tab</p>\n</li>\n<li><p>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.</p>\n</li>\n<li><p>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</p>\n</li>\n</ol>\n","_postman_id":"a7ba6db4-b978-4254-8fac-290e5a2a53c8"},{"name":"Loom Analytics Transcription Assistant","item":[{"name":"List Profiles","id":"f0f9d6a3-67af-4075-ad1d-bda50c67397c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n   \"key\": \"yourapikeygoeshere123456abc\",\n   \"secret\": \"yoursecretkeygoeshere123456789abcdefghijklm123\"\n}","options":{"raw":{"language":"json"}}},"url":"<base_url>/profiles","description":"<p><strong>Description:</strong> API to get list of all profiles available to the user.</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<ul>\n<li><p>API Key: API Key generated by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with your API Key</p>\n</li>\n</ul>\n</li>\n<li><p>Secret: Secret generated along with the API Key by the Team Administrator.</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with the secret key provided</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Expected Responses:</strong></p>\n<p><strong>On Successful API call:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"SUCCESS: Profiles found. \",\n  \"result\": [\n    {\n      \"profile_id\": \"88W28G1G77066\",\n      \"profile_name\": \"General Transcription\",\n      \"profile_description\": \"For transcribing conversations\"\n    },\n    {\n      \"profile_id\": \"20B17I76J80030\",\n      \"profile_name\": \"IME with Structura Doc Extraction\",\n      \"profile_description\": \"Medico-Legal Dictations with Document Extraction\"\n    },\n    {\n      \"profile_id\": \"99K17J13L86Y52\",\n      \"profile_name\": \"Insurance Interview\",\n      \"profile_description\": \"Recorded statements, field notes, summary reports and Examination under oath proceedings \"\n    },\n    {\n      \"profile_id\": \"72R22060T68F69\",\n      \"profile_name\": \"Legal Dictation\",\n      \"profile_description\": \"For Legal Dictation, court proceedings, depositions and discoveries\"\n    },\n    {\n      \"profile_id\": \"94Y32U4531037\",\n      \"profile_name\": \"Medical Dictation\",\n      \"profile_description\": \"Medical Dictation and patient interviews with vocabulary for multple specialities and global drug lists\"\n    }\n  ],\n  \"return\": \"msg,result\"\n}\n\n</code></pre>\n<p><strong>If user has no access to profiles</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"SUCCESS: Profiles not found. \",\n  \"result\": [],\n  \"return\": \"msg,result\"\n}\n\n</code></pre>\n<p>Note: The above response is an example, the actual results may vary depending on user access.</p>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-list-profiles\">https://support.loomanalytics.com/api-call-list-profiles</a></p>\n","urlObject":{"path":["profiles"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0f9d6a3-67af-4075-ad1d-bda50c67397c"},{"name":"Generate Sample Request JSON","id":"3ce70cb5-fc25-49c7-9b91-0d6f893b8cd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n   \"key\": \"yourapikeygoeshere123456abc\",\n   \"secret\": \"yoursecretkeygoeshere123456789abcdefghijklm123\",\n   \"profile_id\": \"40E96X1R72T96\"\n}","options":{"raw":{"language":"json"}}},"url":"<base_url>/profiles/request/generate","description":"<p><strong>Description:</strong> Used to confirm the status of the Base URL endpoint and validity of the API key and secret</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Name</th>\n<th><strong>Description</strong></th>\n<th><strong>Usgae</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>key</td>\n<td>API Key</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>secret</td>\n<td>API Secret</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>profle_id</td>\n<td>Profile ID for which the API has to generate sample request JSON</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Expected Response</strong></p>\n<p><strong>On successful</strong> <strong>API call</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"msg\": \"SUCCESS: Sample request generated for profile `General Transcription`. \",\n    \"result\": [\n        {\n            \"key\": \"&lt;api key goes here&gt;\",\n            \"secret\": \"&lt;secret goes here&gt;\",\n            \"form_id\": \"50K92F1723456O10D66\",\n            \"profile_id\": \"65B85K3E29R89\",\n            \"is_raw\": \"&lt;1 to get raw transcript | 0 to get url of formatted transcript&gt;\",\n            \"profile_name\": \"General Transcription\",\n            \"job_name\": \"&lt;job name goes here&gt;\",\n            \"job_data\": null,\n            \"audio_files\": [\n                {\n                    \"audio_filename\": \"&lt;filename of the audio with extension&gt;\",\n                    \"audio_location\": \"&lt;url of audio file&gt;\",\n                    \"audio_start\": \"00:00:00\",\n                    \"audio_end\": \"00:00:00\"\n                }\n            ]\n        }\n    ],\n    \"return\": \"msg,result\"\n}\n\n</code></pre>\n<p>The above JSONis identical to the JSON generated on Loom Analytics app.</p>\n<p><strong>Response when there is an error:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"ERROR: Unexpected error occured. Profile not found. Please contact administrator. \",\n  \"err_code\": \"ERR_C_TA_GP_001\"\n}\n\n</code></pre>\n<p><strong>If the user does not have access to the profile requested</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"msg\": \"SUCCESS: Profiles not found.\",\n    \"result\": [],\n    \"return\": \"msg,result\"\n}\n\n</code></pre>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-ping\">https://support.loomanalytics.com/api-call-ping</a></p>\n","urlObject":{"path":["profiles","request","generate"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ce70cb5-fc25-49c7-9b91-0d6f893b8cd0"},{"name":"Upload Audio","id":"f7d8c275-ed2c-4dc1-8af2-b97ad1eb3c27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"<base_url>/jobs/audios/upload","description":"<p><strong>Description:</strong> API to upload a new audio to Claudio. The maximum file upload size through this call is 250 MB.</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th>Description</th>\n<th>Usage</th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Key</td>\n<td>Api Key</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>Secret</td>\n<td>Secret</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>Audio File</td>\n<td>Media file to transcribe</td>\n<td>In Request Body  <br />(form data)</td>\n<td>file</td>\n<td>True</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Expected Response:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"SUCCESS: File `file.wav` uploaded. \",\n  \"audio_url\": \"EncyptedAudioURL\",\n  \"return\": \"msg,audio_url\",\n  \"url\": \"https://link.to.the.file/api/file.wav\"\n}\n\n</code></pre>\n<p><strong>Response Parameters</strong></p>\n<ul>\n<li><p>Key Name: msg</p>\n<ul>\n<li><p>Description: Output message with verbose results of the API call</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key Name: audio_url</p>\n<ul>\n<li><p>Description: URL of the uploaded audio file</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key: return</p>\n<ul>\n<li>Description: returns the list of keys to expect in the response</li>\n</ul>\n</li>\n<li><p>Key: url</p>\n<ul>\n<li>S3 URL to the file</li>\n</ul>\n</li>\n</ul>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-upload-audio\">https://support.loomanalytics.com/api-call-upload-audio</a></p>\n","urlObject":{"path":["jobs","audios","upload"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7d8c275-ed2c-4dc1-8af2-b97ad1eb3c27"},{"name":"Upload Documents","id":"d2568ab9-a5b6-46ea-b3ed-9b755ac64a91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"key","value":"<api_key>","type":"text"},{"key":"secret","value":"<secret>","type":"text"},{"key":"file","type":"file","value":null}]},"url":"<base_url>/jobs/files/upload","description":"<p><strong>Description:</strong> API to upload a new document to Claudio.</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th>Description</th>\n<th>Usage</th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Key</td>\n<td>Api Key</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>Secret</td>\n<td>Secret</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>File</td>\n<td>Document for extraction</td>\n<td>In Request Body  <br />(form data)</td>\n<td>file</td>\n<td>True</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Expected Response:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"SUCCESS: File `Sample_File_1.pdf` uploaded. \",\n  \"file_url\": \"EncryptedDocumentURL\",\n  \"return\": \"msg,file_url\",\n  \"url\": \"https://link.to.the.file/api/Sample_File_1.pdf\"\n}\n\n</code></pre>\n<p><strong>Response Parameters</strong></p>\n<ul>\n<li><p>Key Name: msg</p>\n<ul>\n<li><p>Description: Output message with verbose results of the API call</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key Name: file_url</p>\n<ul>\n<li><p>Description: URL of the uploaded document file</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key: return</p>\n<ul>\n<li>Description: returns the list of keys to expect in the response</li>\n</ul>\n</li>\n<li><p>Key: url</p>\n<ul>\n<li>S3 URL to the uploaded document.</li>\n</ul>\n</li>\n</ul>\n<p><strong>Link to KB article</strong>: <a href=\"https://support.loomanalytics.com/api-call-upload-documents\">https://support.loomanalytics.com/api-call-upload-documents</a></p>\n","urlObject":{"path":["jobs","files","upload"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2568ab9-a5b6-46ea-b3ed-9b755ac64a91"},{"name":"Submit Job","event":[{"listen":"test","script":{"id":"7c052aac-af78-41d9-bfc5-6ff0e01c7b69","exec":["const jsonData = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"job_reference_id\", jsonData.job_reference_id);"],"type":"text/javascript"}}],"id":"223f6ca2-6f8e-4e95-abc2-c4ddf3f0f8de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n  \"key\": \"<your API key goes here>\",\r\n  \"secret\": \"<your secret goes here>\",\r\n  \"form_id\": \"<replace with form_id obtained from sample JSON on UI>\",\r\n  \"profile_id\": \"<replace with profile_id obtained from sample JSON on UI>\",\r\n  \"is_raw\": 0,\r\n  \"profile_name\": \"<replace with profile name obtained from sample JSON on UI>\",\r\n  \"job_name\": \"<replace with job name>\",\r\n  \"job_data\": [\r\n    {\r\n      \"key\": \"user_defined_key_1\",\r\n      \"ui_label\": \"user defined key label 1\",\r\n      \"type\": \"string\",\r\n      \"ui_type\": \"string\",\r\n      \"ui_desc\": \"description of user defined key\",\r\n      \"input_value\": \"\"\r\n    },\r\n    {\r\n      \"key\": \"user_defined_key_2\",\r\n      \"ui_label\": \"user defined key label 2\",\r\n      \"type\": \"string\",\r\n      \"ui_type\": \"string\",\r\n      \"ui_desc\": \"description of user defined key\",\r\n      \"input_value\": \"\"\r\n    }\r\n  ],\r\n  \"audio_files\": [\r\n    {\r\n      \"audio_filename\": \"TestAudio.mp3\",\r\n      \"audio_location\": \"FrM3LfmF6HWQ90T1MAD20VK6EZ+N3xstVuflldK0daJdx5edfiuUSriPeQyuEx4G2hrWri4tOaiulM1wrIB+IM110n516KkObytRW+SuYkVN6w30XG+d4YhRkU/nDaJc12AUoTdlxH0bYgS76fqH1OQJO8jkbG9eqBjxw7C0KdJpphzQ5HdZNWUXw\",\r\n      \"audio_start\": \"00:00:00\",\r\n      \"audio_end\": \"00:00:10\"\r\n    },\r\n    {\r\n      \"audio_filename\": \"TestVideo.mp4\",\r\n      \"audio_location\": \"FrM3LfmF6HWQ90T1MAD20VK6EZ+N3xstVuflldK0daJdx5iuUse5dSriPeQyuEx4G2hrWri4tOaiulM1wrIB+IM110n516KkObytRW+SuYkVN6w30XG+d4YhRkU/nDaJc12AUoTdlxH0bYgS76fqH1OQJO8jkbG9eqBjxw7C0Jt4jv0gCdfXcoDVXEpKR9M2IHh/\",\r\n      \"audio_start\": \"00:00:00\",\r\n      \"audio_end\": \"00:01:00\"\r\n    }\r\n  ],\r\n  \"attachments\": [\r\n    {\r\n      \"filename\": \"TestDocument.pdf\",\r\n      \"doc_type\": \"<replace with document type in lower case>\",\r\n      \"location\": \"FrM3LfmF6HWQ90T1MAD20VK6EZ+N3xstVuflldK0daJdx5iuUSriPw4rreQyuEx4G2hrWri4tOaiulM1wrIB+IM110n516KkObytRW+SuYkVN6w30XG+d4YhRkU/nDaJc12AUoTdlxH0bYgS76fqH1OQJO8jkbG9eqBjxw7C0JlJsL51VcDdevSrJVUKF4M\"\r\n    }\r\n  ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.loomclaudio.com/api/oa/claudioaus/jobs/submit","description":"<p><strong>Description:</strong> Submit a new transcription job to Loom Analytics.</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Usage</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>key</td>\n<td>API Key provided</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>secret</td>\n<td>Secret provided</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>Request JSON</td>\n<td>sample job JSON</td>\n<td>In Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Note:</strong></p>\n<ul>\n<li><p>If more than one audio or document is being submitted through a single job, use the Upload Audio and/or Upload Document call to upload one audio/video or document at time, to receive a separate link for each upload. Provide a separate link for each file as per the sample code in the audio and document arrays respectively.</p>\n</li>\n<li><p>Audio/Video files can be trimmed to request partial transcripts using the HH:MM:SS format to set start and end times, as per the sample code.</p>\n</li>\n<li><p>For jobs profiles that are expected to return a word document, if is_raw is set to 1, then finished_transcript key would be an array of file URLs that contain the transcript word document.</p>\n</li>\n</ul>\n<p><strong>Expected Response:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"msg\": \"SUCCESS: Job[Job_Name] submitted successfully. \n            Your webhook is configured successfully for the current job. \n            We will send a notification to the webhook URL when the job is completed.\",\n    \"poll_endpoint\": \"&lt;endpoint of polling API&gt;\",\n    \"job_reference_id\": \"&lt;a unique job_reference_id of the submitted job&gt;\",\n    \"return\": \"msg, poll_endpoint, job_reference_id\"\n}\n\n</code></pre>\n<p><strong>Response Parameters</strong></p>\n<ul>\n<li><p>Key Name: msg</p>\n<ul>\n<li><p>Description: Output message with verbose results of the API call</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key Name: poll_endpoint</p>\n<ul>\n<li><p>Description: API endpoint to use for polling the job</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key Name: job_reference_id</p>\n<ul>\n<li><p>Description: Unique ID assigned to the job submitted</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key: return</p>\n<ul>\n<li>Description: returns the list of keys to expect in the response</li>\n</ul>\n</li>\n</ul>\n<p><strong>Link to KB article</strong>:</p>\n<p><a href=\"https://support.loomanalytics.com/api-call-submit\">https://support.loomanalytics.com/api-call-submit</a></p>\n","urlObject":{"path":["jobs","submit"],"host":["https://app.loomclaudio.com/api/oa/claudioaus"],"query":[],"variable":[]}},"response":[],"_postman_id":"223f6ca2-6f8e-4e95-abc2-c4ddf3f0f8de"},{"name":"Webhook Setup","id":"370d3813-892a-451d-b3c3-01945624e5d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://your-server.com/webhook/goes/here","description":"<p><strong>Description:</strong></p>\n<p>Webhooks allow you to receive job status updates in Webhook Logs by sending <strong>POST requests</strong> to your server endpoint. Once configured, your webhook endpoint will receive HTTP <strong>POST</strong> requests whenever a job you submit changes status. All webhook activity is logged in the <em>Webhook Logs</em> section for monitoring and troubleshooting.</p>\n<h4 id=\"configuring-your-webhook-requires-team-admin-access\"><strong>Configuring Your Webhook (Requires Team Admin Access)</strong></h4>\n<h4 id=\"step-1-navigate-to-webhook-settings\">Step 1: Navigate to Webhook Settings</h4>\n<ol>\n<li><p>Log in to your Loom Analytics account.</p>\n</li>\n<li><p>Click on gear icon on top-right side.</p>\n</li>\n<li><p>Go to <strong>Integrations</strong> in the left navigation menu</p>\n</li>\n<li><p>Select <strong>Webhooks.</strong></p>\n</li>\n</ol>\n<h4 id=\"step-2-enter-webhook-url\">Step 2: Enter Webhook URL</h4>\n<p>In the <strong>Webhook URL</strong> field, enter your server's endpoint that will receive logs for your jobs.</p>\n<p><strong>Important:</strong> Ensure your webhook endpoint:</p>\n<ul>\n<li><p>Is publicly accessible via HTTPS</p>\n</li>\n<li><p>Can accept POST requests</p>\n</li>\n<li><p>Returns HTTP 200 status for successful receipt</p>\n</li>\n<li><p>Implements proper authentication using the webhook secret</p>\n</li>\n</ul>\n<h4 id=\"step-3-test-your-webhook\">Step 3: Test Your Webhook</h4>\n<p>Before saving, it's crucial to test your webhook configuration:</p>\n<ol>\n<li><p>Click the <strong>Test Webhook</strong> button</p>\n</li>\n<li><p>The system will send a test notification to your endpoint</p>\n</li>\n</ol>\n<p><strong>Expected Test Notifications:</strong></p>\n<p><strong>Successful Test:</strong> A green notification will appear at the top-left of the screen.</p>\n<p><strong>Failed Test:</strong> An error message will be displayed indicating the issue.</p>\n<p><strong>Common Error Codes:</strong></p>\n<ul>\n<li><p><strong>HTTP 405</strong>: Method Not Allowed - Your endpoint doesn't accept POST requests</p>\n</li>\n<li><p><strong>HTTP 404</strong>: Not Found - The webhook URL is incorrect or endpoint doesn't exist</p>\n</li>\n<li><p><strong>HTTP 401/403</strong>: Unauthorized/Forbidden - Authentication issues</p>\n</li>\n<li><p><strong>HTTP 500</strong>: Internal Server Error - Issue with your webhook handler</p>\n</li>\n<li><p><strong>Timeout</strong>: Your endpoint is unreachable or taking too long to respond</p>\n</li>\n</ul>\n<p><strong>Expected Response:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"event\": \"job.completed\",\n  \"status\": \"completed\",\n  \"job_name\": \"Postman_OpenAPI_0122\",\n  \"timestamp\": 1769194750,\n  \"completed_at\": \"2026-01-23 18:59:06\",\n  \"error_message\": null,\n  \"job_reference_id\": \"S3Ol3oform6973c4b108f18\"\n}\n\n</code></pre>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/how-do-i-configure-a-webhook-for-job-logs\">https://support.loomanalytics.com/how-do-i-configure-a-webhook-for-job-logs</a></p>\n","urlObject":{"protocol":"https","path":["webhook","goes","here"],"host":["your-server","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"370d3813-892a-451d-b3c3-01945624e5d0"},{"name":"Poll Job","id":"319983af-6cbc-483f-893e-7617f745e114","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n   \"key\": \"yourapikeygoeshere123456abc\",\n   \"secret\": \"yoursecretkeygoeshere123456789abcdefghijklm123\"\n}","options":{"raw":{"language":"json"}}},"url":"<base_url>/jobs/<job_reference_id>/poll","description":"<p><strong>Description:</strong> API to check the job status by polling</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<ul>\n<li><p>API Key: API Key generated by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with your API Key</p>\n</li>\n</ul>\n</li>\n<li><p>Secret: Secret generated along with the API Key by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with the secret key provided</p>\n</li>\n</ul>\n</li>\n<li><p>Job Reference ID: Unique ID for job created</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace xsCe6oform64f8bfd6c8b62 with the Job reference ID obtained in the response of Submit Job API</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Expected Responses</strong></p>\n<p><strong>When job status is Complete and is_raw is 0, Finished Transcript would be an array of URLs containing the transcript file.</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"SUCCESS: Job completed. The audio file appears to be blank or silent. No speech was detected. \",\n  \"finished_transcript\": [\n    \"S3 URL for the processed transcript\"\n  ],\n  \"media_files\": [\n    \"S3 URL for the original media file\"\n    \"S3 URL for the processed media file\"\n  ],\n  \"extracted_fields\": [],\n  \"extracted_fields_url\": \"S3 URL to access extracted fields in a JSON format\"\n  \"is_blank_audio\": true/false,\n  \"return\": \"msg, finished_transcript, media_files, extracted_fields, is_blank_audio\"\n}\n\n</code></pre>\n<p><strong>When job status is Complete and is_raw is 1, Finished Transcript would contain raw text of the transcript.</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"msg\": \"SUCCESS: Job completed. The audio file appears to be blank or silent. No speech was detected. \",\n  \"finished_transcript\": [\n    \"S3 URL for the processed transcript\"\n  ],\n  \"media_files\": [\n    \"S3 URL for the original media file\"\n    \"S3 URL for the processed media file\"\n  ],\n  \"extracted_fields\": [],\n  \"is_blank_audio\": false,\n  \"return\": \"msg, finished_transcript, media_files, extracted_fields, extracted_fields_url\"\n}\n\n</code></pre>\n<p><strong>Note:</strong> If the transcript is deleted, the URL of the transcript will contain a PDF indicating that the transcript is deleted</p>\n<p><strong>When job status is In-Progress</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"msg\": \"NOTICE: The job is in progress. Please try again after sometime. \",\n    \"media_files\": [\"S3 URL to the original media file\"]\n}\n\n</code></pre>\n<p><strong>Response Parameters</strong></p>\n<ul>\n<li><p>Key Name: msg</p>\n<ul>\n<li><p>Description: Output message with verbose results of the API call</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n<li><p>Key Name: media_files</p>\n<ul>\n<li><p>Description: Array of URL to download the MP3 converted media files used for transcription</p>\n</li>\n<li><p>Format: array</p>\n</li>\n</ul>\n</li>\n<li><p>Key: return</p>\n<ul>\n<li>Description: returns the list of keys to expect in the response</li>\n</ul>\n</li>\n<li><p>Key: finished_transcript</p>\n<ul>\n<li><p>Description: When is_raw is set to 1, the value is the raw transcript text. If the text contains any malformed characters an array of the file location is returned instead</p>\n</li>\n<li><p>Format: array</p>\n</li>\n</ul>\n</li>\n<li><p>Key: is_blank_audio</p>\n<ul>\n<li><p>Description: this flag checks if the media files has any audio stream</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Note:</strong> For jobs profiles that are expected to return a word document, if is_raw is set to 1, then finished_transcript key would be an array of file URLs that contain the transcript word document.</p>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-poll-job\">https://support.loomanalytics.com/api-call-poll-job</a></p>\n","urlObject":{"path":["jobs","<job_reference_id>","poll"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"319983af-6cbc-483f-893e-7617f745e114"},{"name":"Delete Transcript and Audios","id":"b39b13e3-19b5-414f-acb7-38ab588be3e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n   \"key\": \"yourapikeygoeshere123456abc\",\n   \"secret\": \"yoursecretkeygoeshere123456789abcdefghijklm123\"\n}","options":{"raw":{"language":"json"}}},"url":"<base_url>/jobs/<job_reference_id>/delete","description":"<p><strong>Description:</strong> API to delete generated transcript</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Name</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Usage</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>api_key</td>\n<td>API Key provided</td>\n<td>Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>secret</td>\n<td>Secret provided</td>\n<td>Request Body</td>\n<td>text</td>\n<td>True</td>\n</tr>\n<tr>\n<td>Job reference ID</td>\n<td>part of Submit Job API response</td>\n<td>In query</td>\n<td>text</td>\n<td>True</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Expected Response</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"msg\": \"SUCCESS: Finished Transcript deleted. Formatted Transcript deleted. Audio file deleted. Job files deleted. \"\n}\n\n</code></pre>\n<p><strong>Response Paramaters</strong></p>\n<ul>\n<li><p>Key Name: msg</p>\n<ul>\n<li><p>Description: Output message with verbose results of the API call</p>\n</li>\n<li><p>Format: string</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-delete-transcript\">https://support.loomanalytics.com/api-call-delete-transcript</a></p>\n","urlObject":{"path":["jobs","<job_reference_id>","delete"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"b39b13e3-19b5-414f-acb7-38ab588be3e5"},{"name":"Get Job Details","id":"d6ba3f40-c243-418c-9320-398aec0cbd58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://<base_url>/api/oa/<slug>/jobs/<job_reference_id>/details","description":"<p><strong>Description:</strong> API to check the details for your job.</p>\n<p><strong>Mandatory Parameters:</strong></p>\n<ul>\n<li><p>API Key: API Key generated by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with your API Key</p>\n</li>\n</ul>\n</li>\n<li><p>Secret: Secret generated along with the API Key by the Team Administrator</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace with the secret key provided</p>\n</li>\n</ul>\n</li>\n<li><p>Job Reference ID: Unique ID for job created</p>\n<ul>\n<li><p>Format: string</p>\n</li>\n<li><p>Replace xsCe6oform64f8bfd6c8b62 with the Job reference ID obtained in the response of Submit Job API</p>\n</li>\n</ul>\n</li>\n</ul>\n<p><strong>Expected Responses</strong></p>\n<p>When the input includes both a media file and a document file, and the job status is <strong>Complete</strong>.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"success\": true,\n    \"msg\": \"SUCCESS: Job completed successfully.\",\n    \"job_data\": {\n        \"job_info\": {\n            \"job_reference_id\": \"&lt;job_reference_id&gt;\",\n            \"job_name\": \"&lt;job_name&gt;\",\n            \"status\": \"completed\",\n            \"profile_name\": \"Name of the profile you are using for transcription\",\n            \"submitted_at\": \"submission timestamp\",\n            \"completed_at\": \"submission timestamp\",\n            \"total_audio_length\": \"audio length in seconds\",\n            \"is_blank_audio\": false,\n            \"error_message\": null\n        },\n        \"job_files\": {\n            \"input_files\": [\n                {\n                    \"filename\": \"media file name\",\n                    \"file_type\": \"audio\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the media file\"\n                },\n                {\n                    \"filename\": \"document name \",\n                    \"file_type\": \"attachment\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the document\"\n                }\n            ],\n            \"output_files\": {\n                \"transcripts\": [\n                    {\n                        \"filename\": \"IME Doc Extraction.txt\",\n                        \"file_subtype\": \"final_transcript\",\n                        \"download_url\": \"S3 URL to access the final transcript in a text file\",\n                        \"language_code\": \"en\"\n                    },\n                    {\n                        \"filename\": \"IME Doc Extraction_LOI.docx\",\n                        \"file_subtype\": \"final_transcript\",\n                        \"download_url\": \"S3 URL to access the LOI extractions in a text file\",\n                        \"language_code\": \"en\"\n                    },\n                    {\n                        \"filename\": \"IME Doc Extraction_LTR.docx\",\n                        \"file_subtype\": \"final_transcript\",\n                        \"download_url\": \"S3 URL to access the final transcript in a docx/docm file\",\n                        \"language_code\": \"en\"\n                    }\n                ],\n                \"processed_input_media\": [\n                    {\n                        \"filename\": \"name of the processed media file\",\n                        \"file_subtype\": \"merged_filename\",\n                        \"download_url\": \"S3 URL to access the processed media file\"\n                    }\n                ],\n                \"extracted_fields_url\": \"S3 URL to access extracted fields in a JSON format\"\n            }\n        }\n    }\n}\n\n</code></pre>\n<p>When the input includes both a media file and a document file and the job status is '<strong>In Progress</strong>'.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"success\": true,\n    \"msg\": \"NOTICE: Job is currently being processed.\",\n    \"job_data\": {\n        \"job_info\": {\n            \"job_reference_id\": \"&lt;job_reference_id&gt;\",\n            \"job_name\": \"&lt;job_name&gt;\",\n            \"status\": \"completed\",\n            \"profile_name\": \"Name of the profile you are using for transcription\",\n            \"submitted_at\": \"submission timestamp\",\n            \"completed_at\": \"submission timestamp\",\n            \"total_audio_length\": \"audio length in seconds\",\n            \"is_blank_audio\": false,\n            \"error_message\": null\n        },\n        \"job_files\": {\n            \"input_files\": [\n                {\n                    \"filename\": \"media file name\",\n                    \"file_type\": \"audio\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the media file\"\n                },\n                {\n                    \"filename\": \"document name \",\n                    \"file_type\": \"attachment\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the document\"\n                }\n            ],\n            \"output_files\": null\n        }\n    }\n}\n\n</code></pre>\n<p>When the input includes only a media file and the job status is <strong>Complete</strong>.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"success\": true,\n    \"msg\": \"SUCCESS: Job completed successfully.\",\n    \"job_data\": {\n        \"job_info\": {\n            \"job_reference_id\": \"&lt;job_reference_id&gt;\",\n            \"job_name\": \"&lt;job_name&gt;\",\n            \"status\": \"completed\",\n            \"profile_name\": \"Name of the profile you are using for transcription\",\n            \"submitted_at\": \"submission timestamp\",\n            \"completed_at\": \"submission timestamp\",\n            \"total_audio_length\": \"audio length in seconds\",\n            \"is_blank_audio\": false,\n            \"error_message\": null\n        },\n        \"job_files\": {\n            \"input_files\": [\n                {\n                    \"filename\": \"media file name\",\n                    \"file_type\": \"audio\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the media file\"\n                }\n            ],\n            \"output_files\": {\n                \"transcripts\": [\n                    {\n                        \"filename\": \"General Transcription.txt\",\n                        \"file_subtype\": \"final_transcript\",\n                        \"download_url\": \"S3 URL to access the final transcript in a text file\",\n                        \"language_code\": \"en\"\n                    },\n                    {\n                        \"filename\": \"General Transcription.docx\",\n                        \"file_subtype\": \"final_transcript\",\n                        \"download_url\": \"S3 URL to access the final transcript in a docx/docm file\",\n                        \"language_code\": \"en\"\n                    }\n                ],\n                \"processed_input_media\": [\n                    {\n                        \"filename\": \"name of the processed media file\",\n                        \"file_subtype\": \"merged_filename\",\n                        \"download_url\": \"S3 URL to access the processed media file\"\n                    }\n                ],\n                \"extracted_fields_url\": null\n            }\n        }\n    }\n}\n\n</code></pre>\n<p>When the input includes only a media file and the job status is '<strong>In Progress</strong>'.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"success\": true,\n    \"msg\": \"NOTICE: Job is currently being processed.\",\n    \"job_data\": {\n        \"job_info\": {\n            \"job_reference_id\": \"&lt;job_reference_id&gt;\",\n            \"job_name\": \"&lt;job_name&gt;\",\n            \"status\": \"completed\",\n            \"profile_name\": \"Name of the profile you are using for transcription\",\n            \"submitted_at\": \"submission timestamp\",\n            \"completed_at\": \"submission timestamp\",\n            \"total_audio_length\": \"audio length in seconds\",\n            \"is_blank_audio\": false,\n            \"error_message\": null\n        },\n        \"job_files\": {\n            \"input_files\": [\n                {\n                    \"filename\": \"media file name\",\n                    \"file_type\": \"audio\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the media file\"\n                }\n            ],\n            \"output_files\": null\n        }\n    }\n}\n\n</code></pre>\n<p>When the job status is '<strong>Error</strong>'</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"success\": false,\n    \"msg\": \"ERROR: Job processing failed.\",\n    \"job_data\": {\n        \"job_info\": {\n            \"job_reference_id\": \"&lt;job_reference_id&gt;\",\n            \"job_name\": \"&lt;job_name&gt;\",\n            \"status\": \"completed\",\n            \"profile_name\": \"Name of the profile you are using for transcription\",\n            \"submitted_at\": \"submission timestamp\",\n            \"completed_at\": \"submission timestamp\",\n            \"total_audio_length\": \"audio length in seconds\",\n            \"is_blank_audio\": false,\n            \"error_message\": null\n        },\n        \"job_files\": {\n            \"input_files\": [\n                {\n                    \"filename\": \"media file name\",\n                    \"file_type\": \"audio\",\n                    \"file_size\": file size in bytes,\n                    \"download_url\": \"S3 URL to access the media file\"\n                }\n            ],\n            \"output_files\": null\n        }\n    }\n}\n\n</code></pre>\n<p><strong>Link to KB article:</strong> <a href=\"https://support.loomanalytics.com/api-call-get-job-details\">https://support.loomanalytics.com/api-call-get-job-details</a></p>\n","urlObject":{"protocol":"https","path":["api","oa","<slug>","jobs","<job_reference_id>","details"],"host":["<base_url>"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6ba3f40-c243-418c-9320-398aec0cbd58"}],"id":"b7e5422f-2d47-4494-9869-6b15663125b4","_postman_id":"b7e5422f-2d47-4494-9869-6b15663125b4","description":""}],"event":[{"listen":"prerequest","script":{"id":"cffb71d8-3b3c-46c6-af98-17199ed04d82","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"be01e18e-1ae0-4f41-8585-13db75addebe","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://app.loomclaudio.com/api/oa/claudioaus"},{"key":"api_key","value":"3DiJpSCZ7Kapi63c6eb493edc7"},{"key":"secret","value":"7YL6ramiQPdVHcJqe7rQsMRx4WlHfdapi63c6eb493edd7"},{"key":"job_reference_id","value":"xsCe6oform64f8bfd6c8b62"}]}