{"info":{"_postman_id":"b3cde338-cc96-4265-be7e-a3ef8990edb9","name":"REimagineHome API Documentation v1.0","description":"<html><head></head><body><hr>\n<p>The ReimagineHome APIs are designed to provide seamless integration and functionality for developers. Our APIs follow a RESTful architecture, offering predictable and resource-oriented URLs for easy navigation and interaction. Request bodies are encoded using the standard form-encoded format, and responses are returned in JSON, making data manipulation and interpretation straightforward.</p>\n<p>Authentication and security are paramount, and our API employs standard HTTP response codes, authentication mechanisms, and HTTP verbs to ensure secure and reliable communication. We currently support an API key-based authentication method for API requests.</p>\n<p><strong>Note:</strong> If you wish to test these APIs using Postman, you must generate your API keys first. To get your API keys log into REimagineHome API Dashboard, register your organization, and then follow the steps to generate your API keys.</p>\n<img src=\"https://content.pstmn.io/1d519c45-f2d0-4aa8-9775-32a29f6bdd84/U2NyZWVuc2hvdCAyMDIzLTA3LTA0IDE3MDAwNS5wbmc=\">\n\n<h1 id=\"service-endpoint\">Service endpoint</h1>\n<hr>\n<p>A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. The service endpoint for all REimagineHome APIs and all URIs mentioned in this document are relative to this service endpoint:</p>\n<ul>\n<li><a href=\"null\"><b>https://api.reimaginehome.ai</b></a></li>\n</ul>\n<h1 id=\"versioning\">Versioning</h1>\n<hr>\n<p>As we continually improve and enhance our services, the ReimagineHome APIs will also evolve in the future. Therefore, it is essential to log in to your account to access API documentation. The documentation provided will be tailored to your account, complete with your key and associated data, to ensure accurate guidance for integration and development processes.</p>\n<h1 id=\"authentication\">Authentication</h1>\n<hr>\n<p>The REimagineHome APIs utilize API keys for authentication purposes. These API keys act as a secure means of verifying and authorizing requests made to the API.</p>\n<p>To manage and access your API keys, you can log in to the REimagineHome and navigate to the API Dashboard. You will be able to view, manage and administer your API keys from here. It is very important to handle your API keys with care and keep them secure at all times.</p>\n<p>API keys grant access to API calls that may retrieve or change your data and/or may lead to incurring significant charges. It is therefore important that these keys keep them secured at all times to prevent them from being used by unauthorized users. Avoid sharing your REimagineHome API keys in publicly accessible areas such as version control repositories like GitHub or client-side code that can be accessed by others.</p>\n<h1 id=\"rate-limit\">Rate Limit</h1>\n<hr>\n<p>All REimagineHome APIs have a rate limit of 10 requests per second. Exceeding this rate limit will result in 429 (Too Many Requests) HTTP errors.</p>\n<h1 id=\"examples\">Examples</h1>\n<hr>\n<img src=\"https://content.pstmn.io/58ff006e-672f-419f-afd4-211810fdf036/SW50ZXJpb3IgKDIpLmdpZg==\" alt=\"Interior%20(furnishing)\" height=\"417\" width=\"511\">\n\n<img src=\"https://content.pstmn.io/07304018-d03f-4ec3-8683-c4a0d8710603/V2FsbC0xLmdpZg==\" alt=\"Interior%20(architectural)\" width=\"509\" height=\"424\">\n\n<img src=\"https://content.pstmn.io/301003e1-4d06-4476-92a5-3c9221610ce5/RXh0ZXJpb3IgKDIpLmdpZg==\" alt=\"Exterior%20(landscaping)\" height=\"414\" width=\"507\">\n\n<h1 id=\"status-codes-and-errors\">Status Codes and Errors</h1>\n<hr>\n<p>REImagineHome APIs uses common HTTP response status codes to indicate the success or failure of these API requests.</p>\n<p>Following is the list of HTTP status codes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Status Code</th>\n<th>Summary</th>\n<th>Meaning</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>200</td>\n<td>Success</td>\n<td>Your request was successful.</td>\n</tr>\n<tr>\n<td>400</td>\n<td>Bad request</td>\n<td>Your request was not successful due to missing or invalid parameters.</td>\n</tr>\n<tr>\n<td>401</td>\n<td>Invalid Authentication Token</td>\n<td>Your API Key is invalid, expired, or not provided.</td>\n</tr>\n<tr>\n<td>402</td>\n<td>Payment Required</td>\n<td>Your account balance has been exhausted.</td>\n</tr>\n<tr>\n<td>403</td>\n<td>Forbidden</td>\n<td>Your request parameters were valid, but your account does not have adequate permission for the requests.</td>\n</tr>\n<tr>\n<td>404</td>\n<td>Not Found</td>\n<td>The requested resource does not exist.</td>\n</tr>\n<tr>\n<td>405</td>\n<td>Method Not Allowed</td>\n<td>The requested HTTP is not allowed for the given resource.</td>\n</tr>\n<tr>\n<td>422</td>\n<td>Unprocessable Entity</td>\n<td>Your request could not be processed properly due to invalid data. Some of the required parameters might be missing.</td>\n</tr>\n<tr>\n<td>429</td>\n<td>Too Many Requests</td>\n<td>Too many requests within a given amount of time, exceeding the allowed Rate Limit. Refer to the <strong>Rate Limit</strong> section of this document to know about the limits.</td>\n</tr>\n<tr>\n<td>500</td>\n<td>Internal Server Error</td>\n<td>The request was not successful due to server errors.</td>\n</tr>\n<tr>\n<td>504</td>\n<td>Gateway Timeout</td>\n<td>The gateway or server did not get a response in time from the underlying resources needed to complete the request.</td>\n</tr>\n</tbody>\n</table>\n</div><img src=\"https://content.pstmn.io/2fe4473c-e3e2-46d0-9df6-ba09638fc5f5/RXh0ZXJpb3IgKDIpLmdpZg==\" alt=\"\"></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Service endpoint","slug":"service-endpoint"},{"content":"Versioning","slug":"versioning"},{"content":"Authentication","slug":"authentication"},{"content":"Rate Limit","slug":"rate-limit"},{"content":"Examples","slug":"examples"},{"content":"Status Codes and Errors","slug":"status-codes-and-errors"}],"owner":"19598161","collectionId":"b3cde338-cc96-4265-be7e-a3ef8990edb9","publishedId":"2s93z59QQX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0F0F31"},"publishDate":"2023-08-30T04:34:04.000Z"},"item":[{"name":"Mask APIs","item":[{"name":"Create Mask","id":"569b5d07-97b3-40d0-b721-18a5c9f00610","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"image_url\": \"https://example.com/image.png\",\r\n    \"webhook_url\": \"https://example.com/mywebhook/endpoint\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/create_mask","description":"<p>Use this API to generate masks for all detected objects within the image. These masks can be used as inputs for the <strong>Generate Image</strong> API to modify parts of the image based on style, color and other design inputs.</p>\n<h2 id=\"attributes\"><strong>Attributes</strong></h2>\n<hr />\n<blockquote>\n<p><strong>image_url</strong> (<em>required</em>): string<br />publicly accessible URL to specify the location of input image.<br /><em>maximum allowed input image dimension is 2048 x 2048 pixels.</em><br /><em>minimum required input image dimension is 512 x 512 pixels.<br />allowed image types -</em> <em><code>png,jpeg,jpg</code></em> </p>\n</blockquote>\n<blockquote>\n<p><strong>webhook_url:</strong> string<br />optional webhook callback URL, which can be used for receiving the final response when the job is completed or error details when it fails.</p>\n</blockquote>\n","urlObject":{"path":["v1","create_mask"],"query":[],"variable":[]}},"response":[{"id":"9d5722f1-dba7-4bb9-8015-9c22f14aa80f","name":"Create Mask POST","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"image_url\": \"https://example.com/image.png\",\r\n    \"webhook_url\": \"https://example.com/mywebhook/endpoint\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reimaginehome.ai/v1/create_mask"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jun 2023 06:33:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"3628f848-8485-40e2-9843-fe6c15ed2ab2"},{"key":"x-amzn-Remapped-content-length","value":"105"},{"key":"x-amz-apigw-id","value":"G9ZrgFnFPHcF_AA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64953caf-6537f30c19bda4a4001b9842;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": {\n    \"job_id\": \"64953caf718cb48adfc493d9\",\n    \"credits_consumed\": 5\n    }\n}\n\n"}],"_postman_id":"569b5d07-97b3-40d0-b721-18a5c9f00610"},{"name":"Get Mask","id":"3c628bc0-d9a9-467b-ad1e-9490832a4a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"/v1/create_mask/{{job_id}}","description":"<p>Use this API to retrieve the status and details of the masks generated by the <strong>Create Mask</strong> API. You will need to provide the <em>job_id</em> that was received in response to your <strong>Create Mask</strong> API's request.</p>\n<p>If you are not using a webhook to get the final response of <strong>Get Mask</strong> API, then you can use this API to poll at regular intervals, typically every 15 seconds, and retrive the results. The possible values of <em>job_status</em> are <em><strong>created</strong></em>, <em><strong>processing</strong></em>, <em><strong>post_processing,</strong></em> <em><strong>done</strong></em> and <em><strong>error</strong></em>.</p>\n<p><strong>created</strong>: When you initiate a job for processing, the initial status is \"created.\" The job is then placed in a queue for processing.  </p>\n<p><strong>processing</strong>: Once your job reaches the front of the queue, our server begins processing it. At this stage, the job_status will be \"processing.\"  </p>\n<p><strong>post_processing</strong>: After the initial processing is complete, we perform some additional steps before marking the job as \"done.\" This phase is denoted as \"post_processing.\"  </p>\n<p><strong>done</strong>: When the entire process is finished successfully, the job_status will change to \"done.\" At this point, the masks you requested will be available in the masks array.  </p>\n<p><strong>error</strong>: In the event that a job cannot be processed, it will be marked as \"error.\"</p>\n<h2 id=\"attributes\">A<strong>ttributes</strong></h2>\n<hr />\n<blockquote>\n<p><strong>job_id</strong> (<em>required</em>)<strong>:</strong> string<br />id of the job to get status or results for.<br /><em>received in response to the Create Mask API request.</em></p>\n</blockquote>\n","urlObject":{"path":["v1","create_mask","{{job_id}}"],"query":[],"variable":[]}},"response":[{"id":"4d0c2b38-048d-4719-9847-956c16ec74bb","name":"Get Mask Job","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.reimaginehome.ai/v1/create_mask/{{job_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jun 2023 10:17:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"93"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b84af587-2962-4f14-a158-bb4b41bb78c4"},{"key":"x-amzn-Remapped-content-length","value":"93"},{"key":"x-amz-apigw-id","value":"G96ddGHCvHcFhEA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64957122-258bb93d118dc9e83c9f93b1;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\":{\n        \"job_status\": \"done\",\n        \"masks\": [\n            {\n                \"name\": \"bed\",\n                \"url\": \"https://example.com/segment1.png\" ,\n                \"centre\":{\"y\": 498,\"x\": 457},\n                \"category\": \"furnishing\",\n                \"area_percent\": 10\n            },\n            {\n                \"name\": \"table\",\n                \"url\": \"https://example.com/segment2.png\" ,\n                \"centre\":{\"y\": 519,\"x\": 101},\n                \"category\": \"furnishing\",\n                \"area_percent\": 4\n            },\n            {\n                \"name\": \"wall\",\n                \"url\": \"https://example.com/segment3.png\" ,\n                \"centre\":{\"y\": 280,\"x\": 318},\n                \"category\": \"architectural,landscaping\",\n                \"area_percent\": 30\n            }\n        ]\n    }\n}"}],"_postman_id":"3c628bc0-d9a9-467b-ad1e-9490832a4a71"}],"id":"9664cc8a-9ed9-4bae-b97c-bb1ec2dbd52c","_postman_id":"9664cc8a-9ed9-4bae-b97c-bb1ec2dbd52c","description":""},{"name":"Generate APIs","item":[{"name":"Generate Image","id":"2d3de8a7-bff6-4ee9-9074-9e68e756c826","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"image_url\": \"https://example.com/image.png\",\r\n    \"mask_urls\": [\r\n        \"https://example.com/segment1.png\",\r\n        \"https://example.com/segment2.png\"\r\n    ],\r\n    \"mask_category\": \"furnishing\",\r\n    \"space_type\": \"ST-INT-003\",\r\n    \"design_theme\": \"DT-INT-008\",\r\n    \"masking_element\": \"\",\r\n    \"color_preference\": \"green,yellow,black\",\r\n    \"material_preference\": \"\",\r\n    \"landscaping_preference\": \"\",\r\n    \"generation_count\": 3,\r\n    \"additional_prompt\": \"add floral pattern\",\r\n    \"webhook_url\": \"https://example.com/mywebhook/endpoint\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/generate_image","description":"<p>Use this API to create images tailored to your specific preferences for space, style, color and design. For masks, you can include the URLs of the masks generated via the Create Mask API or you can include the URLs of your custom masks. Ensure that the input image size matches with all mask dimensions to avoid validation errors in the API response.</p>\n<h2 id=\"attributes\">Attributes</h2>\n<hr />\n<blockquote>\n<p><strong>image_url</strong> (<em>required</em>): string<br />publicly accessible URL to specify the location of input image.<br /><em>maximum allowed input image dimension is 2048 x 2048 pixels.</em><br /><em>minimum required input image dimension is 512 x 512 pixels.</em><br /><em>allowed image types -</em> <code>png,jpeg,jpg</code> </p>\n</blockquote>\n<blockquote>\n<p><strong>mask_urls</strong> (<em>required</em>): array<br />array of mask object URLs received in response to Create Mask API request. Make sure the input image and all mask images have the same dimensions. If not, the API will give a validation error.<br /><code>[\"https://example.com/segment1.png\",\"https://example.com/segment2.png\", ... ]</code> </p>\n</blockquote>\n<blockquote>\n<p><strong>mask_category</strong> (<em>required</em>)<strong>:</strong> string<br />category of the masking elements. It must be one of the following values:<br />• architectural<br />• furnishing<br />• landscaping </p>\n</blockquote>\n<blockquote>\n<p><strong>masking_element</strong>: string<br />required only when the masking_category is set to <em><strong>architectural</strong></em>. It must be one of the following values:<br />• wall<br />• floor<br />• ceiling </p>\n</blockquote>\n<blockquote>\n<p><strong>space_type</strong> (<em>required</em>): string<br />type of space to be considered for the design generation.<br /><em>Use</em> <strong>Get Space Type List</strong> <em>API to retrieve the latest list of codes for supported interior and exterior</em> <em>space_type.</em> </p>\n</blockquote>\n<blockquote>\n<p><strong>design_theme:</strong> string<br />design theme or style to be considered for the design generation.<br /><em>Use</em> <strong>Get Design Theme List</strong> <em>API to retrieve the latest list of codes for supported interior and exterior design_theme.</em> </p>\n</blockquote>\n<blockquote>\n<p><strong>color_preference:</strong> string<br />color preference to be considered for the design generation.<br /><em>Use</em> <strong>Get Color Preference List</strong> <em>API to retrieve the latest list of recommended colors and patterns. You can create color preferences by using a color or a pattern or both.</em><br /><em>Following are some examples:</em><br /><code>creamy white, brown, green</code><br /><code>dark teal, yellow, gray &amp; geometric pattern</code><br /><code>polka dot pattern</code> </p>\n</blockquote>\n<blockquote>\n<p><strong>material_preference</strong>: string<br />material preference to be considered for the design generation.<br /><em>Following are some examples:</em><br /><code>oak wood flooring</code><br /><code>ceramic tile</code><br /><code>marble flooring</code> </p>\n</blockquote>\n<blockquote>\n<p><strong>landscaping_preference</strong>: string<br />landscaping preference to be considered for the design generation of exterior space.<br /><em>Use</em> <strong>Get Landscaping Preference List</strong> <em>API to retrieve the latest lists of recommended pathway styles and plants. You can create landscaping preferences by using a pathway style or a plant or both.</em><br /><em>Following are some examples:</em><br /><code>stone pathway</code><br /><code>pea gravel pathway &amp; lantanabrick</code><br /><code>walkway &amp; alliums</code> </p>\n</blockquote>\n<blockquote>\n<p><em><strong>NOTE:</strong></em><br />The following table summarizes the type of preferences to be used for getting the best designs: </p>\n</blockquote>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Category</strong></th>\n<th><strong>Mask Elements</strong></th>\n<th><strong>Color Preference</strong></th>\n<th><strong>Landscape  <br />Preference</strong></th>\n<th><strong>Material  <br />Preference</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Furnishing</td>\n<td>All Elements</td>\n<td>Required</td>\n<td>N/A</td>\n<td>N/A</td>\n</tr>\n<tr>\n<td>Architectural</td>\n<td>Wall</td>\n<td>Required</td>\n<td>N/A</td>\n<td>N/A</td>\n</tr>\n<tr>\n<td></td>\n<td>Floor</td>\n<td>N/A</td>\n<td>N/A</td>\n<td>Required</td>\n</tr>\n<tr>\n<td></td>\n<td>Ceiling</td>\n<td>Required</td>\n<td>N/A</td>\n<td>N/A</td>\n</tr>\n<tr>\n<td>Landscaping</td>\n<td>All Elements</td>\n<td>N/A</td>\n<td>Required</td>\n<td>N/A</td>\n</tr>\n</tbody>\n</table>\n</div><blockquote>\n<p>Use Material preference when designing the floor for the Architectural category and Landscaping preference for the Landscaping category. </p>\n</blockquote>\n<blockquote>\n<p><strong>generation_count</strong>: number<br />maximum number of images to generate, must be set to either 1, 2, or 3. </p>\n</blockquote>\n<blockquote>\n<p><strong>additional_prompt:</strong> string<br />the additional prompt to be considered for the design generation.<br /><em>Following are some examples:</em><br /><code>add floral pattern</code><br /><code>blue color on wall</code><br /><code>add sunflower pattern</code> </p>\n</blockquote>\n<blockquote>\n<p><strong>webhook_url</strong>: string<br />optional webhook callback URL, which can be used for receiving the final response when the job is completed or error details when it fails.<br />response status code for webhook URL should be 200</p>\n</blockquote>\n","urlObject":{"path":["v1","generate_image"],"query":[],"variable":[]}},"response":[{"id":"d9c3920e-bf4d-4ecd-bf12-1b094ce20231","name":"Create Generation Job","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"image_url\": \"https://example.com/image.png\",\r\n    \"mask_urls\": [\r\n        \"https://example.com/segment1.png\",\r\n        \"https://example.com/segment2.png\"\r\n    ],\r\n    \"mask_category\": \"furnishing\",\r\n    \"space_type\": \"ST-INT-003\",\r\n    \"design_theme\": \"DT-INT-008\",\r\n    \"masking_element\": \"\",\r\n    \"color_preference\": \"green,yellow,black\",\r\n    \"material_preference\": \"\",\r\n    \"landscaping_preference\": \"\",\r\n    \"generation_count\": 3,\r\n    \"additional_prompt\": \"add floral pattern\",\r\n    \"webhook_url\": \"https://example.com/mywebhook/endpoint\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.reimaginehome.ai/v1/generate_image"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Jun 2023 11:18:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"058a6c79-c805-49c4-82f3-a23980942720"},{"key":"x-amzn-Remapped-content-length","value":"105"},{"key":"x-amz-apigw-id","value":"G6wemEPPvHcFRwQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64942df6-05bed22b07f249da05d16a09;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": {\n    \"job_id\": \"64942df78ee49c82ce835282\",\n    \"creadits_consumed\": 5\n    }\n}\n\n"}],"_postman_id":"2d3de8a7-bff6-4ee9-9074-9e68e756c826"},{"name":"Get Image","id":"9bfac780-2b6b-4c46-8d32-570e60dffc5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"/v1/generate_image/{{job_id}}","description":"<p>Use this API to obtain the generated outputs based on the provided input parameters and the processed image with masked elements. You will need to provide the job ID that was returned by the <strong>generate image</strong> API.</p>\n<p>If you are not using a webhook to get the final response of <strong>Generate Image</strong> API, then you can use this API to poll at regular intervals, typically every 15 seconds, and retrive the results. The possible values of <em>job_status</em> are <em><strong>created</strong></em>, <em><strong>processing</strong></em>, <em><strong>post_processing,</strong></em> <em><strong>done</strong></em> and <em><strong>error</strong></em>.</p>\n<p><strong>created</strong>: When you initiate a job for processing, the initial status is \"created.\" The job is then placed in a queue for processing.</p>\n<p><strong>processing</strong>: Once your job reaches the front of the queue, our server begins processing it. At this stage, the job_status will be \"processing.\"</p>\n<p><strong>post_processing</strong>: After the initial processing is complete, we perform some additional steps before marking the job as \"done.\" This phase is denoted as \"post_processing.\"</p>\n<p><strong>done</strong>: When the entire process is finished successfully, the job_status will change to \"done.\" At this point, the generated images you requested will be available in the generated_images array.</p>\n<p><strong>error</strong>: In the event that a job cannot be processed, it will be marked as \"error.\"</p>\n<h2 id=\"attributes\">Attributes</h2>\n<hr />\n<blockquote>\n<p><strong>job_id</strong> (<em>required</em>)<strong>:</strong> string<br />received in response to the Generate Image API's request.</p>\n</blockquote>\n","urlObject":{"path":["v1","generate_image","{{job_id}}"],"query":[],"variable":[]}},"response":[{"id":"0c4c2c9d-467f-4d77-a949-3c943b18b49b","name":"Generation GET Example","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.reimaginehome.ai/v1/generate_image/{{job_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Jun 2023 11:43:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"331"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"fcc3af99-21c0-4274-985f-721be85734c3"},{"key":"x-amzn-Remapped-content-length","value":"331"},{"key":"x-amz-apigw-id","value":"G60MbHRjPHcFlmA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-649433e8-1df322406ddf7b4f584c362a;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\":{\n        \"job_status\": \"done\",\n        \"generated_images\": [\n        \"https://magicstore.s3.us-west-2.amazonaws.com/REimagine-images/b1afe159-74e7-4695-afdd-5b3bf7c97079.png\",\n        \"https://magicstore.s3.us-west-2.amazonaws.com/REimagine-images/b4932812-bc4a-4744-8ffa-6604407bec84.png\",\n        \"https://magicstore.s3.us-west-2.amazonaws.com/REimagine-images/6e55e3ad-4e42-463f-b3a7-a8ddba60f0e6.png\"\n         ]\n    } \n}"}],"_postman_id":"9bfac780-2b6b-4c46-8d32-570e60dffc5b"}],"id":"7d3dfb98-de5c-4baa-9134-7d90111f2346","_postman_id":"7d3dfb98-de5c-4baa-9134-7d90111f2346","description":""},{"name":"Helper APIs","item":[{"name":"Get Space Type List","id":"bcee3b8a-ff6d-4ea1-a5dd-668d9686ef28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"/v1/get-space-type-list","description":"<p>Use this API to retrieve the latest lists of interior and exterior design themes to be used as <em>space_type</em> for <strong>Generate Image</strong> API. This list contains the currently allowed values of space types and it has been specifically curated to generate optimal outputs.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>CATEGORY</strong></th>\n<th><strong>CODE</strong></th>\n<th><strong>SPACE TYPE</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>INTERIOR</td>\n<td>ST-INT-001</td>\n<td>Bar</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-002</td>\n<td>Bathroom / Ensuite</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-003</td>\n<td>Bedroom</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-004</td>\n<td>Dining</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-005</td>\n<td>Foyer</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-006</td>\n<td>Games Area / Rumpus Room</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-007</td>\n<td>Hobby / Craft Room</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-008</td>\n<td>Kids Room</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-009</td>\n<td>Kitchen</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-010</td>\n<td>Laundry</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-011</td>\n<td>Living Room / Family Room / Lounge</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-012</td>\n<td>Media Room  <br /></td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-013</td>\n<td>Nursery</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-014</td>\n<td>Pantry</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-015</td>\n<td>Single Room Studio / Unit</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-016</td>\n<td>Study</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-INT-017</td>\n<td>Sunroom</td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>EXTERIOR</td>\n<td>ST-EXT-001</td>\n<td>Backyard</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-EXT-002</td>\n<td>Garden</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-EXT-003</td>\n<td>Outdoor Living</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-EXT-004</td>\n<td>Poolside</td>\n</tr>\n<tr>\n<td></td>\n<td>ST-EXT-005</td>\n<td>Deck / Patio</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","get-space-type-list"],"query":[],"variable":[]}},"response":[{"id":"cfba0abc-cb4c-47a9-a6d3-e0ce9b502095","name":"Get Space Type List","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.reimaginehome.ai/v1/get-space-type-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jun 2023 06:32:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"cbe969bf-a8b8-4b3e-acc8-e7122a242004"},{"key":"x-amzn-Remapped-content-length","value":"22"},{"key":"x-amz-apigw-id","value":"G9ZfFEp7vHcF0-w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64953c60-027da3a0796d7e662deea74a;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": {\n        \"interior_spaces\": [{\"ST-INT-001\":\"Bar\"}, {\"ST-INT-002\":\"Bathroom / Ensuite\"},...],\n        \"exterior_spaces\": [{\"ST-EXT-001\":\"Backyard\"}, {\"ST-EXT-002\":\"Garden\"},...]\n    }\n}"}],"_postman_id":"bcee3b8a-ff6d-4ea1-a5dd-668d9686ef28"},{"name":"Get Design Theme List","id":"d129a953-cfdd-474b-9607-f34184da6429","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"/v1/get-design-theme-list","description":"<p>Use this API to retrieve the latest lists of interior and exterior design themes to be used as <em>design_theme</em> for <strong>Generate Image</strong> API. This list contains the currently allowed values of design themes and it has been specifically curated to generate optimal outputs.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>CATEGORY</strong></th>\n<th><strong>CODE</strong></th>\n<th><strong>DESIGN THEME</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>INTERIOR</td>\n<td>DT-INT-001</td>\n<td>Bohemian</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-002</td>\n<td>Coastal</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-003</td>\n<td>Contemporary</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-004</td>\n<td>Farmhouse</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-005</td>\n<td>French Country</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-006</td>\n<td>Glam</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-007</td>\n<td>Industrial</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-008</td>\n<td>Japandi</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-009</td>\n<td>Mid-Century Modern</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-010</td>\n<td>Minimal</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-011</td>\n<td>Modern</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-012</td>\n<td>Rustic</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-013</td>\n<td>Scandinavian</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-014</td>\n<td>Traditional</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-INT-015</td>\n<td>Transitional</td>\n</tr>\n<tr>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>EXTERIOR</td>\n<td>DT-EXT-001</td>\n<td>Beautiful Garden</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-002</td>\n<td>Charming Playhouse Garden Landscaping</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-003</td>\n<td>Cottage Garden's Colorful Planting Palette</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-004</td>\n<td>Cozy Corner with Fire Pit and Seating</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-005</td>\n<td>Garden Landscaping with Gravel Landscaping</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-006</td>\n<td>Hip California Garden Landscaping</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-007</td>\n<td>Lush Green Lawn</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-008</td>\n<td>Mediterranean Garden Landscaping</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-009</td>\n<td>Moss Garden</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-010</td>\n<td>Outdoor Dining and Sitting Area</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-011</td>\n<td>Party-Ready Outdoor Space with Pool, Spa, and Fire Feature</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-012</td>\n<td>Resort-Style Landscaping and Pool</td>\n</tr>\n<tr>\n<td></td>\n<td>DT-EXT-013</td>\n<td>Round Swimming Pool with Lawn and Pool House</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["v1","get-design-theme-list"],"query":[],"variable":[]}},"response":[{"id":"454e7534-618e-42ed-8657-403bdf68f223","name":"Get Design Theme List","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.reimaginehome.ai/v1/get-design-theme-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jun 2023 06:32:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"cbe969bf-a8b8-4b3e-acc8-e7122a242004"},{"key":"x-amzn-Remapped-content-length","value":"22"},{"key":"x-amz-apigw-id","value":"G9ZfFEp7vHcF0-w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64953c60-027da3a0796d7e662deea74a;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": {\n        \"interior_themes\": [{\"DT-INT-001\":\"Bohemian\"}, {\"DT-INT-002\":\"Coastal\"},...],\n        \"exterior_themes\": [{\"DT-EXT-001\":\"Beautiful Garden\"}, {\"DT-EXT-002\":\"Charming Playhouse Garden Landscaping\"},...]\n    }\n}"}],"_postman_id":"d129a953-cfdd-474b-9607-f34184da6429"},{"name":"Get Color Preference List","id":"024962f5-9fa3-4f30-b1dc-04b53052142a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"/v1/get-color-preference-list","description":"<p>Use this API to retrieve the latest lists of colors and patterns to be used as <em>color_preference</em> for <strong>Generate Image</strong> API. This list has been specifically curated to generate optimal outputs for interior images.</p>\n","urlObject":{"path":["v1","get-color-preference-list"],"query":[],"variable":[]}},"response":[{"id":"0f34f422-7858-4c4d-bbc1-18bc52b71593","name":"Get Color Preference List","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.reimaginehome.ai/v1/get-color-preference-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Jul 2023 09:07:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"88b8605a-5f4f-4ded-a138-7cc95150ca13"},{"key":"x-amzn-Remapped-content-length","value":"22"},{"key":"x-amz-apigw-id","value":"HiAm3EIZvHcFtGw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64a3e15e-21821a4074634a694b9322f8;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": { \n        \"color\": [\"creamy white, brown, green\",\"hunter green, red, dark gray\",...],\n        \"patterns\": [\"stripes pattern\",\"zigzag pattern\",...]\n    }\n}"}],"_postman_id":"024962f5-9fa3-4f30-b1dc-04b53052142a"},{"name":"Get Landscaping Preference List","id":"85fcd09a-cd1c-4597-9968-6aedcc14a4be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"/v1/get-landscaping-preference-list","description":"<p>Use this API to retrieve the latest lists of pathways and plants to be used as <em>landscaping_preference</em> for <strong>Generate Image</strong> API. This list has been specifically curated to generate optimal outputs for exterior images.</p>\n","urlObject":{"path":["v1","get-landscaping-preference-list"],"query":[],"variable":[]}},"response":[{"id":"7ebf5fff-f72c-4375-bc5a-d6831db0a603","name":"get-landscaping-preference-list","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"url":"https://api.reimaginehome.ai/v1/get-landscaping-preference-list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jun 2023 06:32:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"cbe969bf-a8b8-4b3e-acc8-e7122a242004"},{"key":"x-amzn-Remapped-content-length","value":"22"},{"key":"x-amz-apigw-id","value":"G9ZfFEp7vHcF0-w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64953c60-027da3a0796d7e662deea74a;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": {\n        \"pathways\": [\"herringbone pathway\",\"stone pathway\",...],\n        \"plants\": [\"geranium\",\"daisies\",...]\n    }\n}"},{"id":"a373949b-5d43-432a-afc5-2ae2278ad0f2","name":"get-landscaping-preference-list Copy","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{x-api-key}}","type":"text"}],"url":"/v1/get-landscaping-preference-list"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Jun 2023 06:32:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"22"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"cbe969bf-a8b8-4b3e-acc8-e7122a242004"},{"key":"x-amzn-Remapped-content-length","value":"22"},{"key":"x-amz-apigw-id","value":"G9ZfFEp7vHcF0-w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64953c60-027da3a0796d7e662deea74a;Sampled=0;lineage=9ecb37d3:0"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"data\": {\n        \"landscaping_preferences\": [\"herringbone pathway\",\"stone pathway\",...],\n        \"plant_preferences\": [\"geranium\",\"daisies\",...]\n    }\n}"}],"_postman_id":"85fcd09a-cd1c-4597-9968-6aedcc14a4be"}],"id":"231a061e-ca20-49de-a1f1-cffe24c6ed32","_postman_id":"231a061e-ca20-49de-a1f1-cffe24c6ed32","description":""}],"event":[{"listen":"prerequest","script":{"id":"b537f4d3-4a6e-4d1e-8f76-6135e0bfbe55","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"976982f9-4311-40f0-84d3-8c0fd62b0aed","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BaseURL","value":"https://e35cxmu3u8.execute-api.us-west-2.amazonaws.com/dev/v1"},{"key":"job_id","value":"{{job_id}}"},{"key":"x-api-key","value":"{{x-api-key}}"}]}