Authentication, input and response

Fetch the condition score

Post url to retrieve the condition score of bathrooms & kitchens.

POST https://api.altum.ai/condition-score/url

Headers

Name	Type	Description
x-api-key*	string	Unique API Key from Altum. Create one on https://platform.altum.ai
Content-Type	string	application/json

Request Body

Name	Type	Description
url*	string	The public URL of the image you wish to send int he request

200: OK Successful response

{
	"Output": {
		"label": "bathroom",
		"confidence": "98.17",
		"condition_score": "4.09"
	}
}

400: Bad Request Unsuccessful response

{
  "detail": "The URL is not valid"
}

422: Unprocessable Entity Wrong input format

{
	"detail": [
		{
			"loc": [
				"body",
				"image"
			],
			"msg": "field required",
			"type": "value_error.missing"
		}
	]
}

401: Unauthorized No access

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

500: Internal Server Error Service is not available and/or down

{
	"message": "Internal server error"
}

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

Upload image file to retrieve the condition score of bathrooms & kitchens.

POST https://api.altum.ai/condition-score/img

Headers

Name	Type	Description
x-api-key*	string	API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Content-Type	string	multipath/form-data

Request Body

Name	Type	Description
image*	object	The image to be sent in the request must be uploaded as a multipath/form-data type.

200: OK Successful response

{
	"Output": {
		"label": "bathroom",
		"confidence": "98.17",
		"condition_score": "4.09"
	}
}

400: Bad Request Unsuccessful response

{
  "detail": "Please upload an image with one of the following formats: .jpg, .jpeg or .png"
}

422: Unprocessable Entity Wrong input format

{
	"detail": [
		{
			"loc": [
				"body",
				"image"
			],
			"msg": "field required",
			"type": "value_error.missing"
		}
	]
}

401: Unauthorized No access

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

500: Internal Server Error Service is not available and/or down

{
	"message": "Internal server error"
}

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

FREE Ping for availability

Post url to confirm if the image contains a kitchen or a bathroom.

POST https://api.altum.ai/condition-score/url/ping

This endpoint enables you to verify whether an image features a bathroom or kitchen before requesting their condition scores. This preliminary check is necessary given that the Condition Score API cannot generate scores if the image does not depict a kitchen or a bathroom.

Headers

Name	Type	Description
x-api-key*	string	API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Content-Type	string	application/json

Request Body

Name	Type	Description
url*	string	The public URL of the image you wish to send int he request

200: OK Successful response

{
    "Output": {
    "label": "Bathroom or Kitchen image detected",
    "confidence": "98.17"
    }        
}

400: Bad Request Unsuccessful response

{
  "detail": "The URL is not valid"
}

422: Unprocessable Entity Wrong input format

{
	"detail": [
		{
			"loc": [
				"body",
				"image"
			],
			"msg": "field required",
			"type": "value_error.missing"
		}
	]
}

401: Unauthorized No access

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

500: Internal Server Error Service is not available and/or down

{
	"message": "Internal server error"
}

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

Upload image file to confirm if the image contains a kitchen or a bathroom.

POST https://api.altum.ai/condition-score/img/ping

This endpoint enables you to verify whether an image features a bathroom or kitchen before requesting their condition scores. This preliminary check is necessary given that the Condition Score API cannot generate scores if the image does not depict a kitchen or a bathroom.

Headers

Name	Type	Description
x-api-key*	string	API Key from Altum. Create one via Mopsus(https://mopsus.altum.ai)
Content-Type	string	multipath/form-data

Request Body

Name	Type	Description
image*	object	The image to be sent in the request must be uploaded as a multipath/form-data type.

200: OK Successful response

{
    "Output": {
    "label": "Bathroom or Kitchen image detected",
    "confidence": "98.17"
    }        
}

400: Bad Request Unsuccessful response

{
  "detail": "Please upload an image with one of the following formats: .jpg, .jpeg or .png"
}

422: Unprocessable Entity Wrong input format

{
	"detail": [
		{
			"loc": [
				"body",
				"image"
			],
			"msg": "field required",
			"type": "value_error.missing"
		}
	]
}

401: Unauthorized No access

{
    'Output': 'Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request.'
}

500: Internal Server Error Service is not available and/or down

{
	"message": "Internal server error"
}

403: Forbidden Forbidden

{
	"message": "Missing Authentication Token"
}

Request body

Example request

{"url":"https://www.rawsonhomes.com.au/-/media/rawson-homes/blogs-external-banner-images/blog-articles/2020-blogs/september-2020/facades/narraweena-nara-facade.ashx"}