{"info":{"_postman_id":"ea6761fc-552c-4e0e-aac5-0628687cb77c","name":"Automora External API","description":"

Automora's API makes it quick & easy to integrate Automora's fast, AI-Powered automotive image processing pipeline into your own systems.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32398685","collectionId":"ea6761fc-552c-4e0e-aac5-0628687cb77c","publishedId":"2sAXjF7EQS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6e23fe"},"publishDate":"2024-08-23T11:59:27.000Z"},"item":[{"name":"Create Job","event":[{"listen":"test","script":{"id":"7f930237-d267-4e84-9a82-7818d42f1b4f","exec":["pm.test(\"Response status code is 201\", function () {\r"," pm.response.to.have.status(201);\r","});\r","\r","\r","pm.test(\"Response has the required fields - job_id and status\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData.job_id).to.exist;\r"," pm.expect(responseData.status).to.exist;\r","});\r","\r","\r","pm.test(\"Job_id is a non-empty string\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData.job_id).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Value should not be empty\");\r","});\r","\r","\r","pm.test(\"Status is a non-empty string\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData.status).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Status should not be empty\");\r","});\r","\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});"],"type":"text/javascript","packages":{}}}],"id":"47eba7b7-4bc6-4cbd-8f59-0c41532d2dd2","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"showcase_images\": [\r\n {\r\n \"url\": \"//6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866672157x378942053139747140/_MG_6540.jpg\" \r\n \r\n }, \r\n {\r\n \"url\": \"//6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866675619x887217476310231400/_MG_6730.jpg\" \r\n \r\n }\r\n ], \r\n \"standard_images\": [\r\n {\r\n \"url\": \"//6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866673773x899623168322167600/_MG_6546.jpg\"\r\n }\r\n ], \r\n \"background\": \"1721725711229x426320456471281660.jpg\", \r\n \"divider\": \"1721736827072x913740460163596300.png\", \r\n \"logo_url\": \"//6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1721731425817x640703792419782500/porsche%20%283%29.png\", \r\n \"targ_w\": 4032, \r\n \"targ_h\": 3024, \r\n \"turntable_detection\": true,\r\n \"metadata\":{},\r\n \"webhook_url\":\"https://webhook.site/71f9fef2-5f70-4d15-87b1-a6cf77f7ea6f\",\r\n \"cutout_handler\":\"fake\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.automora.ai/v1/jobs","description":"

This endpoint facilitates simultaneous processing of multiple showcase and standard images. Neither type of image is required; both can be processed independently. You must provide URLs for all images.

Parameters

showcase_images (array of JSON objects, optional):
Exterior images requiring background replacement, road cleanup, and centering.
\n
- url (string, required): Direct, public-facing URL of the image (must be in JPG, JPEG, or PNG format).
  \n
- horizon (number, optional): Adjusts horizon position; if omitted, AI inference is applied (recommended).
  \n
- x_padding (number, optional): Adjusts horizontal positioning; if omitted, AI inference is applied.
  \n
\n
standard_images (array of objects, optional):
Additional images requiring resizing (image filters and enhancements are planned for future releases).
\n
- url (string, required): Direct URL of the image (must be in JPG, JPEG, or PNG format).
\n
background (string, required):
Filename of the background to apply. Background options can be found at the Background Shop.
\n
divider (string, required):
Filename of the divider to use. Divider options can be found at the Background Shop.
\n
logo_url (string, optional):
URL of branding to overlay on showcase images. Must be in JPG, JPEG, or PNG format (PNG recommended for transparency).
\n
targ_w (integer, optional):
Target width of the output images. Recommended value: 4032.
\n
targ_h (integer, optional):
Target height of the output images. Recommended value: 3024.
\n
turntable_detection (boolean, optional):
Set to true if most showcase images were captured on a turntable. Enables additional processing to detect and remove turntable seams. Note - All turntables are different, so experiment with this feature if you aren't happy with the outcome.
\n
webhook_url (string, optional):
URL for receiving job status updates. Must support the following endpoints:
\n
- /ad_status
  \n
- /reprocess_status
  \n
\n

(Using a webhook is more efficient and preferred over polling the GET /jobs/ endpoint.

metadata (JSON object, optional):
Allows storage of custom metadata related to the job. Use this field to include information for internal reference (e.g., vehicle registrations, IDs, or VINs).

Notes

Required Parameters: At least one of showcase_images or standard_images must be included for a successful request.
\n
File Formats: Only JPG, JPEG, and PNG formats are supported for images. Ensure URLs are public-facing and point directly to files of these types.
\n
Background and Divider Filenames: Ensure filenames match those listed in the Background Shop.
\n
Output Recommendations: Target dimensions (targ_w and targ_h) of 4032 x 3024 ensure optimal quality.
\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ea6761fc-552c-4e0e-aac5-0628687cb77c","id":"ea6761fc-552c-4e0e-aac5-0628687cb77c","name":"Automora External API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","jobs"],"host":["api","automora","ai"],"query":[],"variable":[]}},"response":[{"id":"c1dc8efe-a4a5-4dc4-9504-038b9a496f94","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"showcase_images\": [\r\n {\r\n \"url\": \"https://cdn.automora.ai/3edaffe6-ae90-4f8c-b21e-4e29c618d0cc/04_1398c85d_original.jpg\" \r\n \r\n }, \r\n {\r\n \"url\": \"https://cdn.automora.ai/3edaffe6-ae90-4f8c-b21e-4e29c618d0cc/04_1398c85d_original.jpg\" \r\n }\r\n ], \r\n \"standard_images\": [\r\n {\r\n \"url\": \"https://cdn.automora.ai/3edaffe6-ae90-4f8c-b21e-4e29c618d0cc/cc98229e_processed.jpg\"\r\n }\r\n ], \r\n \"background\": \"1721725711229x426320456471281660.jpg\", \r\n \"divider\": \"1721736827072x913740460163596300.png\", \r\n \"logo_url\": \"//6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1721731425817x640703792419782500/porsche%20%283%29.png\", \r\n \"targ_w\": 4032, \r\n \"targ_h\": 3024, \r\n \"turntable_detection\": true,\r\n \"metadata\":{}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.automora.ai/dev/jobs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 13:43:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c841f39e-f217-46ab-9e3d-6d2413539c8b"},{"key":"x-amz-apigw-id","value":"c3JFiEQIgi0Ej8A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c5eeef-7c1d4ef91d8b8b461d0be159;Parent=7623737a91217d61;Sampled=0;lineage=fbe61435:0"}],"cookie":[],"responseTime":null,"body":"{\n \"job_id\": \"external_aec7fc12-13a2-4a99-827c-77703b49b14b\",\n \"status\": \"Queued\"\n}"},{"id":"309402b4-da55-4ca1-a125-c1f10c3576f5","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"showcase_images\": [\r\n {\r\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866672157x378942053139747140/_MG_6540.jpg\" \r\n \r\n }, \r\n {\r\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866675619x887217476310231400/_MG_6730.jpg\" \r\n \r\n }\r\n ], \r\n \"standard_images\": [\r\n {\r\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866673773x899623168322167600/_MG_6546.jpg\"\r\n }\r\n ], \r\n \"background\": \"1721725711229x426320456471281660.jpg\", \r\n \"divider\": \"1721736827072x913740460163596300.png\", \r\n \"logo_url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1721731425817x640703792419782500/porsche%20%283%29.png\", \r\n \"targ_w\": 4032, \r\n \"targ_h\": 1000, // Too small - will be refusd\r\n \"turntable_detection\": true,\r\n \"metadata\":{}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.automora.ai/dev/jobs"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 14:52:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"7b3f3f7f-684a-4bad-995e-b8e018ab5620"},{"key":"x-amzn-ErrorType","value":"BadRequestException"},{"key":"x-amz-apigw-id","value":"c3TOtEJNAi0ECWw="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid request body\"\n}"},{"id":"6664c44f-c286-44cc-b797-597e8e94408b","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"showcase_images\": [\r\n {\r\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866672157x378942053139747140/_MG_6540.jpg\" \r\n \r\n }, \r\n {\r\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866675619x887217476310231400/_MG_6730.jpg\" \r\n \r\n }\r\n ], \r\n \"standard_images\": [\r\n {\r\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866673773x899623168322167600/_MG_6546.jpg\"\r\n }\r\n ], \r\n \"background\": \"1721725711229x426320456471281660.jpg\", \r\n \"divider\": \"1721736827072x913740460163596300.png\", \r\n \"logo_url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1721731425817x640703792419782500/porsche%20%283%29.png\", \r\n \"targ_w\": 4032, \r\n \"targ_h\": 1000, // Too small - will be refused\r\n \"turntable_detection\": true,\r\n \"metadata\":{}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.automora.ai/dev/jobs"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 14:52:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2b803322-3e39-4f40-b10f-644d8aa1c704"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"x-amz-apigw-id","value":"c3TRKG-gAi0EfGw="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"47eba7b7-4bc6-4cbd-8f59-0c41532d2dd2"},{"name":"Job Status","event":[{"listen":"test","script":{"id":"fb14ba1c-2450-4fd4-ad55-995632d09d5e","exec":["pm.test('Response status code is 404', function () {"," pm.expect(pm.response.code).to.equal(404);","})","","pm.test('Response has Content-Type header set to application/json', function () {"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');","})","","pm.test('Validate response body against JSON schema', function () {"," const schema = {"," 'type': 'object',"," 'properties': {"," 'job_id': { 'type': 'string' },"," 'status': { 'type': 'string' },"," 'images': {"," 'type': 'array',"," 'items': {"," 'type': 'object',"," 'properties': {"," 'id': { 'type': 'string' },"," 'showcase': { 'type': 'boolean' },"," 'url': { 'type': 'string' }"," }"," }"," }"," }"," };"," pm.response.to.have.jsonSchema(schema);","})","","pm.test('Error field is present in the response', function () {"," const responseData = pm.response.json();"," pm.expect(responseData.error).to.exist;","})"],"type":"text/javascript","packages":{}}}],"id":"d848e285-b255-482c-bd53-e1d9cb4dd8b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.automora.ai/v1/jobs/:job_id","description":"

This endpoint retrieves information about a specific job with the given ID.

The response returned by the API is in JSON format and follows the schema below. Please note that not all fields will be present depending on the status of the job, see the examples.

{\n    \"type\": \"object\",\n    \"properties\": {\n        \"job_id\": {\n            \"type\": \"string\"\n        },\n        \"status\": {\n            \"type\": \"string\"\n        },\n        \"images\": {\n            \"type\": \"array\",\n            \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                    \"id\": {\n                        \"type\": \"string\"\n                    },\n                    \"showcase\": {\n                        \"type\": \"boolean\"\n                    },\n                    \"url\": {\n                        \"type\": \"string\"\n                    }\n                }\n            }\n        }\n    }\n}\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ea6761fc-552c-4e0e-aac5-0628687cb77c","id":"ea6761fc-552c-4e0e-aac5-0628687cb77c","name":"Automora External API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","jobs",":job_id"],"host":["api","automora","ai"],"query":[],"variable":[{"type":"any","value":"external_193ebed5-6840-4a28-89a3-c0843dc3a965","key":"job_id"}]}},"response":[{"id":"370d8db1-0e08-4bfd-aa62-bd1c22ee8c8d","name":"200 Ready","originalRequest":{"method":"GET","header":[],"url":"https://api.automora.ai/dev/jobs/external_32355bc5-6338-4140-a42e-64b21cc2e07b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 13:42:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"490"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"61e50098-3948-4479-8ffe-fd865ef67099"},{"key":"x-amz-apigw-id","value":"c3I84G9zAi0Enzw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c5eeb8-3e8368f62c19f95b423c829c;Parent=175a8363233482ec;Sampled=0;lineage=039238de:0"}],"cookie":[],"responseTime":null,"body":"{\n \"job_id\": \"external_32355bc5-6338-4140-a42e-64b21cc2e07b\",\n \"status\": \"Ready\",\n \"images\": [\n {\n \"id\": \"45db31f4\",\n \"showcase\": true,\n \"url\": \"cdn.automora.ai/external_32355bc5-6338-4140-a42e-64b21cc2e07b/45db31f4_processed.jpg\"\n },\n {\n \"id\": \"2865b653\",\n \"showcase\": true,\n \"url\": \"cdn.automora.ai/external_32355bc5-6338-4140-a42e-64b21cc2e07b/2865b653_processed.jpg\"\n },\n {\n \"id\": \"98a95a51\",\n \"showcase\": false,\n \"url\": \"cdn.automora.ai/external_32355bc5-6338-4140-a42e-64b21cc2e07b/98a95a51_processed.jpg\"\n }\n ]\n}"},{"id":"da691544-82e1-42b5-a011-99ddae8bb07b","name":"200 Failed","originalRequest":{"method":"GET","header":[],"url":"https://api.automora.ai/dev/jobs/external_6e7eee82-4566-4f3a-94cf-85499936dd95"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 14:36:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"211"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"e8c287a2-85b7-4b04-8c8f-1f2cdf731947"},{"key":"x-amz-apigw-id","value":"c3Q5_G6zAi0EPPw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c5fb72-6e0236365b20eef327477dd7;Parent=2024f7fb5100191e;Sampled=0;lineage=039238de:0"}],"cookie":[],"responseTime":null,"body":"{\n \"job_id\": \"external_6e7eee82-4566-4f3a-94cf-85499936dd95\",\n \"status\": \"Failed\",\n \"err_body\": \"Please ensure your logo URL points directly to an image file.\",\n \"err_reason\": \"InvalidLogoException: No image found.\"\n}"},{"id":"86420a44-2082-49ec-a790-67390371e9e7","name":"200 Processing","originalRequest":{"method":"GET","header":[],"url":"https://api.automora.ai/dev/jobs/external_97c3a574-2e03-4d46-bcdd-37de7c885eb2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 14:57:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"83"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a2acb3e4-498f-44b6-ba7e-a7a8ac1e7e02"},{"key":"x-amz-apigw-id","value":"c3UAmFWAgi0Ef0A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c60069-5dde11b55775acdc2cf33198;Parent=1d05f99a7eb196fd;Sampled=0;lineage=039238de:0"}],"cookie":[],"responseTime":null,"body":"{\n \"job_id\": \"external_97c3a574-2e03-4d46-bcdd-37de7c885eb2\",\n \"status\": \"Processing\"\n}"},{"id":"3405ce7d-8672-4ddc-bd83-9832e17b272f","name":"404 Job Not Found","originalRequest":{"method":"GET","header":[],"url":"https://api.automora.ai/dev/jobs/external_32355bc5-633"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 Aug 2024 13:42:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"63352b8a-bdb2-4d5a-a98c-c063ac77e502"},{"key":"x-amz-apigw-id","value":"c3JCAFydgi0EQXA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c5eed9-5580f7fb4095a8a02e5d8877;Parent=286f8d3a5e52cd6f;Sampled=0;lineage=039238de:0"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Job not found\"\n}"},{"id":"e9652f47-ca78-40c7-8e79-c8cbffcc8bc4","name":"200 Queued w/ Metadata","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.automora.ai/dev/jobs/:job_id","protocol":"https","host":["api","automora","ai"],"path":["dev","jobs",":job_id"],"variable":[{"key":"job_id","value":"external_eb7db99f-c621-4018-b563-5d55e637c233"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2024 11:11:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"123"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"2cbd2dc7-7085-4ee6-a801-888729b9bab8"},{"key":"x-amz-apigw-id","value":"c9YwtFPUgi0Enzw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c86e6a-6cf015834fa4817f36e8c9b9;Parent=4231c70164d3e6ff;Sampled=0;lineage=039238de:0"}],"cookie":[],"responseTime":null,"body":"{\n \"job_id\": \"external_eb7db99f-c621-4018-b563-5d55e637c233\",\n \"status\": \"Queued\",\n \"metadata\": {\n \"my_custom_metadata\": 123456\n }\n}"}],"_postman_id":"d848e285-b255-482c-bd53-e1d9cb4dd8b9"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"2d89d25a-fad1-4c3b-a811-ae146aca36ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"74ec8ba7-ff41-486a-bce3-27e638cc9c45","type":"text/javascript","exec":[""]}}],"variable":[{"key":"targ_h","value":"3024","type":"string"},{"key":"targ_w","value":"4032","type":"string"},{"key":"showcase_images","value":"[\n {\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866672157x378942053139747140/_MG_6540.jpg\"\n },\n {\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866675619x887217476310231400/_MG_6730.jpg\"\n }\n ]","type":"string"},{"key":"standard_images","value":"[\n {\n \"url\": \"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1722866673773x899623168322167600/_MG_6546.jpg\"\n }\n ]","type":"string"},{"key":"turntable_detection","value":"true","type":"string"},{"key":"logo_url","value":"https://6a09c5e041c2293a316c49362c62833c.cdn.bubble.io/f1721731425817x640703792419782500/porsche%20%283%29.png","type":"string"},{"key":"background","value":"1721725711229x426320456471281660.jpg","type":"string"},{"key":"divider","value":"1721736827072x913740460163596300.png","type":"string"}]}