{"info":{"_postman_id":"a3f4fa4c-2996-4c72-9343-99500396f656","name":"3D Reconstruction API","description":"

🚀 Get Started

This is just to demonstrate the easy API structure we provide. For API Credentials, API URL and User details please contact us after you Sign-Up for a developer-account over the profile!

This documentation guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests for GlanceAI - 3D Reconstruction API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"🚀 Get Started","slug":"get-started"}],"owner":"22926169","collectionId":"a3f4fa4c-2996-4c72-9343-99500396f656","publishedId":"2sAXjDdEpY","public":true,"customColor":{"top-bar":"fff","right-sidebar":"3C3C3C","highlight":"3C3C3C"},"publishDate":"2024-10-14T11:09:37.000Z"},"item":[{"name":"Scans","item":[{"name":"List","id":"47f581fd-9a02-4f3b-a776-4f47828b3c3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/scans","description":"

List all scans of the user

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","name":"Scans","type":"folder"}},"urlObject":{"path":["scans"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47f581fd-9a02-4f3b-a776-4f47828b3c3b"},{"name":"Create","id":"a922b38b-6d48-455b-96d8-adcb9eefe3dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"API Test","type":"text"},{"key":"number_of_images","value":"14","type":"text"},{"key":"image_extension","value":"jpg","type":"text"}]},"url":"{{base_url}}/scans","description":"

Create new scan with below mandatory form data:

\"name\"
\n
- Name of your scan to view in the dashboard or scans list
\n
\"number_of_images\"
\n
- Exact number of images you have to get a Presigned Upload URLs json array for each image that you can automate with a software to upload each image
\n
\"image_extension\"
\n
- The extension of your images so that the Bucket will generate a correct extension. (All images need to have same extension)
\n

Returns a JSON Response with a key named \"image_upload_urls\". URL inside this key points to a JSON file which consists presigned image upload urls for the count of number_of_images variable you sent.

Then you should upload your image files to those presigned upload urls with a \"PUT\" request.

For further steps look into \"Update\" method.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","name":"Scans","type":"folder"}},"urlObject":{"path":["scans"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a922b38b-6d48-455b-96d8-adcb9eefe3dd"},{"name":"Reupload","id":"bc09c125-fec0-438c-b4fe-e6165fa62c4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"API Test","type":"text"},{"key":"number_of_images","value":"14","type":"text"},{"key":"image_extension","value":"jpg","type":"text"}]},"url":"{{base_url}}/reupload/19","description":"

Append \"scan_id\" at the end of the link as in example for \"19\"

If for some reason your image uploading is interrupted and/or your presigned upload urls you got from \"Create\" method are expired, you can request new presigned upload urls for your images.
This method returns the same as \"Create\" method;

JSON Response with a key named \"image_upload_urls\". URL inside this key points to a JSON file which consists presigned image upload urls for the count of number_of_images variable you sent.

Then you should upload your image files to those presigned upload urls with a \"PUT\" request.

For further steps look into \"Update\" method.

NOTE: You cannot \"Reupload\" a scans images if the scan status is already updated via \"Update\" method. This ensures that \"Reupload\" function can only be used in case of a image uploading failure before the actual processing starts.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","name":"Scans","type":"folder"}},"urlObject":{"path":["reupload","19"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc09c125-fec0-438c-b4fe-e6165fa62c4f"},{"name":"Update","id":"b7678ace-7843-48c7-b622-2938989d1fb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"scan_status","value":"uploaded","type":"text"},{"key":"message","value":"Scan Images Uploaded Successfully","type":"text"}]},"url":"{{base_url}}/scans/19","description":"

Create new scan with below mandatory form data:

\"scan_status\"
\n
- You can send \"uploaded\" if you have completed to upload every image to the presigned upload urls. This will trigger the queueing and processing of your scan in the backend.
\n
\"message\"
\n
- You can send additional debug messages.
\n

After this step you can monitor your scans status with \"Show\" method.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af","name":"Scans","type":"folder"}},"urlObject":{"path":["scans","19"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7678ace-7843-48c7-b622-2938989d1fb8"},{"name":"Show","id":"b8b2c761-6fe2-4daf-bf57-57ccc279d9b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/scans/19","description":"

You can track the status of your scan with \"Show\" method. This endpoint will return a JSON response regarding the information of the scan.

The \"status\" of the scan is inside the returned scan object.

These are 3D Scan focused CRUD operations to generate 3D Models from images, access all of the scans, view the scan and many more.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"2942e840-5def-4413-9f49-3e4cbc90e6f1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"2b0c78aa-5627-44e0-b504-ff9dc3d29b92","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"4ca0fed6-e15a-4ca5-bc5b-50045eda95af"},{"name":"Users","item":[{"name":"Show","id":"582bb2e6-cd21-4ad8-8116-ff026078b9db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/user","description":"

Get User information like remaining credits, and some other fundamental information.

For your app you can use the credits of the user to check if the user still has valid credits on their account

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":true,"source":{"_postman_id":"88cb4ba6-1a5a-4269-a74c-95fafe127694","id":"88cb4ba6-1a5a-4269-a74c-95fafe127694","name":"Users","type":"folder"}},"urlObject":{"path":["user"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"582bb2e6-cd21-4ad8-8116-ff026078b9db"},{"name":"Login","id":"06c3954f-8d66-4e7e-bb4c-8a05f8bb80be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"test@gmail.com","type":"text"},{"key":"password","value":"USER_PASSWORD","type":"text"}]},"url":"{{base_url}}/login","description":"

This endpoints sole purpose is to get the Authorization Bearer Token for the user.

Please note the API Token in a safe place as you can't get thesame token again. Token Validation will expire in 3 days.

\n","urlObject":{"path":["login"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"06c3954f-8d66-4e7e-bb4c-8a05f8bb80be"}],"id":"88cb4ba6-1a5a-4269-a74c-95fafe127694","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4579528c-97aa-454d-9cd3-f9d43bc04777","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"9102d76f-09de-4335-b8cc-ecc5043d004a","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"88cb4ba6-1a5a-4269-a74c-95fafe127694","description":""}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{api_token}}}"}]}},"event":[{"listen":"prerequest","script":{"id":"3897a5eb-768a-41a1-bb86-c99ff1a4d0a1","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"f1fa3d80-0bfd-4dd0-8bcf-abf4d8979fb6","type":"text/javascript","packages":{},"exec":[""]}}]}