{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b3cde338-cc96-4265-be7e-a3ef8990edb9","name":"REimagineHome API Documentation v1.0","description":"---\n\nThe 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.\n\nAuthentication 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.\n\n**Note:** 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.\n\n<img src=\"https://content.pstmn.io/1d519c45-f2d0-4aa8-9775-32a29f6bdd84/U2NyZWVuc2hvdCAyMDIzLTA3LTA0IDE3MDAwNS5wbmc=\">\n\n# Service endpoint\n\n---\n\nA 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:\n\n- [<b>https://api.reimaginehome.ai</b>](null)\n    \n\n# Versioning\n\n---\n\nAs 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.\n\n# Authentication\n\n---\n\nThe 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.\n\nTo 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.\n\nAPI 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.\n\n# Rate Limit\n\n---\n\nAll REimagineHome APIs have a rate limit of 10 requests per second. Exceeding this rate limit will result in 429 (Too Many Requests) HTTP errors.\n\n# Examples\n\n---\n\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# Status Codes and Errors\n\n---\n\nREImagineHome APIs uses common HTTP response status codes to indicate the success or failure of these API requests.\n\nFollowing is the list of HTTP status codes:\n\n| Status Code | Summary | Meaning |\n| --- | --- | --- |\n| 200 | Success | Your request was successful. |\n| 400 | Bad request | Your request was not successful due to missing or invalid parameters. |\n| 401 | Invalid Authentication Token | Your API Key is invalid, expired, or not provided. |\n| 402 | Payment Required | Your account balance has been exhausted. |\n| 403 | Forbidden | Your request parameters were valid, but your account does not have adequate permission for the requests. |\n| 404 | Not Found | The requested resource does not exist. |\n| 405 | Method Not Allowed | The requested HTTP is not allowed for the given resource. |\n| 422 | Unprocessable Entity | Your request could not be processed properly due to invalid data. Some of the required parameters might be missing. |\n| 429 | Too Many Requests | Too many requests within a given amount of time, exceeding the allowed Rate Limit. Refer to the **Rate Limit** section of this document to know about the limits. |\n| 500 | Internal Server Error | The request was not successful due to server errors. |\n| 504 | Gateway Timeout | The gateway or server did not get a response in time from the underlying resources needed to complete the request. |\n\n<img src=\"https://content.pstmn.io/2fe4473c-e3e2-46d0-9df6-ba09638fc5f5/RXh0ZXJpb3IgKDIpLmdpZg==\" alt=\"\">","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19598161","collectionId":"b3cde338-cc96-4265-be7e-a3ef8990edb9","publishedId":"2s93z59QQX","public":true,"publicUrl":"https://docs.reimaginehome.ai","privateUrl":"https://go.postman.co/documentation/19598161-b3cde338-cc96-4265-be7e-a3ef8990edb9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0F0F31"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/d919f8bc-45de-4a95-a902-ed43a6dd46d4/U2NyZWVuc2hvdCAyMDIzLTA3LTE5IGF0IDUuMDUuMTIgUE0ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/13a0e781-b1c8-44a4-b3fe-38491c204bdc/VGV4dC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0F0F31"}}]}},"version":"8.10.1","publishDate":"2023-08-30T04:34:04.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/13a0e781-b1c8-44a4-b3fe-38491c204bdc/VGV4dC5wbmc=","logoDark":"https://content.pstmn.io/d919f8bc-45de-4a95-a902-ed43a6dd46d4/U2NyZWVuc2hvdCAyMDIzLTA3LTE5IGF0IDUuMDUuMTIgUE0ucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://reimaginehome.ai/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.reimaginehome.ai/view/metadata/2s93z59QQX"}