This is a collection of Oz Forensics API methods.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28105966","collectionId":"fc8eb65f-497c-44a9-8840-bfe76655bded","publishedId":"2sB34eJMYC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00816d"},"publishDate":"2025-07-09T08:51:39.000Z"},"item":[{"name":"Instant","event":[{"listen":"test","script":{"exec":["var jsonData = pm.response.json();","","if (jsonData.length > 0) {"," var media_id = jsonData[0]['media_id'];"," pm.environment.set('media_id', media_id);"," "," if (jsonData[0]['media_type'].substring(0, 5) == 'IMAGE'){"," pm.environment.set('media_url', jsonData[0]['original_url']);"," }else{"," pm.environment.set('media_url', jsonData[0]['video_url']);"," }","","}else{"," pm.environment.unset('media_id');"," pm.environment.unset('media_url');","}",""],"type":"text/javascript","packages":{},"id":"7c086016-5253-426a-b426-6963382513f8"}}],"id":"054abf32-959c-417c-9eb9-cc8e958555b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Forensic-Access-Token","value":"{{access_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"media_key1","description":"any key for a video
\n","type":"file","value":null},{"key":"media_key2","description":"any key for a photo
\n","type":"file","value":null},{"key":"media_key3","description":"any key for a ZIP archive
\n","type":"file","value":null},{"key":"payload","value":"{\n \"folder:meta_data\": {\n \"partner_side_folder_id\": \"159FD350-E8DD-4A5A-B958-0740B95BD620\",\n \"person_info\": {\n \"first_name\": \"John\",\n \"middle_name\": \"Jameson\",\n \"last_name\": \"Doe\"\n }\n },\n \"media:meta_data\": {\n \"media_key1\": {\n \"foo\": \"bar2\"\n },\n \"media_key2\": {\n \"foo2\": \"bar3\"\n },\n \"media_key3\": {\n \"foo4\": \"bar5\"\n }\n },\n \"media:tags\": {\n \"media_key1\": [\n \"video_selfie\",\n \"video_selfie_blank\"\n ],\n \"media_key2\": [\n \"photo_selfie\"\n ],\n \"media_key3\": [\n \"video_selfie\",\n \"video_selfie_blank\",\n \"orientation_portrait\"\n ]\n },\n \"analyses\": [\n {\n \"type\": \"quality\",\n \"meta_data\": {\n \"example1\": \"some_example1\"\n },\n \"params\": {\n \"threshold_spoofing\": 0.5,\n \"extract_best_shot\":false\n }\n }\n ]\n }","type":"text"}]},"url":"{{host}}/api/instant/folders/","description":"Sends the request for analyses using your media
\n","urlObject":{"path":["api","instant","folders",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8951f01d-2b15-4562-b088-a85a1d1d4d15","name":"Instant","originalRequest":{"method":"POST","header":[{"key":"X-Forensic-Access-Token","value":"{{access_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"media_key1","description":"any key for a video","type":"file","value":null},{"key":"media_key2","description":"any key for a photo","type":"file","value":null},{"key":"media_key3","description":"any key for a ZIP archive","type":"file","value":null},{"key":"payload","value":"{\n \"folder:meta_data\": {\n \"partner_side_folder_id\": \"159FD350-E8DD-4A5A-B958-0740B95BD620\",\n \"person_info\": {\n \"first_name\": \"John\",\n \"middle_name\": \"Jameson\",\n \"last_name\": \"Doe\"\n }\n },\n \"media:meta_data\": {\n \"media_key1\": {\n \"foo\": \"bar2\"\n },\n \"media_key2\": {\n \"foo2\": \"bar3\"\n },\n \"media_key3\": {\n \"foo4\": \"bar5\"\n }\n },\n \"media:tags\": {\n \"media_key1\": [\n \"video_selfie\",\n \"video_selfie_blank\"\n ],\n \"media_key2\": [\n \"photo_selfie\"\n ],\n \"media_key3\": [\n \"video_selfie\",\n \"video_selfie_blank\",\n \"orientation_portrait\"\n ]\n },\n \"analyses\": [\n {\n \"type\": \"quality\",\n \"meta_data\": {\n \"example1\": \"some_example1\"\n },\n \"params\": {\n \"threshold_spoofing\": 0.7,\n \"extract_best_shot\":false\n }\n }\n ]\n }","type":"text"}]},"url":"{{host}}/api/instant/folders/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Jun 2025 12:57:06 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.8"},{"key":"Content-Type","value":"application/json; charset=utf8"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n // omitted to shorten the example\n // the response returns the full data, but doesn't save it \n \"analyses\": [\n {\n // omitted to shorten the example\n // the response returns the full data, but doesn't save it \n \n \"type\": \"QUALITY\",\n \"analysis_id\": \"analysis_id\",\n \"resolution_status\": \"SUCCESS\",\n \"resolution\": \"SUCCESS\"\n }\n ]\n}"}],"_postman_id":"054abf32-959c-417c-9eb9-cc8e958555b1"},{"name":"Versions","id":"d833daf6-7f37-4578-b281-066f0eb0c0cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/version","description":"Retrieves the API version; also can be used as healthcheck.
\n","urlObject":{"path":["api","version"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"62524b76-4c4f-4022-9919-40efa79a9022","name":"Versions","originalRequest":{"method":"GET","header":[],"url":"{{host}}/api/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Jun 2025 12:46:25 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.8"},{"key":"Content-Type","value":"application/json; charset=utf8"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"lamb\": \"3.2.0\",\n \"core\": \"6.2.5-2\",\n \"oz_api\": \"6.2.5-2\"\n}"}],"_postman_id":"d833daf6-7f37-4578-b281-066f0eb0c0cf"},{"name":"Health check","id":"0652ac7a-9039-41eb-a254-7610fa6e0465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/healthcheck?task_timeout=1.5&celery_timeout=2.5","description":"Performs a health check by assessing the status of the
database and celery tasks. Accepts optional GET parameters to specify
timeouts for tasks and celery operations.
Returns a JSON that includes details of each check and the
overall health status ('generally_healthy'), and if there
are any issues, it provides the exception that
occurred.
Returns 200 if all checks passed, or 500 if any check fails.
\n","urlObject":{"path":["api","healthcheck"],"host":["{{host}}"],"query":[{"key":"task_timeout","value":"1.5"},{"key":"celery_timeout","value":"2.5"}],"variable":[]}},"response":[{"id":"d010cf12-ffe5-4b68-9327-9a73b082fd56","name":"Health check","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/api/healthcheck?task_timeout=1.5&celery_timeout=2.5","host":["{{host}}"],"path":["api","healthcheck"],"query":[{"key":"task_timeout","value":"1.5"},{"key":"celery_timeout","value":"2.5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Wed, 30 Apr 2025 06:48:58 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-type","value":"application/json; charset=utf8"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"generally_healthy\": true,\n // nothing is stored in the database\n // Instant API sends the same request as the persistent one,\n // so database status is also checked, but doesn't matter\n \"db\": \"ok\"\n}"}],"_postman_id":"0652ac7a-9039-41eb-a254-7610fa6e0465"},{"name":"Config","id":"0375f817-f128-4320-afac-6473c55672b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/api/config","description":"Retrieves the API configs.
\n","urlObject":{"path":["api","config"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"81d2139e-efc1-49d6-a5b3-cb8f16432095","name":"Config","originalRequest":{"method":"GET","header":[],"url":"{{host}}/api/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Jun 2025 12:45:32 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.8"},{"key":"Content-Type","value":"application/json; charset=utf8"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"time_zone\": \"UTC\"\n}"}],"_postman_id":"0375f817-f128-4320-afac-6473c55672b1"}]}