{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"97b73bd3-209e-487a-8ee3-9921eb28c255","name":"MonkAPI - Demo","description":"`Documentation V0.1 - 24/06/2022`\n\n> Next releases: More queries and parameter explanations will come very soon, in the meantime you can always refer to the old, very complete documentation provided just below. \n  \n\nHow to use this collection and query your first token:\n\n<img src=\"https://drive.google.com/uc?id=1oW80MLW6THx_1lkSzN3nFTyv0irsX0Wu\">\n\nThe full documentation is available [here](), the purpose of this postman collection is to provide a sandbox that allows you to quickly test the API and its functionality.\n\n**If you have any questions, please contact our Delivery Team at** [<b>alexandre.p@monkvision.ai</b>]()**.**\n\n<img src=\"https://drive.google.com/uc?id=1ZhbjrfkWCK4bo5UGWp1Maewp5Z8fM90F\">\n\nYou have various ressources at your disposition to start using our API:\n\n- [<b>Authentification documentation</b>]()**:** how to get a bearer token to use the core API\n- [<b>Swagger</b>]()**:** which parameters are available, quickly test the API with a bearer token\n- **Examples and step by step request:** best way to quick start the integration by using realistic examples\n    \n\nI highly recommend to start **with small use cases** and then **customize the settings with the integration team to perfectly fit your use case.**\n\nAll tests should be performed on the **preview** environnement.\n\n# Folder organisation\n\n#### 1\\. Workflows\n\nRequests to understand the different image upload and job creation workflows.\n\n#### 2\\. Tasks\n\nWhich tasks are available today, the main ones are documented in this library. For each sub-folder you will find details of the main parameters of each task.\n\n#### 3\\. Showcase\n\nOne request with all tasks and main parameters to start testing the API.\n\n#### 4\\. Utils requests\n\nAdditional requests to retrieve inspections or to interact with the API.\n\n# GET inspections\n\nAt the end of each POST the **inspection_id is saved as a variable**. You can use the requests at the root of the collections 'GET Env Inspection Id' to GET the inspection you have just posted.\n\nYou have various ways to get and visualize inspections. As detailed below, you have different workflows to POST inspections and images. To look at the results, it's a bit simpler, there are two solutions: either do a GET on the resource, or add a callback to a task so that the inspection (the whole resource) is posted on an endpoint on a client server. The callback is at the task level so the whole inspection resource is posted, so if you have several tasks requested at the same time, we recommend using a single callback on the longest task (the damage detection).\n\nIt will be of great help to read the documentation on the data schema to study how parts, damages and other elements are linked together in our data schema.\n\n# Visualize results and inspections\n\nConcerning the damage visualisation you have the **polygons of the parts and damage returned by the API**. You can use them directly to build a custom front view from the API.\n\nAlternatively you can use the **rendered outputs** which are images obtained from the API to visualise the damage and car parts on an image. You can also **use zoomed photos** of the damage and parts that can be generated in the output. There is a detailed documentation for this, and the parameters required to generate these images are detailed below (Tasks -> Damage Detection).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"15494157","collectionId":"97b73bd3-209e-487a-8ee3-9921eb28c255","publishedId":"VUxLv8Rn","public":true,"publicUrl":"https://documentation.preview.monk.ai","privateUrl":"https://go.postman.co/documentation/15494157-97b73bd3-209e-487a-8ee3-9921eb28c255","customColor":{"top-bar":"FFFFFF","right-sidebar":"0E457C","highlight":"0E457c"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-08-29T11:39:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"documentation","id":"0a63587b-5f58-47c6-bbd2-80fdeea97a55","owner":"15494157","values":[{"key":"base_url","value":"https://api.preview.monk.ai/v1","enabled":true},{"key":"auth_domain","value":"https://idp.preview.monk.ai","enabled":true},{"key":"client_id","value":"mnkah1unkyThFTph4ogrEqLN2XRL9XxV","enabled":true},{"key":"env_name","value":"preview","enabled":true},{"key":"inspection_id","value":"","enabled":true},{"key":"preview_inspection_id","value":"","enabled":true,"type":"any"},{"key":"audience","value":"https://api.monk.ai/v1/","enabled":true},{"key":"clientsecret","value":"","enabled":true},{"key":"OAuth_Token","value":"","enabled":true},{"key":"OAuth_Timestamp","value":"","enabled":true},{"key":"ExpiresInTime","value":"","enabled":true},{"key":"status_names","value":"","enabled":true},{"key":"task_names","value":"","enabled":true},{"key":"parts_names","value":"","enabled":true},{"key":"image_id","value":"","enabled":true,"type":"any"},{"key":"auth_base_url","value":"","enabled":true},{"key":"auth_web_client_id","value":"","enabled":true,"type":"default"},{"key":"monk_org_id","value":"","enabled":true,"type":"any"},{"key":"acme_org_id","value":"","enabled":true,"type":"any"},{"key":"orga_b_id","value":"","enabled":true,"type":"any"},{"key":"user_a_id","value":"","enabled":true,"type":"any"},{"key":"organization_id","value":"","enabled":true,"type":"any"},{"key":"user_id","value":"","enabled":true,"type":"any"},{"key":"severity_id","value":"","enabled":true,"type":"any"},{"key":"created_severity_id","value":"","enabled":true,"type":"any"},{"key":"documentation_inspection_id","value":"","enabled":true,"type":"any"}],"published":true}],"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://monk.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"},{"label":"documentation","value":"15494157-0a63587b-5f58-47c6-bbd2-80fdeea97a55"}],"canonicalUrl":"https://documentation.preview.monk.ai/view/metadata/VUxLv8Rn"}